Commands

Request Command Execution

Sends command to execute.

Pub-Topic: commands/v1/{ucm-id}/requests

Input:

{
  "id": "ab3e364c-cab2-4cc1-872d-4d554530d587",
  "name": "impulse",
  "arguments": {
    "id": 1,
    "impulse": 300
  }
}

idrequired

Command execution ID, e.g. UUID. Used to bind response with request.

namerequired

Command name. Depends on devicy type.

arguments

Command arguments. Depends on devicy type.

Command Execution Responses

Receives command execution results.

Sub-Topic: commands/v1/{ucm-id}/responses

Output:

{
  "id": "ab3e364c-cab2-4cc1-872d-4d554530d587",
  "state": "completed",
  "payload": {
    "message": null
  }
}

idrequired

Command execution ID, e.g. UUID. Used to bind response with request.

staterequired

Command execution state. Can be different. But main state is completed, which means command execution successfully finished. Another possible states can be found on the Handbook

payload

Optional response payload. Depends on devicy type.