Version: stel-v2.0

<aside> 💡 Please refer to our Endpoint Upgrade Guide on how to upgrade your endpoint from the v1 schema to v2.

</aside>

Base Schema

The base payload for an outbound measurement will have the following fields:

{
  "id": "35263822-7b2e-4683-8720-d31ffb12149b",
  "meta": {
    "schemaVersion": "stel-v2.0"
  },
  "hubId": "ABCDE12345",
  "transmissionTime": "2021-11-29T16:18:10+00:00",
  "device": {
    "mac": "AB:CD:EF:12:34:56",
    "make": "A&D"|null,
    "model": "UA-651BLE"|null
  },
  "measure": {...}
}

<aside> 💡 All timestamps including transmissionTime and time (discussed below) will always be in UTC represented in ISO8601 format using the timezone representation +00:00, as in the example above, i.e. YYYY-MM-DDThh:mm:ss+00:00.

</aside>

Measurement Specific Schemas

The measure field will contain all data relevant to the measurement including the time recorded on the device, the type of measurement, and the measurement values. Note that the time field may be different from the transmissionTime field in the base payload.

<aside> 💡 The time field may be null in the case that the device was not able to report a time.

</aside>

The specific measurement values differ depending on the measurement type. The following is a list of each of the possible types of measurements.

<aside> 💡 Any field encased in Optional may be omitted from the payload if the value is not reported.

</aside>

The following is a toggleable list of all the possible permutations of the measure field for every type of supported measure: