Properties

This page describes the "property request" mechanism, as well as the message format used to interact with it.

All messages on this endpoint are CBOR encoded.

Requests are maps, with one or more of the following keys:

set: A map containing properties to set. Keys in the map correspond to property IDs.

The device responds with a map, which contains the following keys. Which keys are included in the response depends on the request:

get: A map (keyed by property IDs) containing the value of all requested properties. Any properties that were requested, but are not included in this map are not supported.

set: An array containing the property IDs of all properties that were set. Any properties that were requested to be set, but are not supported (or read-only) will not be included.

Below are all currently supported properties, including their IDs and value types:

ID	Name	R/W	Type	Description
`0x01`	HwSerial	R	string	Serial number of the hardware
`0x02`	HwVersion	R	string	Version information (such as revision) for the device
`0x03`	HwInventory	R	array	Information about all peripherals connected to the load. The array contains maps, which will have the following keys: type: Peripheral type; may be one of ["load", "hmi" or "io"] sn: Serial number (string; optional) driver: Driver id (blob; optional)
`0x04`	SwVersion	R	string	Current software version (including build number)