broker: command/update

Notifies the user about a command has been processed by a device. These messages are sent only for commands created by the current user within the current connection.

Subscription Topic and Payload

Topic

dh/command_update/{network-id}/{devicetype-id}/{device-id}/{command-name}

Where:

  • network-id - DeviceHive Network ID
  • devicetype-id - DeviceHive DeviceType ID
  • device-id - DeviceHive Device ID
  • command-name - Command name

Payload Representation

{
    "action": {string},
    "command": {
        "id": {integer},
        "timestamp": {datetime},
        "userId": {integer},
        "command": {string},
        "parameters": {object},
        "lifetime": {integer},
        "status": {string},
        "result": {object}
    }
}

Payload Parameters

Property NameTypeDescription
actionstringAction name: command/update
commandobjectA DeviceCommand resource representing the processed command.
command.idintegerCommand identifier.
command.timestampdatetimeCommand timestamp (UTC).
command.userIdintegerAssociated user identifier.
command.commandstringCommand name.
command.parametersobjectCommand parameters, a JSON object with an arbitrary structure.
command.lifetimeintegerCommand lifetime, a number of seconds until this command expires.
command.statusstringCommand status, as reported by device or related infrastructure.
command.resultobjectCommand execution result, an optional value that could be provided by device.