SDK Installation

Download Installation Package

Installation and Configuration

Zip Package

  • Configure the environment variables RUFF_HOME and PATH.
    Note: The methods below will apply only to your current session. Please refer to Environment Variables Configuration for instructions on making the configuration permanent.

    • Linux / OS X

      Open the terminal and execute the following commands one by one, replacing /path/to/ruff-sdk with the path of your extracted SDK:

      export RUFF_HOME=/path/to/ruff-sdk
      export PATH="$PATH:$RUFF_HOME/bin"

    • Windows

      Open cmd and execute the following commands one by one, replacing X:\path\to\ruff-sdk with the path of your extracted SDK:

      set RUFF_HOME=X:\path\to\ruff-sdk
      setx PATH "%PATH%;%RUFF_HOME%\bin"

Installation Package

Please install your package based your selection.

MSI

msi package is Windows executable package. Double click the package, fill your information based on prompt to install.

DMG

dmg package is Mac executable package. Double click the package to install.

Default installation directory:

/Library/Ruff/

RPM

Run the following command to install rpm package:

rpm -ivh ruff-sdk-<version>.rpm

You can also install rpm package from remote URL. Copy the link and then run the following command:

rpm -ivh http://sdk.ruff.io/ruff-sdk-<version>.rpm

Default installation directory:

/usr/share/ruff-sdk/

DEB

Run the following command to install deb package:

dpkg -i ruff-sdk_<version>.deb

Default installation directory:

/usr/share/ruff-sdk-linux

Homebrew

If you are Mac user and Homebrew is installed. Run the following the command:

brew tap ruffjs/ruff
brew install ruff

Default installation directory:

/Library/Ruff/

Verify SDK Installation

Now execute rap --version in the command line. If the version of rap is printed as expected, PATH has been successfully configured.

Note: Ruff SDK contains two executable files: rap and ruff. rap is the development toolkit with features like device pairing, application initialization, and driver and module managing. ruff is the runtime of Ruff. The PC version of ruff targets testing and simulation.