roboto devices
Manage the robots and other devices which have Roboto access within your org.
roboto devices [-h]
{delete,disable,enable,generate-creds,list,register,show} ...
Arguments
| Argument | Description |
|---|---|
-h, --help |
show this help message and exit |
roboto devices delete
Deletes a device
roboto devices delete [-h] [--org ORG] [--keep-files] device_id
Arguments
| Argument | Description |
|---|---|
device_id Required |
The device ID of the target device. |
-h, --help |
show this help message and exit |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |
--keep-files |
Move the device’s files to the org root under devices/<universal_device_id>/ instead of deleting them. Links among the device’s files are deleted either way. |
roboto devices disable
Disables a device’s access tokens without deleting them. This is useful if a device is acting odd, and you want to temporarily cut it off from uploading datasets, but you don’t want to have to re-provision its Roboto access.
roboto devices disable [-h] [--org ORG] device_id
Arguments
| Argument | Description |
|---|---|
device_id Required |
The device ID of the target device. |
-h, --help |
show this help message and exit |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |
roboto devices enable
Re-enables all of a device’s access tokens. They start enabled, so this is only needed if they’ve been explicitly disabled.
roboto devices enable [-h] [--org ORG] device_id
Arguments
| Argument | Description |
|---|---|
device_id Required |
The device ID of the target device. |
-h, --help |
show this help message and exit |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |
roboto devices generate-creds
Generates a new access credentials file for an existing device.
roboto devices generate-creds [-h] [--org ORG] [-f OUTPUT_CONFIG_FILE]
device_id
Arguments
| Argument | Description |
|---|---|
device_id Required |
The device ID of the target device. |
-h, --help |
show this help message and exit |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |
-f, --config-file <output_config_file> |
Where on local disk to save the config file containing the device’s generated Roboto credentials. Defaults to ‘config.json’ in the current directory. Default: config.json. |
roboto devices list
Lists devices which have been registered for a given org.
roboto devices list [-h] [--org ORG]
Arguments
| Argument | Description |
|---|---|
-h, --help |
show this help message and exit |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |
roboto devices register
Registers a device with Roboto.
roboto devices register [-h] [-f OUTPUT_CONFIG_FILE] [--org ORG]
device_id
Arguments
| Argument | Description |
|---|---|
device_id Required |
The device ID of the target device. |
-h, --help |
show this help message and exit |
-f, --config-file <output_config_file> |
Where on local disk to save the config file containing the newly registered device’s Roboto credentials. Defaults to ‘config.json’ in the current directory. Default: config.json. |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |
roboto devices show
Gets info about an individual device.
roboto devices show [-h] [--org ORG] device_id
Arguments
| Argument | Description |
|---|---|
device_id Required |
The device ID of the target device. |
-h, --help |
show this help message and exit |
--org <org> |
The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value; without it, the default is the org_id of the config file profile in use, which roboto setup saves. |