Reference Table
Message Types
| Message Type | Description |
| Device Identity Message | |
| 200 | Hello Message / Identity Message. To pull all metadata of device this message is required. This work with DPS and Connection String base approach |
| 201 | Get device attributes. Device should ask all attribute along with all properties to make validation
before reporting telemetry. |
| 202 | Get device settings / twins. Device should ask all twin to make sure device is doing valid twin
update. |
| 203 | Get rules for Edge device. Edge device should send this message to get rule details to evaluate rule
and send Rule Matched message |
| 204 | Get child devices of Gateway Device. Gateway device should send this message to get its child
device, this makes sure no addition device can start communicating and sending data to platform. Gateway |
| 205 | Get Device OTA updates. In case device missed out OTA or need pending OTA; device can send this
message to receive pending OTAs |
| 210 | Device can get all information in single message like Attribute, Settings, Devices (if Gateway), Rules (If Edge) OTA by sending this message type. There will be single response having all details |
| Gateway Operation Message | |
| 221 | Create child device. Note: Device type must be gateway |
| 222 | Deleting child device. Note: Device type must be gateway |
Error Codes
Hello Message & REST API
| Error Code | Description |
| 0 | OK – No Error. |
| 1 | Device not found. Device is not whitelisted to platform |
| 2 | Device is not active |
| 3 | Un-Associated. Device has not any template associated with it |
| 4 | Device is not acquired. Device is created but it is in release state |
| 5 | Device is disabled. It’s disabled from broker by Platform Admin |
| 6 | Company not found as SID is not valid |
| 7 | Subscription is expired |
| 8 | Connection Not Allowed |
| 9 | Invalid Bootstrap Certificate |
| 10 | Invalid Operational Certificate |
| 11 | Invalid Env |
| 12 | Invalid Platform |
| 13 | Invalid Language |
| 14 | Invalid Version |
Create Child Device
| Error Code | Description |
| 0 | OK – No Error. Child Device created successfully |
| 1 | Message missing child tag |
| 2 | Message missing child device uniqueid |
| 3 | Message missing child device display name |
| 4 | Gateway device not found |
| 5 | Could not create device, something went wrong |
| 6 | Child device tag is not valid |
| 7 | Child device tag name cannot be same as Gateway device |
| 8 | Child uniqueid is already exists. |
| 9 | Child uniqueid should not exceed 128 characters |
Delete Child Device
| Error Code | Description |
| 0 | OK – No Error. Child Device deleted successfully |
| 1 | Child device not found |
Auth Types
| Auth Type | Description | Availability |
| 2 | CA Signed Certificate | Azure & AWS |
| 3 | Self-Signed Certificate | Azure & AWS |
| 4 | TPM | Azure |
| 5 | Symmetric Key | Azure |
| 7 | CA Individual | Azure & AWS |
Supported Data Types
| Data Type | Availability | Description | Range | |
| Attribute | Setting | |||
| 1 | Yes | Yes | Integer | -2,147,483,648 to 2,147,483,647 |
| 2 | Yes | Yes | Long | -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 |
| 3 | Yes | Yes | Decimal | (+ or -)1.0 x 10e-7 to 7.9 x 10e7 |
| 4 | Yes | Yes | String | – |
| 5 | Yes | Yes | Time | 00:00:00 to 23:59:59 |
| 6 | Yes | Yes | Date | 1970-01-01 to 9999-12-31 |
| 7 | Yes | Yes | DateTime | 1970-01-01T00:00:00.000Z to 9999-12-31T23:59:59.000Z |
| 8 | Yes | Yes | BIT | 0/1 |
| 9 | Yes | Yes | Boolean | true/false/True/False |
| 10 | Yes | Yes | Duration | – |
| 11 | Yes | – | LatLong (Decimal Array) | [Decimal (10,8), Decimal (11,8)] |
| 12 | Yes | – | Object | – |
Other
Tumbling Window Time [Edge Device]
| Description |
| It should be 1 to 999 ending with h/m/s |
| Minimum 60 seconds required |
| For example:
5h (h = hour) 15m (m = minute) 60s (s = seconds) |
Data Validations [Edge Device]
| Description |
| Type validation values and/or validation ranges separated by commas |
| For example:
1, 2, 10 to 20 -100 to -500, -15 Red, Green, Blue |
Acknowledgement
Command Acknowledgement Status
| Status | Description |
| 0 | Executed (Cloud Only) |
| 1 | Failed |
| 2 | Executed Ack |
OTA Acknowledgement Status
| Status | Description |
| 0 | Executed (Cloud Only) |
| 1 | Failed |
| 2 | Downloading |
| 3 | Download Done |
| 4 | Download Failed |
| 5 | Success |