MQTT Topics
| MQTT Topic List | ||
|---|---|---|
| Default Topic Name | Description | Notes |
| /fail | Errors reported by translator | MQTT topics all take the form __________Serial Number__________, where the blank fields are configurable in the configuration page. The default prefix is blank, and the default suffix is listed here. An example serial number is 2046SBI12345. |
| /measurement | Measurement data from EXO | |
| /status | Status information from EXO | |
| /error | Errors reported by EXO | |
| /trans_fail_message Payload | |||
|---|---|---|---|
| Key | Data Type | Key Description | Notes |
| ver | Integer | Translator version |
Firmware version (Major.Minor.Build) of the Translator, converted using: Version = Major * 2²⁴ + Minor * 2¹⁶ + Build. For example, v1.2.3 → 16908291. |
| ecd | Integer | Error code | See the MQTT Enumerated Fields tables (Translator Status - Bit Mask) for a list of values. |
| /error_message Payload | |||
|---|---|---|---|
| Key | Data Type | Key Description | Notes |
| ver | Integer | Translator version |
Firmware version (Major.Minor.Build) of the Translator, converted using: Version = Major * 2²⁴ + Minor * 2¹⁶ + Build. For example, v1.2.3 → 16908291. |
| ecd | Integer | Error code |
Error code reported by EXO. Will read as 0 if no errors have been reported. |
| /exo_message Payload | |||
|---|---|---|---|
| Key | Data Type | Key Description | Notes |
| ver | Integer | Translator version |
Firmware version (Major.Minor.Build) of the Translator, converted using: Version = Major * 2²⁴ + Minor * 2¹⁶ + Build. For example, v1.2.3 → 16908291. |
| tms | String | Timestamp of the EXO message | Date and UTC time of the EXO device location, in the format of "YYYY-MM-DD HH:MM:SS". |
| uid | Integer | Unit ID |
Device ID of the EXO. 10-digit number beginning with 358. |
| btl | Integer | Battery level |
Battery level in percent from 0 to 100. A value of 255 means the battery level is unknown. |
| chs | Integer | Charging status | 1 if the EXO is charging, 0 otherwise. |
| lat | Integer | Last known GPS latitude |
Last known latitude in (degrees × 10⁷). A value of 0x7FFFFFFF indicates unknown location. |
| lot | Integer | Last known GPS longitude |
Last known longitude in (degrees × 10⁷). A value of 0x7FFFFFFF indicates unknown location. |
| alt | Integer | Last known GPS altitude |
Last known altitude above main sea level, in meters. A value of 0x7FFFFFFF indicates unknown location. |
| bid | Integer | Last known beacon ID |
Device ID of the last registered Blackline GPS beacon. 10-digit number beginning with 1370 or 1371. |
| nss | Integer | Network signal strength | Network RSSI normalized to a value from 0 to 10. |
| asm | Integer | Alarm status mask | See the MQTT Enumerated Fields tables (EXO Alarm Status - Bit Mask) for a list of values. |
| /gas_message Payload | |||
|---|---|---|---|
| Key | Data Type | Key Description | Notes |
| ver | Integer | Translator version |
Firmware version (Major.Minor.Build) of the Translator, converted using: Version = Major * 2²⁴ + Minor * 2¹⁶ + Build. For example, v1.2.3 → 16908291. |
| tms | String | Timestamp of the gas message | Date and UTC time of the EXO device location, in the format of "YYYY-MM-DD HH:MM:SS". |
| tmp | Float | Sensor temperature | Sensor temperature in °C. |
| prs | Float | Sensor pressure | Sensor pressure in hPa. |
| hmd | Float | Sensor humidity in % | Sensor humidity in %. |
| nbt | Integer | Days until next bump due |
Number of days until the next bump test. Negative values indicate the test is overdue. |
| aci | Integer | Current inlet that is active (0-5) |
The numbered pump inlet that is active. A value of 0 indicates diffusion, and 5 indicates purging. |
| pfr | Float | Flow rate | The flow rate of the pump. |
| sn1st | Integer | Gas sensor 1 status | See the MQTT Enumerated Fields tables (EXO Alarm Status - Bit Mask) for a list of values. |
| sn1gt | Integer | Gas sensor 1 gas type | See the MQTT Enumerated Fields tables (Gas Types) for a list of values. |
| sn1rd | Float | Gas sensor 1 reading | Gas reading, with units noted in the following register. |
| sn1ut | Integer | Gas sensor 1 reading units | See the MQTT Enumerated Fields tables (Measurement Units) for a list of values. |
| sn1nc | Integer | Gas sensor 1 next calibration due |
Number of days until the next calibration for this sensor. Negative values indicate the calibration is overdue. |
| sn2st | Integer | Gas sensor 2 status | See the MQTT Enumerated Fields tables (EXO Alarm Status - Bit Mask) for a list of values. |
| sn2gt | Integer | Gas sensor 2 gas type | See the MQTT Enumerated Fields tables (Gas Types) for a list of values. |
| sn2rd | Float | Gas sensor 2 reading | Gas reading, with units noted in the following register. |
| sn2ut | Integer | Gas sensor 2 reading units | See the MQTT Enumerated Fields tables (Measurement Units) for a list of values. |
| sn2nc | Integer | Gas sensor 2 next calibration due |
Number of days until the next calibration for this sensor. Negative values indicate the calibration is overdue. |
| sn3st | Integer | Gas sensor 3 status | See the MQTT Enumerated Fields tables (EXO Alarm Status - Bit Mask) for a list of values. |
| sn3gt | Integer | Gas sensor 3 gas type | See the MQTT Enumerated Fields tables (Gas Types) for a list of values. |
| sn3rd | Float | Gas sensor 3 reading | Gas reading, with units noted in the following register. |
| sn3ut | Integer | Gas sensor 3 reading units | See the MQTT Enumerated Fields tables (Measurement Units) for a list of values. |
| sn3nc | Integer | Gas sensor 3 next calibration due |
Number of days until the next calibration for this sensor. Negative values indicate the calibration is overdue. |
| sn4st | Integer | Gas sensor 4 status | See the MQTT Enumerated Fields tables (EXO Alarm Status - Bit Mask) for a list of values. |
| sn4gt | Integer | Gas sensor 4 gas type | See the MQTT Enumerated Fields tables (Gas Types) for a list of values. |
| sn4rd | Float | Gas sensor 4 reading | Gas reading, with units noted in the following register. |
| sn4ut | Integer | Gas sensor 4 reading units | See the MQTT Enumerated Fields tables (Measurement Units) for a list of values. |
| sn4nc | Integer | Gas sensor 4 next calibration due |
Number of days until the next calibration for this sensor. Negative values indicate the calibration is overdue. |
| sn5st | Integer | Gas sensor 5 status | See the MQTT Enumerated Fields tables (EXO Alarm Status - Bit Mask) for a list of values. |
| sn5gt | Integer | Gas sensor 5 gas type | See the MQTT Enumerated Fields tables (Gas Types) for a list of values. |
| sn5rd | Float | Gas sensor 5 reading | Gas reading, with units noted in the following register. |
| sn5ut | Integer | Gas sensor 5 reading units | See the MQTT Enumerated Fields tables (Measurement Units) for a list of values. |
| sn5nc | Integer | Gas sensor 5 next calibration due |
Number of days until the next calibration for this sensor. Negative values indicate the calibration is overdue. |
