Setting Up Device Properties

There are instances where you will want to add custom key/value properties to devices that don’t fit within the standard HWI device object. These types of data points can be saved on an individual device basis using Device Properties.

Adding Device Properties

For all devices, you may add user-defined key-value properties to individual devices using the following endpoint:

/hwi/hwi-devices/{hwi_device_id}/properties/

Special/Pre-Defined Device Properties

Some devices have special, Tenovi-defined properties that you can use to control certain device parameters. For example, the Step Goal value displayed on the Tenovi Watch can be modified by setting the value of the step_goal property. The full list of these Tenovi-defined properties can be found on our Device Overview page.

Another example, is the bluetooth_passkey property that is reserved for glucometer pairing. You can learn more about this device property in our Bring Your Own Device Guide.

Note

For these special, Tenovi-defined properties, the synced field (returned on GET requests to the above update) can be used to identify when the property value has been synchronized onto the physical device.

Finding Devices Using Device Properties

You can search for device properties using the GET HWI devices endpoint. This endpoint accepts query parameters that enable you to seach by key or values.

• properties__key - searches for devices with a specific key of a device property
• properties__value - searches for devices with a specific value of device property

These query parameters can be used in conjunction with one another to narrow down your device search results, and is covered in more detail in our API Reference.