Overview

Commands let users invoke remote operations on a Device.

The Commands a Device can accept are defined per Device Model on the Supported Commands tab of the Model details page in the Partner Portal (Configuration → Models → select model). Each Command can declare optional dynamic parameters or require a file (filtered by filetype).

Commands are queued in order on the server and delivered to the Device one at a time — the Device never receives multiple Commands at once.

Workflow

On every Send Telemetry API call, the Device inspects the command field in the response:
- false — nothing to do.
- true — proceed to the next step.
Call Get Command API to fetch the Command and its parameters.
Save the Command ID returned by Get Command — it's required for status updates.
(Optional, for long-running Commands.) Call Update Command API with status in_progress to let the user know the Command was received and is being processed.
When execution finishes, report the final status via Update Command API.

Flow diagram