EKM Meter Field Reference

Reference JSON file
API Order Field Version Type JSON Type Unit Precision v3 Precision v4 Alias Description Values
1 Good all int int 1 = good read, 0 = failed read
2 Date all str str Date in local/gateway timezone
3 Time all str str Time in local/gateway timezone
4 Time_Stamp_UTC_ms all int int ms Gateway UTC time stamp
5 Meter_Time all str str Meter time stamp
6 Firmware all str str FWVER.METER Meter firmware version
7 Model all int str MODEL.METER Meter model number
8 Good_Reads_Ratio all float float 2 2 Ratio of good/bad reads for interval
9 Read_Attempts all int str Attempted meter reads per read interval
10 kWh_Tot all float str kWh 1 kWh_Scale PT.TOT Total kWh
11 kWh_Tariff_1 all float str kWh 1 kWh_Scale PT.T1 kWh for Tariff 1
12 kWh_Tariff_2 all float str kWh 1 kWh_Scale PT.T2 kWh for Tariff 2
13 kWh_Tariff_3 all float str kWh 1 kWh_Scale PT.T3 kWh for Tariff 3
14 kWh_Tariff_4 all float str kWh 1 kWh_Scale PT.T4 kWh for Tariff 4
15 Rev_kWh_Tot all float str kWh 1 kWh_Scale PT_REV.TOT Total Reverse kWh
16 Rev_kWh_Tariff_1 all float str kWh 1 kWh_Scale PT_REV.T1 Reverse kWh for Tariff 1
17 Rev_kWh_Tariff_2 all float str kWh 1 kWh_Scale PT_REV.T2 Reverse kWh for Tariff 2
18 Rev_kWh_Tariff_3 all float str kWh 1 kWh_Scale PT_REV.T3 Reverse kWh for Tariff 3
19 Rev_kWh_Tariff_4 all float str kWh 1 kWh_Scale PT_REV.T4 Reverse kWh for Tariff 4
20 RMS_Volts_Ln_1 all float str V 1 1 V.L1 Volts on line 1
21 RMS_Volts_Ln_2 all float str V 1 1 V.L2 Volts on line 2
22 RMS_Volts_Ln_3 all float str V 1 1 V.L3 Volts on line 3
23 Amps_Ln_1 all float str A 1 1 I.L1 Amps on line 1
24 Amps_Ln_2 all float str A 1 1 I.L2 Amps on line 2
25 Amps_Ln_3 all float str A 1 1 I.L3 Amps on line 3
26 Power_Factor_Ln_1 all int str PF.L1 Power Factor line 1
27 Power_Factor_Ln_2 all int str PF.L2 Power Factor line 2
28 Power_Factor_Ln_3 all int str PF.L3 Power Factor line 3
29 Cos_Theta_Ln_1 all str str Power Factor Cos(theta) line 1
30 Cos_Theta_Ln_2 all str str Power Factor Cos(theta) line 2
31 Cos_Theta_Ln_3 all str str Power Factor Cos(theta) line 3
32 RMS_Watts_Ln_1 all int str W P.L1 Watts on line 1
33 RMS_Watts_Ln_2 all int str W P.L2 Watts on line 2
34 RMS_Watts_Ln_3 all int str W P.L3 Watts on line 3
35 RMS_Watts_Tot all int str W P.TOT Total Watts (all lines)
36 RMS_Watts_Max_Demand all int str W P.MAX Max Demand RMS Watts
37 Max_Demand_Period all int str ENUM.PMAXPD Max Demand Period 1=15m, 2=30m, 3=1h
38 Max_Demand_Rst v4 int str ENUM.PMAXAUTO Max Demand auto reset interval 0=OFF, 1=Monthly, 2=Weekly, 3=Daily, 4=Hourly
39 CT_Ratio all int str RAT.CT CT Ratio
40 Pulse_Cnt_1 v4 int str PC.P1 Pulse Count on input 1
41 Pulse_Cnt_2 v4 int str PC.P2 Pulse Count on input 2
42 Pulse_Cnt_3 v4 int str PC.P3 Pulse Count on input 3
43 State_Inputs v4 int str ST.PC Binary states of the three pulse inputs 0=[High, High, High], 1=[High, High, Low], 2=[High, Low, High], 3=[High, Low, Low], 4=[Low, High, High], 5=[Low, High, Low], 6=[Low, Low, High], 7=[Low, Low, Low]
44 Pulse_Ratio_1 v4 int str RAT.P1 Pulse Input Ratio on input 1
45 Pulse_Ratio_2 v4 int str RAT.P2 Pulse Input Ratio on input 2
46 Pulse_Ratio_3 v4 int str RAT.P3 Pulse Input Ratio on input 3
47 Reactive_Energy_Tot v4 float str 1 kWh_Scale PT_REACT.TOT Total kVARh
48 kWh_Rst v4 float str kWh kWh_Scale PT.RST Resettable kWh
49 Rev_kWh_Rst v4 float str kWh kWh_Scale PT_REV.RST Resettable Reverse kWh
50 kWh_Scale v4 int str ENUM.PTSCALE Decimal places for kWh (0-2)
51 Reactive_Pwr_Ln_1 v4 int str var P_REACT.L1 Var on line 1
52 Reactive_Pwr_Ln_2 v4 int str var P_REACT.L2 Var on line 2
53 Reactive_Pwr_Ln_3 v4 int str var P_REACT.L3 Var on line 3
54 Reactive_Pwr_Tot v4 int str var P_REACT.TOT Total Var (Volt-ampere reactive)
55 Line_Freq v4 float str Hz 2 FREQ.P Frequency (Hz)
56 State_Watts_Dir v4 int str ST.PDIR Real-time direction of current (L1,L2,L3) 1=[Fwd, Fwd, Fwd], 2=[Fwd, Fwd, Rev], 3=[Fwd, Rev, Fwd], 4=[Rev, Fwd, Fwd], 5=[Fwd, Rev, Rev], 6=[Rev, Fwd, Rev], 7=[Rev, Rev, Fwd], 8=[Rev, Rev, Rev]
57 State_Out v4 int str ST.OUT Binary states of the two outputs 1=[OFF, OFF], 2=[OFF, ON], 3=[ON, OFF], 4=[ON, ON]
58 kWh_Ln_1 v4 float str kWh kWh_Scale PT.L1 Total kWh on line 1
59 kWh_Ln_2 v4 float str kWh kWh_Scale PT.L2 Total kWh on line 2
60 kWh_Ln_3 v4 float str kWh kWh_Scale PT.L3 Total kWh on line 3
61 Rev_kWh_Ln_1 v4 float str kWh kWh_Scale PT_REV.L1 Reverse kWh on line 1
62 Rev_kWh_Ln_2 v4 float str kWh kWh_Scale PT_REV.L2 Reverse kWh on line 2
63 Rev_kWh_Ln_3 v4 float str kWh kWh_Scale PT_REV.L3 Reverse kWh on line 3
64 Net_Calc_Watts_Ln_1 v4 int str W NET.L1 Net Watts on line 1
65 Net_Calc_Watts_Ln_2 v4 int str W NET.L2 Net Watts on line 2
66 Net_Calc_Watts_Ln_3 v4 int str W NET.L3 Net Watts on line 3
67 Net_Calc_Watts_Tot v4 int str W NET.TOT Total Net Watts
68 CF_Ratio v4 int str RAT.CF Settable Pulse Output Ratio
69 Meter_Status_Code v3 int str ST.SETBACK Meter status code
70 Meter_Status_Code_A v4 int str ST.SETBACK_A Meter status code A
71 Meter_Status_Code_B v4 int str ST.SETBACK_B Meter status code B
72 Meter_Status_Code_C v4 int str ST.SETBACK_C Meter status code C

Download JSON File: ekm_meter_fields.json

JSON field attributes

  • type
    Nominal type. Can be one of int, float, str
  • json_type
    JSON output type. Can be one of int, float, str
  • unit
    Unit shorthand.
  • precision
    Number of decimal places of numeric precision. A value of -1 means use the value of the kWh_Scale field to determine precision. This is a dictionary of meter version ==> precision.
  • meter_version
    Meter version. Can be "v3", "v4", "v5"
  • alias
    Legacy field name alias.
  • description
    Description of this field.
  • category
    Field category
  • subcategory
    Field subcategory or rubric.
  • text_values
    A list of descriptive strings that correspond to the range of valid field value.