Supported Commands

Overview

As a partner, you can define custom commands that can be administered remotely for your devices.

On the Models page in the Configuration section of the portal, select the model you would like to configure. On the Supported Commands tab, you can add custom commands you would like that device model to support by clicking the “Add” button in the top-right corner.

Main view

The main view shows a list of all defined commands, their status and general parameters.

Adding commands

A new command can be added via the "Add Command" button located on the top right.

Basic Fields

The following fields should be set for each command:

Name

Description

Active

Enabled status make this command available for use (disabled commands can still be tested in Lab Organization accounts.

Friendly name

The string displayed to the End-Users.

Description

A short description of the command displayed to the End-Users.

Name set to device

The string sent to the device as part of the GET COMMAND API

Requires file

When marked, this command will require a Partner provided or End User uploaded file. The file "family" must be specified to mark what kind of files the command expects.

Timeout

The maximum time for this command to execute and update the server on the status. After this period, the server will assume the command has failed.

During this time the device may stop responding at all (e.g. firmware upgrade process) and the system will not mark the device as "offline".

📘

Ensure the “Active and visible to users” box is checked if you want the command to be live and actionable from the end users portal.

Custom Fields

Additionally a list of "Custom Fields" can be sent to the device, as many fields as required can be added via the "Add custom field" button.

NameDescription
RequiredWill the End-User will be required to fill the key to send the command. If not a NULL value might be passed.
Field keyThe string the device will receive as the key for this field.
LabelWhat label will be displayed to the End-User
Field typeMultiple field types are currently supported, such as: Number ranger, strings, JSON, multi and single select lists, etc.