Raritan PX2/PX3 JSON-RPC API
Pole.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2009 Raritan Inc. All rights reserved.
4  */
5 
6 #ifndef __PDUMODEL_POLE_IDL__
7 #define __PDUMODEL_POLE_IDL__
8 
9 #include <NumericSensor.idl>
10 #include <ResidualCurrentStateSensor.idl>
11 
12 /**
13  * PDU Model
14  */
15 module pdumodel {
16 
17  /** Power line */
18  enumeration PowerLine_2_0_0 {
19  L1, ///< Line 1
20  L2, ///< Line 2
21  L3, ///< Line 3
22  NEUTRAL, ///< Neutral
23  EARTH ///< Earth
24  };
25 
26  /** An inlet or outlet pole */
27  structure Pole_5_0_0 {
28  string label; ///< %Pole label
29  PowerLine_2_0_0 line; ///< Power line
30  int nodeId; ///< Circuit node id
31  sensors.NumericSensor_4_0_3 voltage; ///< RMS voltage sensor, L-L
32  sensors.NumericSensor_4_0_3 voltageLN; ///< RMS voltage sensor, L-N
33  sensors.NumericSensor_4_0_3 current; ///< RMS current sensor
34  sensors.NumericSensor_4_0_3 peakCurrent; ///< Peak current sensor
35  sensors.NumericSensor_4_0_3 activePower; ///< Active power sensor
36  sensors.NumericSensor_4_0_3 reactivePower; ///< Reactive power sensor
37  sensors.NumericSensor_4_0_3 apparentPower; ///< Apparent power sensor
38  sensors.NumericSensor_4_0_3 powerFactor; ///< Power factor sensor
39  sensors.NumericSensor_4_0_3 phaseAngle; ///< Phase angle sensor
40  sensors.NumericSensor_4_0_3 displacementPowerFactor; ///< Displacement power factor sensor
41  sensors.NumericSensor_4_0_3 activeEnergy; ///< Active energy sensor
42  sensors.NumericSensor_4_0_3 apparentEnergy; ///< Apparent energy sensor
43  sensors.NumericSensor_4_0_3 residualCurrent; ///< RMS current sensor
44  sensors.NumericSensor_4_0_3 residualDCCurrent; ///< DC Residual current sensor
45  sensors.NumericSensor_4_0_3 crestFactor; ///< Crest factor sensor
46  ResidualCurrentStateSensor_2_0_3 residualCurrentStatus; ///< Residual current monitor state sensor
47  };
48 
49  /** for OCP */
50  structure DoublePole_5_0_0 {
51  string label; ///< %Pole label
52  PowerLine_2_0_0 line; ///< Power line
53  int inNodeId; ///< Upstream (inlet-side) circuit node id
54  int outNodeId; ///< Downstream (outlet-side) circuit node id
55  sensors.NumericSensor_4_0_3 voltage; ///< RMS voltage sensor, L-L
56  sensors.NumericSensor_4_0_3 voltageLN; ///< RMS voltage sensor, L-N
57  sensors.NumericSensor_4_0_3 current; ///< RMS current sensor
58  sensors.NumericSensor_4_0_3 peakCurrent; ///< Peak current sensor
59  sensors.NumericSensor_4_0_3 activePower; ///< Active power sensor
60  sensors.NumericSensor_4_0_3 apparentPower; ///< Apparent power sensor
61  sensors.NumericSensor_4_0_3 powerFactor; ///< Power factor sensor
62  sensors.NumericSensor_4_0_3 activeEnergy; ///< Active energy sensor
63  sensors.NumericSensor_4_0_3 apparentEnergy; ///< Apparent energy sensor
64  };
65 
66  /** A pole that can select one of multiple inputs */
67  structure ThrowPole_2_0_0 {
68  string label; ///< %Pole label
69  PowerLine_2_0_0 line; ///< Power line
70  vector<int> inNodeIds; ///< Upstream node ids
71  int outNodeId; ///< Downstream node id
72  };
73 
74 }
75 
76 #endif
An inlet or outlet pole.
Definition: Pole.idl:27
sensors::NumericSensor_4_0_3 activeEnergy
Active energy sensor.
Definition: Pole.idl:62
Neutral.
Definition: Pole.idl:22
sensors::NumericSensor_4_0_3 current
RMS current sensor.
Definition: Pole.idl:33
sensors::NumericSensor_4_0_3 activeEnergy
Active energy sensor.
Definition: Pole.idl:41
int outNodeId
Downstream (outlet-side) circuit node id.
Definition: Pole.idl:54
sensors::NumericSensor_4_0_3 crestFactor
Crest factor sensor.
Definition: Pole.idl:45
sensors::NumericSensor_4_0_3 activePower
Active power sensor.
Definition: Pole.idl:35
sensors::NumericSensor_4_0_3 voltage
RMS voltage sensor, L-L.
Definition: Pole.idl:31
sensors::NumericSensor_4_0_3 voltageLN
RMS voltage sensor, L-N.
Definition: Pole.idl:32
string label
Pole label
Definition: Pole.idl:68
string label
Pole label
Definition: Pole.idl:28
PowerLine_2_0_0
Power line.
Definition: Pole.idl:18
sensors::NumericSensor_4_0_3 activePower
Active power sensor.
Definition: Pole.idl:59
Line 2.
Definition: Pole.idl:20
PowerLine_2_0_0 line
Power line.
Definition: Pole.idl:29
sensors::NumericSensor_4_0_3 apparentPower
Apparent power sensor.
Definition: Pole.idl:37
sensors::NumericSensor_4_0_3 phaseAngle
Phase angle sensor.
Definition: Pole.idl:39
sensors::NumericSensor_4_0_3 apparentEnergy
Apparent energy sensor.
Definition: Pole.idl:42
Line 3.
Definition: Pole.idl:21
Line 1.
Definition: Pole.idl:19
sensors::NumericSensor_4_0_3 residualDCCurrent
DC Residual current sensor.
Definition: Pole.idl:44
int nodeId
Circuit node id.
Definition: Pole.idl:30
Residual current state sensor interface.
Definition: ResidualCurrentStateSensor.idl:17
sensors::NumericSensor_4_0_3 displacementPowerFactor
Displacement power factor sensor.
Definition: Pole.idl:40
sensors::NumericSensor_4_0_3 voltageLN
RMS voltage sensor, L-N.
Definition: Pole.idl:56
PowerLine_2_0_0 line
Power line.
Definition: Pole.idl:69
sensors::NumericSensor_4_0_3 powerFactor
Power factor sensor.
Definition: Pole.idl:38
Earth.
Definition: Pole.idl:23
sensors::NumericSensor_4_0_3 peakCurrent
Peak current sensor.
Definition: Pole.idl:58
sensors::NumericSensor_4_0_3 powerFactor
Power factor sensor.
Definition: Pole.idl:61
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
sensors::NumericSensor_4_0_3 voltage
RMS voltage sensor, L-L.
Definition: Pole.idl:55
PDU Model.
Definition: Ade.idl:12
ResidualCurrentStateSensor_2_0_3 residualCurrentStatus
Residual current monitor state sensor.
Definition: Pole.idl:46
sensors::NumericSensor_4_0_3 current
RMS current sensor.
Definition: Pole.idl:57
A pole that can select one of multiple inputs.
Definition: Pole.idl:67
for OCP
Definition: Pole.idl:50
int outNodeId
Downstream node id.
Definition: Pole.idl:71
A sensor with numeric readings.
Definition: NumericSensor.idl:17
sensors::NumericSensor_4_0_3 peakCurrent
Peak current sensor.
Definition: Pole.idl:34
int inNodeId
Upstream (inlet-side) circuit node id.
Definition: Pole.idl:53
PowerLine_2_0_0 line
Power line.
Definition: Pole.idl:52
vector< int > inNodeIds
Upstream node ids.
Definition: Pole.idl:70
sensors::NumericSensor_4_0_3 apparentPower
Apparent power sensor.
Definition: Pole.idl:60
sensors::NumericSensor_4_0_3 apparentEnergy
Apparent energy sensor.
Definition: Pole.idl:63
sensors::NumericSensor_4_0_3 reactivePower
Reactive power sensor.
Definition: Pole.idl:36
string label
Pole label
Definition: Pole.idl:51
sensors::NumericSensor_4_0_3 residualCurrent
RMS current sensor.
Definition: Pole.idl:43