Supported Commands
Overview
Define what commands this type of devices can accept.
- Name - Name of command sent to the device.
- Friendly Name - Name displayed to End Customers.
- Description - Detailed command description.
- Requires File - Specify if a file will be passed with the command.
- File Type - Optional field used to tie file types to commands.
- Active - Command is visible and accessible to End Customers.
Adding a Command
To add a command, click the "Add Command" button on the top right.
Basic configuration
- Friendly Name - Name displayed to End Customers.
- Description - Detailed command description.
- Name sent to device - The string the device will receive to identify the command.
- Requires file - Defines if the command requires a file, either to be selected from a list of files uploaded by the OEM or uploaded by the End Customer.
- Allow sending multiple.. - Defines if multiple similar commands can be queued. E.g. "Increase volume by 10%" can be queued multiple times, while "Set volume to 30" should only be queued once.
- Open tunnel - Used for the "Tunneling Feature"
- Active - Command available for End Customers. Non active commands can be only called from Lab End Customers.
- Show command in panel - When enabled, the command will be visible to End Customers in the "Commands" block. When disabled, the command will only be accessible if its integrated into a "Command Widget".
- Show a confirmation popup.. - Ask user for extra confirmation for dangerous commands. E.g. "Reset device".
Custom Fields
Each command can have multiple custom fields, allowing End Customers to provide additional parameters to the device. All the keys will be collected by the End Customer portal and passed to the devices as a JSON.
Custom fields can be added by clicking "Add custom field" button.
- Required - Specifies if the field is optional.
- Field key - The name of the key in the JSON sent to the device.
- Label - User friendly description of the field.
- Field Type
- Static list (single-select) - Provide a list of options for the user to select (only one).
- Static list (multi-select) - Provide a list of options for the user to select (can select multiple).
- Dynamic list (single-select) - Provide Dynamic list for the user to select (only one).
- Dynamic list (single-select) - Provide Dynamic list for the user to select (can select multiple).
- String - String parameter.
- Number - Numeric parameter with optional range.
- Date - Date parameter.
- Boolean - Boolean paramter.
- JSON - Freeform JSON.
Updated 3 days ago
What’s Next