Raritan PX2/PX3 JSON-RPC API
PowerLogicPowerMeter.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2012 Raritan Inc. All rights reserved.
4  */
5 
6 #ifndef __POWERLOGIC_POWERMETER_IDL__
7 #define __POWERLOGIC_POWERMETER_IDL__
8 
9 #include <Event.idl>
10 #include <NumericSensor.idl>
11 #include <ModbusDevice.idl>
12 
13 module powerlogic {
14 
15  /** PowerLogic Power Meter Interface */
16  interface PowerMeter_1_2_5 extends modbus.Device {
17 
18  /** Structured object grouping minimum, maximum and current sensor */
19  structure MinMaxReading {
20  sensors.NumericSensor_4_0_3 min; ///< minimum reading
21  sensors.NumericSensor_4_0_3 max; ///< maximum reading
22  sensors.NumericSensor_4_0_3 reading; ///< current reading
23  };
24 
25  /** Structured object for line to neutral sensors including neutral and average */
26  structure L2N_N_Avg {
27  MinMaxReading l1; ///< L1
28  MinMaxReading l2; ///< L2
29  MinMaxReading l3; ///< L3
32  };
33 
34  /** Structured object for line to line sensors including average */
35  structure L2L_Avg {
36  MinMaxReading l1l2; ///< L1-L2
37  MinMaxReading l2l3; ///< L2-L3
38  MinMaxReading l3l1; ///< L3-L1
40  };
41 
42  /** Structured object for line to neutral sensors including average */
43  structure L2N_Avg {
44  MinMaxReading l1; ///< L1-L2
45  MinMaxReading l2; ///< L2-L3
46  MinMaxReading l3; ///< L3-L1
48  };
49 
50  /** Structured object for line to neutral voltage sensors */
51  structure L2N {
52  MinMaxReading l1; ///< L1
53  MinMaxReading l2; ///< L2
54  MinMaxReading l3; ///< L3
55  };
56 
57  /** Structured object for line to line sensors */
58  structure L2L {
59  MinMaxReading l1l2; ///< L1-L2
60  MinMaxReading l2l3; ///< L2-L3
61  MinMaxReading l3l1; ///< L3-L1
62  };
63 
64  /** Structured object for line to neutral voltage sensors */
65  structure L2N_plain_total {
69  MinMaxReading total; ///< total
70  };
71 
72  /** Sensors */
73  structure Sensors {
74  L2N_N_Avg current; ///< current sensors (L1, L2, L3, N, 3P average)
75  L2L_Avg voltageL2L; ///< line to line voltage sensors (L1-L2, L2-L3, L3-L1, 3P average)
76  L2N_Avg voltageL2N; ///< line to neutral voltage sensors (L1-N, L2-N, L3-N, 3P average)
77  sensors.NumericSensor_4_0_3 frequency; ///< frequency sensor
78  L2N_plain_total activePower; ///< real power sensor (L1, L2, L3, total)
79  L2N_plain_total reactivePower; ///< reactive power sensor (L1, L2, L3, total)
80  L2N_plain_total apparentPower; ///< apparent power sensor (L1, L2, L3, total)
81  MinMaxReading powerFactor; ///< power factor sensor (total)
82  sensors.NumericSensor_4_0_3 activeEnergy; ///< real energy sensor (total)
83  sensors.NumericSensor_4_0_3 reactiveEnergy; ///< reactive energy sensor (total)
84  sensors.NumericSensor_4_0_3 apparentEnergy; ///< apparent energy sensor (total)
85  L2N thdCurrent; ///< total harmonic distortion sensors for current (L1, L2, L3)
86  L2L thdVoltageL2L; ///< total harmonic distortion sensors for voltage (L1-L2, L2-L3, L3-L1)
87  L2N thdVoltageL2N; ///< total harmonic distortion sensors for voltage (L1-N, L2-N, L3-N)
88  };
89 
90  /** PowerLogic Power Meter setup */
91  structure Setup {
92  int systemType; ///< wiring identifier
93  int displayMode; ///< IEC / IEEE units
94  };
95 
96  /** Error status flags */
97  structure ErrorStatus {
98  boolean vL1saturation; ///< voltage L1 saturation
99  boolean vL2saturation; ///< voltage L2 saturation
100  boolean vL3saturation; ///< voltage L3 saturation
101  boolean cL1saturation; ///< current L1 saturation
102  boolean cL2saturation; ///< current L2 saturation
103  boolean cL3saturation; ///< current L3 saturation
104  boolean freqInvalid; ///< frequency invalid
105  };
106 
107  /** Event: Power meter setup has changed */
108  valueobject SetupChangedEvent extends idl.Event {
109  Setup oldSetup; ///< Setup before change
110  Setup newSetup; ///< Setup after change
111  };
112 
113  /** Event: Error status has changed */
114  valueobject ErrorStatusChangedEvent extends idl.Event {
115  ErrorStatus oldStatus; ///< Error status flags before change
116  ErrorStatus newStatus; ///< Error status flags after change
117  };
118 
119  /**
120  * Get the sensors.
121  * Not available sensors will be 'null'.
122  *
123  * @return Power Meter sensors.
124  */
125  Sensors getSensors();
126 
127 
128  /**
129  * Read out Power Meter setup.
130  *
131  * @return Power Meter setup
132  */
133  Setup getSetup();
134 
135  /**
136  * Get error status.
137  *
138  * @return ErrorStatus flags
139  */
140  ErrorStatus getErrorStatus();
141 
142  /**
143  * Reset the min/max values to defaults.
144  */
145  void resetAllMinMaxValues();
146 
147  /**
148  * Reset the energy accumulators to 0.
149  */
150  void clearAllEnergyAccumulators();
151  };
152 }
153 
154 #endif /* !__POWERLOGIC_POWERMETER_IDL__ */
sensors::NumericSensor_4_0_3 frequency
frequency sensor
Definition: PowerLogicPowerMeter.idl:77
L2N thdVoltageL2N
total harmonic distortion sensors for voltage (L1-N, L2-N, L3-N)
Definition: PowerLogicPowerMeter.idl:87
L2N thdCurrent
total harmonic distortion sensors for current (L1, L2, L3)
Definition: PowerLogicPowerMeter.idl:85
MinMaxReading l2
L2.
Definition: PowerLogicPowerMeter.idl:53
PowerLogic Power Meter Interface.
Definition: PowerLogicPowerMeter.idl:16
Structured object for line to line sensors.
Definition: PowerLogicPowerMeter.idl:58
MinMaxReading l1
L1.
Definition: PowerLogicPowerMeter.idl:27
MinMaxReading l1
L1.
Definition: PowerLogicPowerMeter.idl:52
boolean cL2saturation
current L2 saturation
Definition: PowerLogicPowerMeter.idl:102
ErrorStatus newStatus
Error status flags after change.
Definition: PowerLogicPowerMeter.idl:116
int systemType
wiring identifier
Definition: PowerLogicPowerMeter.idl:92
sensors::NumericSensor_4_0_3 reading
current reading
Definition: PowerLogicPowerMeter.idl:22
L2N_Avg voltageL2N
line to neutral voltage sensors (L1-N, L2-N, L3-N, 3P average)
Definition: PowerLogicPowerMeter.idl:76
Definition: ModbusDevice.idl:9
MinMaxReading l2l3
L2-L3.
Definition: PowerLogicPowerMeter.idl:37
Structured object for line to neutral voltage sensors.
Definition: PowerLogicPowerMeter.idl:65
Structured object for line to neutral sensors including average.
Definition: PowerLogicPowerMeter.idl:43
boolean vL1saturation
voltage L1 saturation
Definition: PowerLogicPowerMeter.idl:98
boolean vL3saturation
voltage L3 saturation
Definition: PowerLogicPowerMeter.idl:100
MinMaxReading total
total
Definition: PowerLogicPowerMeter.idl:69
MinMaxReading l2
L2.
Definition: PowerLogicPowerMeter.idl:28
Error status flags.
Definition: PowerLogicPowerMeter.idl:97
boolean vL2saturation
voltage L2 saturation
Definition: PowerLogicPowerMeter.idl:99
Structured object for line to line sensors including average.
Definition: PowerLogicPowerMeter.idl:35
MinMaxReading l3l1
L3-L1.
Definition: PowerLogicPowerMeter.idl:38
Structured object grouping minimum, maximum and current sensor.
Definition: PowerLogicPowerMeter.idl:19
sensors::NumericSensor_4_0_3 apparentEnergy
apparent energy sensor (total)
Definition: PowerLogicPowerMeter.idl:84
sensors::NumericSensor_4_0_3 l1
L1.
Definition: PowerLogicPowerMeter.idl:66
Basic IDL definitions.
Definition: Event.idl:10
sensors::NumericSensor_4_0_3 l3
L3.
Definition: PowerLogicPowerMeter.idl:68
MinMaxReading l2
L2-L3.
Definition: PowerLogicPowerMeter.idl:45
Setup newSetup
Setup after change.
Definition: PowerLogicPowerMeter.idl:110
MinMaxReading l3
L3.
Definition: PowerLogicPowerMeter.idl:29
MinMaxReading l3
L3.
Definition: PowerLogicPowerMeter.idl:54
L2N_N_Avg current
current sensors (L1, L2, L3, N, 3P average)
Definition: PowerLogicPowerMeter.idl:74
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:31
MinMaxReading l1
L1-L2.
Definition: PowerLogicPowerMeter.idl:44
L2L thdVoltageL2L
total harmonic distortion sensors for voltage (L1-L2, L2-L3, L3-L1)
Definition: PowerLogicPowerMeter.idl:86
MinMaxReading l1l2
L1-L2.
Definition: PowerLogicPowerMeter.idl:36
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:39
boolean freqInvalid
frequency invalid
Definition: PowerLogicPowerMeter.idl:104
sensors::NumericSensor_4_0_3 n
neutral
Definition: PowerLogicPowerMeter.idl:30
L2N_plain_total reactivePower
reactive power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:79
Structured object for line to neutral voltage sensors.
Definition: PowerLogicPowerMeter.idl:51
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:47
sensors::NumericSensor_4_0_3 max
maximum reading
Definition: PowerLogicPowerMeter.idl:21
boolean cL1saturation
current L1 saturation
Definition: PowerLogicPowerMeter.idl:101
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
Structured object for line to neutral sensors including neutral and average.
Definition: PowerLogicPowerMeter.idl:26
MinMaxReading powerFactor
power factor sensor (total)
Definition: PowerLogicPowerMeter.idl:81
Definition: PowerLogicConfig.idl:11
boolean cL3saturation
current L3 saturation
Definition: PowerLogicPowerMeter.idl:103
PowerLogic Power Meter setup.
Definition: PowerLogicPowerMeter.idl:91
sensors::NumericSensor_4_0_3 activeEnergy
real energy sensor (total)
Definition: PowerLogicPowerMeter.idl:82
sensors::NumericSensor_4_0_3 l2
L2.
Definition: PowerLogicPowerMeter.idl:67
int displayMode
IEC / IEEE units.
Definition: PowerLogicPowerMeter.idl:93
L2N_plain_total activePower
real power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:78
A sensor with numeric readings.
Definition: NumericSensor.idl:17
Sensors.
Definition: PowerLogicPowerMeter.idl:73
sensors::NumericSensor_4_0_3 min
minimum reading
Definition: PowerLogicPowerMeter.idl:20
MinMaxReading l3
L3-L1.
Definition: PowerLogicPowerMeter.idl:46
MinMaxReading l2l3
L2-L3.
Definition: PowerLogicPowerMeter.idl:60
L2L_Avg voltageL2L
line to line voltage sensors (L1-L2, L2-L3, L3-L1, 3P average)
Definition: PowerLogicPowerMeter.idl:75
L2N_plain_total apparentPower
apparent power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:80
MinMaxReading l1l2
L1-L2.
Definition: PowerLogicPowerMeter.idl:59
MinMaxReading l3l1
L3-L1.
Definition: PowerLogicPowerMeter.idl:61
sensors::NumericSensor_4_0_3 reactiveEnergy
reactive energy sensor (total)
Definition: PowerLogicPowerMeter.idl:83