Property | Type | Description | Mandatory |
|---|---|---|---|
commands | Array | Defines an array of one or more commands that the IoT Platform REST API can use for each Device of this Product type. These commands enable you to trigger actions on the device using the sendCommand endpoint. The IoT Platform Device SDK should be activated on the device and set up accordingly to listen to this command. Alternatively, IoT Platform can set up its command gateway that can send commands to Devices that are not using the IoT Platform Device SDK. After a command is created, IoT Platform returns a unique identifier (command ID) to be used with the IoT Platform REST API Command entity in order to send commands to a device. | |
commands/name | String | The free-text name of the command. | To use the command in the UI |
commands/payload | String | The name of the method that is executed on the Device. For example, sending a payload of Reset runs the Reset command on the Device and gracefully resets the Device. | Y |
commands/commandResponseType | String/Enum | The device structure returned by the command payload (described above). The values of this property are – • Undefined • String • Json | |
commands/commandKind | String/Enum | Enables you to define if the command is a predefined direct method, as follows – • Undefined • IoTHubMethod | |
commandsProtocol | String/Enum | The command protocol, as follows – • Undefined • HTTP • AMQP • Modbus • SNMP • OPCUA | |
commandsUrl | String | For internal use. This is the address of the command’s gateway. | |
commandsAddress | String | For Internal use. The remote address to where to send commands for this device type. This address is the internal address of the command’s gateway. |