calibrated_result [DRAFT] [WIP]

Example calibrated_result (content forged from multiple independent sources)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 { "error_code": 0, "error_description": "Waiting init data", "hd": [ { "sensor_id": "FuelTank_Volume", "timestamp": "2022-01-19T22:32:30.587Z", "value": 3354.34 }, { "sensor_id": "FuelTank_Height", "timestamp": "2022-01-19T22:32:30.587Z", "value": 1.44 }, { "sensor_id": "FuelTank_Volume", "timestamp": "2022-01-19T22:32:35.587Z", "value": 3324.37 }, { "sensor_id": "FuelTank_Height", "timestamp": "2022-01-19T22:32:35.587Z", "value": 1.43 } ], "result_uid": "018a29d4-bb22-4914-a4bb-0157a90937d3", "sensor_id": "WTSC_Keypad_DO_1_red_LED", "timestamp": "2022-01-19T21:06:35.081Z", "value": 1, "tags": [ { "name": "OrderID", "value": "sensor_OrderID_value" }, { "name": "JobID", "value": "sensor_JobID_value" }, { "name": "BatchID", "value": "sensor_BatchID_value" } ] }

Field definition

Field name

Purpose

Optional

Default value

Field name

Purpose

Optional

Default value

error_code

Numeric representation of an error that occurred for this sensor. An error_code of 0 means no error, any other value indicates an error but which error it is depends on the module which created it.

Yes

0

error_description

A textual description of that error encoded in error_code

Yes

""

hd

The list of calibrated_results this calibrated_result is based on (e.g. in case of Virtual Sensors)

Yes

[]

result_uid

GUID to identify the origin of a calibrated_result (e.g. when it is the result of an action or automation rule)

Yes

null

sensor_id

The sensor_id of the sensor this calibrated_result is measured from.

No

n./a.

tags

May contain a list of strings this calibrated_result is tagged with.

Yes

[]

timestamp

Message timestamp in ISO8601 format (e.g. 2022-01-24T12:49:35.543+01:00)

No

n./a.

value

The measured value, already converted into a meaningful range of values.

No

n./a.