IOStack Field Reference
Note:
Deprecated fields are marked in red. These fields are either redundant or provide no useful information. They may be removed in future API versions.
Fields marked with an asterisk (*) are created synthetically and are not stored in the time series database.
API Order | Field | Display name | Version | Type | JSON Type | Unit | Rubric | Sub-rubric | Description | Values |
---|---|---|---|---|---|---|---|---|---|---|
1 | Date * | Date | str | str | Date in local/gateway timezone | |||||
2 | Time * | Time | str | str | Time in local/gateway timezone | |||||
3 | Good | Good | int | int | 1 = good read, 0 = failed read | |||||
4 | Good_Reads_Ratio | % Success | int | int | % | Percent successful reads for interval | ||||
5 | Read_Attempts | Reads/interval | int | int | Attempted reads per read interval | |||||
6 | Time_Stamp_UTC_ms * | Timestamp | int | int | ms | Gateway UTC time stamp | ||||
7 | device_time | Device time | str | str | IOStack device clock time | |||||
8 | version_major | Firmware version | int | int | Device firmware major version number | |||||
9 | version_minor | Firmware build | int | int | Device firmware minor version number | |||||
10 | hw_type | Hardware | int | int | Device hardware type | |||||
11 | model | Model | int | int | Device model number | |||||
12 | ai_1 | Analog 1 | int | int | Analog Input | Pin 1 | Analog input pin 1 | |||
13 | ai_2 | Analog 2 | int | int | Analog Input | Pin 2 | Analog input pin 2 | |||
14 | ai_3 | Analog 3 | int | int | Analog Input | Pin 3 | Analog input pin 3 | |||
15 | ai_4 | Analog 4 | int | int | Analog Input | Pin 4 | Analog input pin 4 | |||
16 | di_levels | Digital inputs | int | int | Digital input pin levels | |||||
17 | do_levels | Digital outputs | int | int | Digital output pin levels | |||||
18 | di_pulse_total_1 | Pulse count 1 | int | int | Total lifetime pulse count line 1 | |||||
19 | di_pulse_total_2 | Pulse count 2 | int | int | Total lifetime pulse count line 1 | |||||
20 | di_pulse_total_3 | Pulse count 3 | int | int | Total lifetime pulse count line 1 | |||||
21 | di_pulse_total_4 | Pulse count 4 | int | int | Total lifetime pulse count line 1 | |||||
22 | di_pulse_rst_1 | Resettable count 1 | int | int | Resettable pulse count line 1 | |||||
23 | di_pulse_rst_2 | Resettable count 2 | int | int | Resettable pulse count line 1 | |||||
24 | di_pulse_rst_3 | Resettable count 3 | int | int | Resettable pulse count line 1 | |||||
25 | di_pulse_rst_4 | Resettable count 4 | int | int | Resettable pulse count line 1 | |||||
26 | di_hold_ms_1 | Pulse hold 1 | int | int | ms | Pulse input hold ms line 1 | ||||
27 | di_hold_ms_2 | Pulse hold 2 | int | int | ms | Pulse input hold ms line 2 | ||||
28 | di_hold_ms_3 | Pulse hold 3 | int | int | ms | Pulse input hold ms line 3 | ||||
29 | di_hold_ms_4 | Pulse hold 4 | int | int | ms | Pulse input hold ms line 4 | ||||
30 | di_hi_ms_prev_1 | Pulse prev high 1 | int | int | ms | Pulse input previous high ms line 1 | ||||
31 | di_hi_ms_prev_2 | Pulse prev high 2 | int | int | ms | Pulse input previous high ms line 2 | ||||
32 | di_hi_ms_prev_3 | Pulse prev high 3 | int | int | ms | Pulse input previous high ms line 3 | ||||
33 | di_hi_ms_prev_4 | Pulse prev high 4 | int | int | ms | Pulse input previous high ms line 4 | ||||
34 | di_lo_ms_prev_1 | Pulse prev low 1 | int | int | ms | Pulse input previous low ms line 1 | ||||
35 | di_lo_ms_prev_2 | Pulse prev low 2 | int | int | ms | Pulse input previous low ms line 2 | ||||
36 | di_lo_ms_prev_3 | Pulse prev low 3 | int | int | ms | Pulse input previous low ms line 3 | ||||
37 | di_lo_ms_prev_4 | Pulse prev low 4 | int | int | ms | Pulse input previous low ms line 4 | ||||
38 | di_hi_sec_total_1 | Pulse high 1 | int | int | s | Pulse input total seconds high, pin 1 | ||||
39 | di_hi_sec_total_2 | Pulse high 2 | int | int | s | Pulse input total seconds high, pin 2 | ||||
40 | di_hi_sec_total_3 | Pulse high 3 | int | int | s | Pulse input total seconds high, pin 3 | ||||
41 | di_hi_sec_total_4 | Pulse high 4 | int | int | s | Pulse input total seconds high, pin 4 | ||||
42 | di_lo_sec_total_1 | Pulse low 1 | int | int | s | Pulse input total seconds low, pin 1 | ||||
43 | di_lo_sec_total_2 | Pulse low 2 | int | int | s | Pulse input total seconds low, pin 2 | ||||
44 | di_lo_sec_total_3 | Pulse low 3 | int | int | s | Pulse input total seconds low, pin 3 | ||||
45 | di_lo_sec_total_4 | Pulse low 4 | int | int | s | Pulse input total seconds low, pin 4 | ||||
46 | ow_01_temp | 1-Wire 01 temp | int | int | C | 1-Wire device address 01: temperature | ||||
47 | ow_02_temp | 1-Wire 02 temp | int | int | C | 1-Wire device address 02: temperature | ||||
48 | ow_03_temp | 1-Wire 03 temp | int | int | C | 1-Wire device address 03: temperature | ||||
49 | ow_04_temp | 1-Wire 04 temp | int | int | C | 1-Wire device address 04: temperature | ||||
50 | ow_11_temp | 1-Wire 11 temp | int | int | 1-Wire device address 11: temperature | |||||
51 | ow_12_temp | 1-Wire 12 temp | int | int | 1-Wire bus 1 slot 2 temperature | |||||
52 | ow_13_temp | 1-Wire 13 temp | int | int | 1-Wire bus 1 slot 3 temperature | |||||
53 | ow_14_temp | 1-Wire 14 temp | int | int | 1-Wire bus 1 slot 4 temperature | |||||
54 | ow_21_temp | 1-Wire 21 temp | int | int | 1-Wire bus 2 slot 1 temperature | |||||
55 | ow_22_temp | 1-Wire 22 temp | int | int | 1-Wire bus 2 slot 2 temperature | |||||
56 | ow_23_temp | 1-Wire 23 temp | int | int | 1-Wire bus 2 slot 3 temperature | |||||
57 | ow_24_temp | 1-Wire 24 temp | int | int | 1-Wire bus 2 slot 4 temperature | |||||
58 | ow_31_temp | 1-Wire 31 temp | int | int | 1-Wire bus 3 slot 1 temperature | |||||
59 | ow_32_temp | 1-Wire 32 temp | int | int | 1-Wire bus 3 slot 2 temperature | |||||
60 | ow_33_temp | 1-Wire 33 temp | int | int | 1-Wire bus 3 slot 3 temperature | |||||
61 | ow_34_temp | 1-Wire 34 temp | int | int | 1-Wire bus 3 slot 4 temperature | |||||
62 | ow_01_humidity | 1-Wire 01 humidity | int | int | 1-Wire bus 0 slot 1 humidity | |||||
63 | ow_02_humidity | 1-Wire 02 humidity | int | int | 1-Wire bus 0 slot 2 humidity | |||||
64 | ow_03_humidity | 1-Wire 03 humidity | int | int | 1-Wire bus 0 slot 3 humidity | |||||
65 | ow_04_humidity | 1-Wire 04 humidity | int | int | 1-Wire bus 0 slot 4 humidity | |||||
66 | ow_11_humidity | 1-Wire 11 humidity | int | int | 1-Wire bus 1 slot 1 humidity | |||||
67 | ow_12_humidity | 1-Wire 12 humidity | int | int | 1-Wire bus 1 slot 2 humidity | |||||
68 | ow_13_humidity | 1-Wire 13 humidity | int | int | 1-Wire bus 1 slot 3 humidity | |||||
69 | ow_14_humidity | 1-Wire 14 humidity | int | int | 1-Wire bus 1 slot 4 humidity | |||||
70 | ow_21_humidity | 1-Wire 21 humidity | int | int | 1-Wire bus 2 slot 1 humidity | |||||
71 | ow_22_humidity | 1-Wire 22 humidity | int | int | 1-Wire bus 2 slot 2 humidity | |||||
72 | ow_23_humidity | 1-Wire 23 humidity | int | int | 1-Wire bus 2 slot 3 humidity | |||||
73 | ow_24_humidity | 1-Wire 24 humidity | int | int | 1-Wire bus 2 slot 4 humidity | |||||
74 | ow_31_humidity | 1-Wire 31 humidity | int | int | 1-Wire bus 3 slot 1 humidity | |||||
75 | ow_32_humidity | 1-Wire 32 humidity | int | int | 1-Wire bus 3 slot 2 humidity | |||||
76 | ow_33_humidity | 1-Wire 33 humidity | int | int | 1-Wire bus 3 slot 3 humidity | |||||
77 | ow_34_humidity | 1-Wire 34 humidity | int | int | 1-Wire bus 3 slot 4 humidity | |||||
78 | ow_01_lux | 1-Wire 01 lux | int | int | 1-Wire bus 0 slot 1 lux | |||||
79 | ow_02_lux | 1-Wire 02 lux | int | int | 1-Wire bus 0 slot 2 lux | |||||
80 | ow_03_lux | 1-Wire 03 lux | int | int | 1-Wire bus 0 slot 3 lux | |||||
81 | ow_04_lux | 1-Wire 04 lux | int | int | 1-Wire bus 0 slot 4 lux | |||||
82 | ow_11_lux | 1-Wire 11 lux | int | int | 1-Wire bus 1 slot 1 lux | |||||
83 | ow_12_lux | 1-Wire 12 lux | int | int | 1-Wire bus 1 slot 2 lux | |||||
84 | ow_13_lux | 1-Wire 13 lux | int | int | 1-Wire bus 1 slot 3 lux | |||||
85 | ow_14_lux | 1-Wire 14 lux | int | int | 1-Wire bus 1 slot 4 lux | |||||
86 | ow_21_lux | 1-Wire 21 lux | int | int | 1-Wire bus 2 slot 1 lux | |||||
87 | ow_22_lux | 1-Wire 22 lux | int | int | 1-Wire bus 2 slot 2 lux | |||||
88 | ow_23_lux | 1-Wire 23 lux | int | int | 1-Wire bus 2 slot 3 lux | |||||
89 | ow_24_lux | 1-Wire 24 lux | int | int | 1-Wire bus 2 slot 4 lux | |||||
90 | ow_31_lux | 1-Wire 31 lux | int | int | 1-Wire bus 3 slot 1 lux | |||||
91 | ow_32_lux | 1-Wire 32 lux | int | int | 1-Wire bus 3 slot 2 lux | |||||
92 | ow_33_lux | 1-Wire 33 lux | int | int | 1-Wire bus 3 slot 3 lux | |||||
93 | ow_34_lux | 1-Wire 34 lux | int | int | 1-Wire bus 3 slot 4 lux |
* Field is synthetically created and does not exist in the Influx database.
It is prudent to assume it will be deprecated.
Download JSON File: ekm_iostack_fields.json
JSON field attributes
-
version (str)Device version if field is version-specific. Can be "v3", "v4", "v5"
-
alias (str)Legacy field name alias.
-
display_fmt (str)Value formatting hint for UIs.
-
field_type (str)Field type. Nominal data type as stored in Influx.
Can be one of int, float, str, or hex. A hex type is a hexadecimal number stored as a string. -
json_type (str)JSON output type. Can be one of "int", "float", "str".
Default is same as field type. -
unit (str)Unit shorthand (ie. "%", "ms", etc).
-
precision (int)Number of decimal places of numeric precision. A value of -1 means use the value of the kWh_Scale field to determine precision.monotonic (bool)Field value increases/decreases monotonically. Value may wrap around.hidden (bool)Field not displayed in friendlier UIs.deprecated (bool)Field is deprecated. Do not use.synthetic (bool)Field is synthetically created and is not in time series database.description (bool)Description of this field.rubric (str)Field heading/categorysubrubric (str)Field subcategory or rubric.value_names (dict)A mapping of descriptive strings to valid field values.