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	Type	JSON Type	Unit	Rubric	Sub-rubric	Description
1	Good	Good	int	int				Successful data read
2	Good_Reads_Ratio	Good Reads Ratio	int	int	%			Ratio of successful reads to bad reads in one cycle
3	Read_Attempts	Read Attempts	int	int				Number of read attempts per cycle
4	Date *	Date	str	str				Timestamp date
5	Time *	Time	str	str				Timestamp time
6	Time_Stamp_UTC_ms *	Timestamp UTC ms	int	int	ms			Timestamp in milliseconds
7	Device_Time	Device Time	str	str				ioStack onboard clock time
8	Firmware	Firmware	str	str				Device firmware version
9	Hardware_Type	Hardware Type	int	int				Device hardware type
10	Model	Model	int	int				Device model number
11	Analog_In_1	Analog Input 1	int	int		Analog Input	Pin 1	Analog input 1
12	Analog_In_2	Analog Input 2	int	int		Analog Input	Pin 2	Analog input 2
13	Analog_In_3	Analog Input 3	int	int		Analog Input	Pin 3	Analog input 3
14	Analog_In_4	Analog Input 4	int	int		Analog Input	Pin 4	Analog input 4
15	State_Inputs	Pulse Input State	int	int				Pulse input state
16	State_Out	Control Output State	int	int				Control output state
17	Pulse_Cnt_1	Pulse Count 1	int	int		Pulse Count	Pin 1	Total lifetime pulse count line 1
18	Pulse_Cnt_2	Pulse Count 2	int	int		Pulse Count	Pin 2	Total lifetime pulse count line 2
19	Pulse_Cnt_3	Pulse Count 3	int	int		Pulse Count	Pin 3	Total lifetime pulse count line 3
20	Pulse_Cnt_4	Pulse Count 4	int	int		Pulse Count	Pin 4	Total lifetime pulse count line 4
21	Pulse_Cnt_Rst_1	Resettable Pulse Count 1	int	int				Resettable pulse count line 1
22	Pulse_Cnt_Rst_2	Resettable Pulse Count 2	int	int				Resettable pulse count line 2
23	Pulse_Cnt_Rst_3	Resettable Pulse Count 3	int	int				Resettable pulse count line 3
24	Pulse_Cnt_Rst_4	Resettable Pulse Count 4	int	int				Resettable pulse count line 4
25	Pulse_Hold_ms_1	Pulse Hold (ms) 1	int	int	ms			Pulse input 1 hold (milliseconds)
26	Pulse_Hold_ms_2	Pulse Hold (ms) 2	int	int	ms			Pulse input 2 hold (milliseconds)
27	Pulse_Hold_ms_3	Pulse Hold (ms) 3	int	int	ms			Pulse input 3 hold (milliseconds)
28	Pulse_Hold_ms_4	Pulse Hold (ms) 4	int	int	ms			Pulse input 4 hold (milliseconds)
29	Pulse_Hi_Prev_ms_1	Pulse High Previous (ms) 1	int	int	ms			Pulse input 1 previous high (milliseconds)
30	Pulse_Hi_Prev_ms_2	Pulse High Previous (ms) 2	int	int	ms			Pulse input 2 previous high (milliseconds)
31	Pulse_Hi_Prev_ms_3	Pulse High Previous (ms) 3	int	int	ms			Pulse input 3 previous high (milliseconds)
32	Pulse_Hi_Prev_ms_4	Pulse High Previous (ms) 4	int	int	ms			Pulse input 4 previous high (milliseconds)
33	Pulse_Lo_Prev_ms_1	Pulse Low Previous (ms) 1	int	int	ms			Pulse input 1 previous low (milliseconds)
34	Pulse_Lo_Prev_ms_2	Pulse Low Previous (ms) 2	int	int	ms			Pulse input 2 previous low (milliseconds)
35	Pulse_Lo_Prev_ms_3	Pulse Low Previous (ms) 3	int	int	ms			Pulse input 3 previous low (milliseconds)
36	Pulse_Lo_Prev_ms_4	Pulse Low Previous (ms) 4	int	int	ms			Pulse input 4 previous low (milliseconds)
37	Pulse_Hi_Total_sec_1	Pulse High Total (sec) 1	int	int	s			Pulse input 1 total high (seconds)
38	Pulse_Hi_Total_sec_2	Pulse High Total (sec) 2	int	int	s			Pulse input 2 total high (seconds)
39	Pulse_Hi_Total_sec_3	Pulse High Total (sec) 3	int	int	s			Pulse input 3 total high (seconds)
40	Pulse_Hi_Total_sec_4	Pulse High Total (sec) 4	int	int	s			Pulse input 4 total high (seconds)
41	Pulse_Lo_Total_sec_1	Pulse Low Total (sec) 1	int	int	s			Pulse input 1 total Low (seconds)
42	Pulse_Lo_Total_sec_2	Pulse Low Total (sec) 2	int	int	s			Pulse input 2 total Low (seconds)
43	Pulse_Lo_Total_sec_3	Pulse Low Total (sec) 3	int	int	s			Pulse input 3 total Low (seconds)
44	Pulse_Lo_Total_sec_4	Pulse Low Total (sec) 4	int	int	s			Pulse input 4 total Low (seconds)
45	OW_1_1_degC	1-Wire 1_1 Degree C	int	int	C			1-Wire bus 1, slot 1: ºC
46	OW_1_2_degC	1-Wire 1_2 Degree C	int	int	C			1-Wire bus 1, slot 2: ºC
47	OW_1_3_degC	1-Wire 1_3 Degree C	int	int	C			1-Wire bus 1, slot 3: ºC
48	OW_1_4_degC	1-Wire 1_4 Degree C	int	int	C			1-Wire bus 1, slot 4: ºC
49	OW_2_1_degC	1-Wire 2_1 Degree C	int	int				1-Wire bus 2, slot 1: ºC
50	OW_2_2_degC	1-Wire 2_2 Degree C	int	int				1-Wire bus 2, slot 2: ºC
51	OW_2_3_degC	1-Wire 2_3 Degree C	int	int				1-Wire bus 2, slot 3: ºC
52	OW_2_4_degC	1-Wire 2_4 Degree C	int	int				1-Wire bus 2, slot 4: ºC
53	OW_3_1_degC	1-Wire 3_1 Degree C	int	int				1-Wire bus 3, slot 1: ºC
54	OW_3_2_degC	1-Wire 3_2 Degree C	int	int				1-Wire bus 3, slot 2: ºC
55	OW_3_3_degC	1-Wire 3_3 Degree C	int	int				1-Wire bus 3, slot 3: ºC
56	OW_3_4_degC	1-Wire 3_4 Degree C	int	int				1-Wire bus 3, slot 4: ºC
57	OW_4_1_degC	1-Wire 4_1 Degree C	int	int				1-Wire bus 4, slot 1: ºC
58	OW_4_2_degC	1-Wire 4_2 Degree C	int	int				1-Wire bus 4, slot 2: ºC
59	OW_4_3_degC	1-Wire 4_3 Degree C	int	int				1-Wire bus 4, slot 3: ºC
60	OW_4_4_degC	1-Wire 4_4 Degree C	int	int				1-Wire bus 4, slot 4: ºC
61	OW_1_1_Humidity	1-Wire 1_1 Humidity	int	int				1-Wire bus 1, slot 1: humidity
62	OW_1_2_Humidity	1-Wire 1_2 Humidity	int	int				1-Wire bus 1, slot 2: humidity
63	OW_1_3_Humidity	1-Wire 1_3 Humidity	int	int				1-Wire bus 1, slot 3: humidity
64	OW_1_4_Humidity	1-Wire 1_4 Humidity	int	int				1-Wire bus 1, slot 4: humidity
65	OW_2_1_Humidity	1-Wire 2_1 Humidity	int	int				1-Wire bus 2, slot 1: humidity
66	OW_2_2_Humidity	1-Wire 2_2 Humidity	int	int				1-Wire bus 2, slot 2: humidity
67	OW_2_3_Humidity	1-Wire 2_3 Humidity	int	int				1-Wire bus 2, slot 3: humidity
68	OW_2_4_Humidity	1-Wire 2_4 Humidity	int	int				1-Wire bus 2, slot 4: humidity
69	OW_3_1_Humidity	1-Wire 3_1 Humidity	int	int				1-Wire bus 3, slot 1: humidity
70	OW_3_2_Humidity	1-Wire 3_2 Humidity	int	int				1-Wire bus 3, slot 2: humidity
71	OW_3_3_Humidity	1-Wire 3_3 Humidity	int	int				1-Wire bus 3, slot 3: humidity
72	OW_3_4_Humidity	1-Wire 3_4 Humidity	int	int				1-Wire bus 3, slot 4: humidity
73	OW_4_1_Humidity	1-Wire 4_1 Humidity	int	int				1-Wire bus 4, slot 1: humidity
74	OW_4_2_Humidity	1-Wire 4_2 Humidity	int	int				1-Wire bus 4, slot 2: humidity
75	OW_4_3_Humidity	1-Wire 4_3 Humidity	int	int				1-Wire bus 4, slot 3: humidity
76	OW_4_4_Humidity	1-Wire 4_4 Humidity	int	int				1-Wire bus 4, slot 4: humidity
77	OW_1_1_Lux	1-Wire 1_1 Lux	int	int				1-Wire bus 1, slot 1: lux
78	OW_1_2_Lux	1-Wire 1_2 Lux	int	int				1-Wire bus 1, slot 2: lux
79	OW_1_3_Lux	1-Wire 1_3 Lux	int	int				1-Wire bus 1, slot 3: lux
80	OW_1_4_Lux	1-Wire 1_4 Lux	int	int				1-Wire bus 1, slot 4: lux
81	OW_2_1_Lux	1-Wire 2_1 Lux	int	int				1-Wire bus 2, slot 1: lux
82	OW_2_2_Lux	1-Wire 2_2 Lux	int	int				1-Wire bus 2, slot 2: lux
83	OW_2_3_Lux	1-Wire 2_3 Lux	int	int				1-Wire bus 2, slot 3: lux
84	OW_2_4_Lux	1-Wire 2_4 Lux	int	int				1-Wire bus 2, slot 4: lux
85	OW_3_1_Lux	1-Wire 3_1 Lux	int	int				1-Wire bus 3, slot 1: lux
86	OW_3_2_Lux	1-Wire 3_2 Lux	int	int				1-Wire bus 3, slot 2: lux
87	OW_3_3_Lux	1-Wire 3_3 Lux	int	int				1-Wire bus 3, slot 3: lux
88	OW_3_4_Lux	1-Wire 3_4 Lux	int	int				1-Wire bus 3, slot 4: lux
89	OW_4_1_Lux	1-Wire 4_1 Lux	int	int				1-Wire bus 4, slot 1: lux
90	OW_4_2_Lux	1-Wire 4_2 Lux	int	int				1-Wire bus 4, slot 2: lux
91	OW_4_3_Lux	1-Wire 4_3 Lux	int	int				1-Wire bus 4, slot 3: lux
92	OW_4_4_Lux	1-Wire 4_4 Lux	int	int				1-Wire bus 4, 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

display_name (str)

Human-friendly field name.
data_source (bool)

Field can used as a trigger condition data source.
version (str)

Device protocol version if field is version-specific. Can be "v3", "v4", "v5"
alias (str)

Legacy field name alias (meters only).
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/category
subrubric (str)

Field subcategory or rubric.
value_names (dict)

A mapping of descriptive strings to valid field values.