Devices#

Overview#

A device in Roboto represents a robot, upload station, or other non-human entity which can programmatically interact with Roboto.

In order to upload data from devices to Roboto, they must use an operating system capable of running the Roboto CLI or Roboto Agent.

Registration#

To register a device, you must have the Roboto CLI installed, and must have configured it with a personal access token.

Once installed and configured, you can run the following:

roboto devices register <device-id>

For device-id, use a meaningful unique identifier for the device, such as its serial number.

This command will provision a device access token for the specified device, and save the generated credentials to a file named config.json in the current directory. The output location of this file can be controlled with the --config-file optional parameter.

If you were in an org with ID og_123456789012 and called roboto devices register mk2_sn0014, the config.json would look like this:

{
  "version":"v1",
  "profiles": {
    "og_12345689012_mk2_sn0014": {
      "api_key":"roboto_pat_XXXXXXXXXXXXXXXXXXXXXXXX",
      "endpoint":"https://api.roboto.ai"
    }
  },
  "default_profile":"og_12345689012_mk2_sn0014"
}

After running this command, you should copy the config.json file to the device’s operating system. By default, Roboto tools will look for this file in $HOME/.roboto/config.json, but you can put it anywhere in the filesystem, and set the ROBOTO_CONFIG_FILE environment variable to point to its location.

Once registered, a device can use the CLI, SDK or Agent to interact with Roboto.

Sub Pages#