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
30 sensors.NumericSensor_4_0_3 n; ///< neutral
31 sensors.NumericSensor_4_0_3 average; ///< average
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
39 sensors.NumericSensor_4_0_3 average; ///< average
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
47 sensors.NumericSensor_4_0_3 average; ///< average
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 {
66 sensors.NumericSensor_4_0_3 l1; ///< L1
67 sensors.NumericSensor_4_0_3 l2; ///< L2
68 sensors.NumericSensor_4_0_3 l3; ///< L3
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__ */
powerlogic::PowerMeter_1_2_5::Sensors::frequency
sensors::NumericSensor_4_0_3 frequency
frequency sensor
Definition: PowerLogicPowerMeter.idl:77
powerlogic::PowerMeter_1_2_5::Sensors::thdVoltageL2N
L2N thdVoltageL2N
total harmonic distortion sensors for voltage (L1-N, L2-N, L3-N)
Definition: PowerLogicPowerMeter.idl:87
powerlogic::PowerMeter_1_2_5::Sensors::thdCurrent
L2N thdCurrent
total harmonic distortion sensors for current (L1, L2, L3)
Definition: PowerLogicPowerMeter.idl:85
powerlogic::PowerMeter_1_2_5::L2N::l2
MinMaxReading l2
L2.
Definition: PowerLogicPowerMeter.idl:53
powerlogic::PowerMeter_1_2_5
PowerLogic Power Meter Interface.
Definition: PowerLogicPowerMeter.idl:16
powerlogic::PowerMeter_1_2_5::L2L
Structured object for line to line sensors.
Definition: PowerLogicPowerMeter.idl:58
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::l1
MinMaxReading l1
L1.
Definition: PowerLogicPowerMeter.idl:27
powerlogic::PowerMeter_1_2_5::L2N::l1
MinMaxReading l1
L1.
Definition: PowerLogicPowerMeter.idl:52
powerlogic::PowerMeter_1_2_5::ErrorStatus::cL2saturation
boolean cL2saturation
current L2 saturation
Definition: PowerLogicPowerMeter.idl:102
powerlogic::PowerMeter_1_2_5::newStatus
ErrorStatus newStatus
Error status flags after change.
Definition: PowerLogicPowerMeter.idl:116
powerlogic::PowerMeter_1_2_5::Setup::systemType
int systemType
wiring identifier
Definition: PowerLogicPowerMeter.idl:92
powerlogic::PowerMeter_1_2_5::MinMaxReading::reading
sensors::NumericSensor_4_0_3 reading
current reading
Definition: PowerLogicPowerMeter.idl:22
powerlogic::PowerMeter_1_2_5::Sensors::voltageL2N
L2N_Avg voltageL2N
line to neutral voltage sensors (L1-N, L2-N, L3-N, 3P average)
Definition: PowerLogicPowerMeter.idl:76
modbus
Definition: ModbusDevice.idl:9
powerlogic::PowerMeter_1_2_5::L2L_Avg::l2l3
MinMaxReading l2l3
L2-L3.
Definition: PowerLogicPowerMeter.idl:37
powerlogic::PowerMeter_1_2_5::L2N_plain_total
Structured object for line to neutral voltage sensors.
Definition: PowerLogicPowerMeter.idl:65
powerlogic::PowerMeter_1_2_5::L2N_Avg
Structured object for line to neutral sensors including average.
Definition: PowerLogicPowerMeter.idl:43
powerlogic::PowerMeter_1_2_5::ErrorStatus::vL1saturation
boolean vL1saturation
voltage L1 saturation
Definition: PowerLogicPowerMeter.idl:98
powerlogic::PowerMeter_1_2_5::ErrorStatus::vL3saturation
boolean vL3saturation
voltage L3 saturation
Definition: PowerLogicPowerMeter.idl:100
powerlogic::PowerMeter_1_2_5::L2N_plain_total::total
MinMaxReading total
total
Definition: PowerLogicPowerMeter.idl:69
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::l2
MinMaxReading l2
L2.
Definition: PowerLogicPowerMeter.idl:28
powerlogic::PowerMeter_1_2_5::ErrorStatus
Error status flags.
Definition: PowerLogicPowerMeter.idl:97
powerlogic::PowerMeter_1_2_5::ErrorStatus::vL2saturation
boolean vL2saturation
voltage L2 saturation
Definition: PowerLogicPowerMeter.idl:99
powerlogic::PowerMeter_1_2_5::L2L_Avg
Structured object for line to line sensors including average.
Definition: PowerLogicPowerMeter.idl:35
powerlogic::PowerMeter_1_2_5::L2L_Avg::l3l1
MinMaxReading l3l1
L3-L1.
Definition: PowerLogicPowerMeter.idl:38
powerlogic::PowerMeter_1_2_5::MinMaxReading
Structured object grouping minimum, maximum and current sensor.
Definition: PowerLogicPowerMeter.idl:19
powerlogic::PowerMeter_1_2_5::Sensors::apparentEnergy
sensors::NumericSensor_4_0_3 apparentEnergy
apparent energy sensor (total)
Definition: PowerLogicPowerMeter.idl:84
powerlogic::PowerMeter_1_2_5::L2N_plain_total::l1
sensors::NumericSensor_4_0_3 l1
L1.
Definition: PowerLogicPowerMeter.idl:66
idl
Basic IDL definitions.
Definition: Event.idl:10
powerlogic::PowerMeter_1_2_5::L2N_plain_total::l3
sensors::NumericSensor_4_0_3 l3
L3.
Definition: PowerLogicPowerMeter.idl:68
powerlogic::PowerMeter_1_2_5::L2N_Avg::l2
MinMaxReading l2
L2-L3.
Definition: PowerLogicPowerMeter.idl:45
powerlogic::PowerMeter_1_2_5::newSetup
Setup newSetup
Setup after change.
Definition: PowerLogicPowerMeter.idl:110
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::l3
MinMaxReading l3
L3.
Definition: PowerLogicPowerMeter.idl:29
powerlogic::PowerMeter_1_2_5::L2N::l3
MinMaxReading l3
L3.
Definition: PowerLogicPowerMeter.idl:54
powerlogic::PowerMeter_1_2_5::Sensors::current
L2N_N_Avg current
current sensors (L1, L2, L3, N, 3P average)
Definition: PowerLogicPowerMeter.idl:74
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::average
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:31
powerlogic::PowerMeter_1_2_5::L2N_Avg::l1
MinMaxReading l1
L1-L2.
Definition: PowerLogicPowerMeter.idl:44
powerlogic::PowerMeter_1_2_5::Sensors::thdVoltageL2L
L2L thdVoltageL2L
total harmonic distortion sensors for voltage (L1-L2, L2-L3, L3-L1)
Definition: PowerLogicPowerMeter.idl:86
powerlogic::PowerMeter_1_2_5::L2L_Avg::l1l2
MinMaxReading l1l2
L1-L2.
Definition: PowerLogicPowerMeter.idl:36
powerlogic::PowerMeter_1_2_5::L2L_Avg::average
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:39
powerlogic::PowerMeter_1_2_5::ErrorStatus::freqInvalid
boolean freqInvalid
frequency invalid
Definition: PowerLogicPowerMeter.idl:104
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::n
sensors::NumericSensor_4_0_3 n
neutral
Definition: PowerLogicPowerMeter.idl:30
powerlogic::PowerMeter_1_2_5::Sensors::reactivePower
L2N_plain_total reactivePower
reactive power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:79
powerlogic::PowerMeter_1_2_5::L2N
Structured object for line to neutral voltage sensors.
Definition: PowerLogicPowerMeter.idl:51
powerlogic::PowerMeter_1_2_5::L2N_Avg::average
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:47
powerlogic::PowerMeter_1_2_5::MinMaxReading::max
sensors::NumericSensor_4_0_3 max
maximum reading
Definition: PowerLogicPowerMeter.idl:21
powerlogic::PowerMeter_1_2_5::ErrorStatus::cL1saturation
boolean cL1saturation
current L1 saturation
Definition: PowerLogicPowerMeter.idl:101
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
powerlogic::PowerMeter_1_2_5::L2N_N_Avg
Structured object for line to neutral sensors including neutral and average.
Definition: PowerLogicPowerMeter.idl:26
powerlogic::PowerMeter_1_2_5::Sensors::powerFactor
MinMaxReading powerFactor
power factor sensor (total)
Definition: PowerLogicPowerMeter.idl:81
powerlogic
Definition: PowerLogicConfig.idl:11
powerlogic::PowerMeter_1_2_5::ErrorStatus::cL3saturation
boolean cL3saturation
current L3 saturation
Definition: PowerLogicPowerMeter.idl:103
powerlogic::PowerMeter_1_2_5::Setup
PowerLogic Power Meter setup.
Definition: PowerLogicPowerMeter.idl:91
powerlogic::PowerMeter_1_2_5::Sensors::activeEnergy
sensors::NumericSensor_4_0_3 activeEnergy
real energy sensor (total)
Definition: PowerLogicPowerMeter.idl:82
powerlogic::PowerMeter_1_2_5::L2N_plain_total::l2
sensors::NumericSensor_4_0_3 l2
L2.
Definition: PowerLogicPowerMeter.idl:67
powerlogic::PowerMeter_1_2_5::Setup::displayMode
int displayMode
IEC / IEEE units.
Definition: PowerLogicPowerMeter.idl:93
powerlogic::PowerMeter_1_2_5::Sensors::activePower
L2N_plain_total activePower
real power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:78
sensors::NumericSensor_4_0_3
A sensor with numeric readings.
Definition: NumericSensor.idl:17
powerlogic::PowerMeter_1_2_5::Sensors
Sensors.
Definition: PowerLogicPowerMeter.idl:73
powerlogic::PowerMeter_1_2_5::MinMaxReading::min
sensors::NumericSensor_4_0_3 min
minimum reading
Definition: PowerLogicPowerMeter.idl:20
powerlogic::PowerMeter_1_2_5::L2N_Avg::l3
MinMaxReading l3
L3-L1.
Definition: PowerLogicPowerMeter.idl:46
powerlogic::PowerMeter_1_2_5::L2L::l2l3
MinMaxReading l2l3
L2-L3.
Definition: PowerLogicPowerMeter.idl:60
powerlogic::PowerMeter_1_2_5::Sensors::voltageL2L
L2L_Avg voltageL2L
line to line voltage sensors (L1-L2, L2-L3, L3-L1, 3P average)
Definition: PowerLogicPowerMeter.idl:75
powerlogic::PowerMeter_1_2_5::Sensors::apparentPower
L2N_plain_total apparentPower
apparent power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:80
powerlogic::PowerMeter_1_2_5::L2L::l1l2
MinMaxReading l1l2
L1-L2.
Definition: PowerLogicPowerMeter.idl:59
powerlogic::PowerMeter_1_2_5::L2L::l3l1
MinMaxReading l3l1
L3-L1.
Definition: PowerLogicPowerMeter.idl:61
powerlogic::PowerMeter_1_2_5::Sensors::reactiveEnergy
sensors::NumericSensor_4_0_3 reactiveEnergy
reactive energy sensor (total)
Definition: PowerLogicPowerMeter.idl:83