Add Device to Registry

It introduces how to add new devices to the Ruff registry, taking the LED module as an example.


  • You have to own an account of the Ruff registry, if not, you can apply for the accout here.
  • Read your datasheet to confirm hardware interface and models, hardware interface, and other essential information.
  • Visit here to know how to write driver.

Creating a new device

  • Login into Ruff regisitry using your Ruff accounts.
  • Enter My devices in the My Center, and click the New Device button.

  • Fill in essential information of the device on the New Device page.

    • Name: a name easily understood, e.g. LED module.
    • Model: the unique identification in Ruff system.
      • Please determine the device model through reading datasheet.
      • You can name your device in the form of if you can not obtain the model name of your device, e.g. ruff-led-01.
    • Description: a description of the device.


model is the unique id of the device, which will be used in many places:

  • Driver developers can associate drivers with devices by adding models in driver.json
  • Application developers enter the model after rap device add to add devices in the application.
  • Fill in keywords for the device so that others can search and use it.

  • Click the Create button to complete.

Uploading Layout

You would better upload one picture of the device and mark hardware interface on it in order that the rap layout --visual command can work well.

  • Take a picture for your device, then drag or upload it to editor.

  • Drag the interface of input or output to the device picture.

    • read datasheet carefully and determine the inteface type, function and position.

    • Click the Save button to save.

Uploading Other Essential Data

You can upload more data, so other developers can use your device conveniently.

The following information can be provided:

  • Certificate
  • Data sheet
  • Schematic diagram
  • PCB
  • Encapsulation information
  • SDK

  • This step can be skiped by clicking the Skip button.

Filling in Detailed Information

More detailed information of the device can be filled in for others to refer.

  • The following information can be provided:

    • Basic information
    • Power supply information
    • Tri-proof information
    • Contact information
  • Interface type and power supply are required.

  • More detailed information you provided, more reasonably developers select modules.

Binding the driver

Driver is a important part for writing a application. Generally, we upload the new device, then edit models in driver.json to indicate the driver is written for the device.

In some cases, devices can associate the existing drivers. You have to enter the driver-binding page in this case, then:

  • Search keywords in the search box.
  • Select drivers to be bound in the serach results.

  • Choose the driver version in the ComboBox, and the default is the latest version.

  • The binding can be removed by clicking the Remove Binding button.

  • Click the Create button to complete.

Extension Step: Editing Device Information

The published device information can be edit by yourself.

  • Choose the device whose information you want to edit.

  • Choose the part of information which will be edited

  • The steps are the same as the process of creating device.
  • After saving the changes, the device information in the registry will be updated at the same time.

Next Step

After publish your device, you may need to write driver for your device. Please visit Driver Getting Started to know more about driver development.