Raritan PX2/PX3 JSON-RPC API
Circuit.idl
1 #ifndef __PDUMODEL_CIRCUIT_IDL__
2 #define __PDUMODEL_CIRCUIT_IDL__
3 
4 #include <NumericSensor.idl>
5 #include <Pole.idl>
6 #include <UserEvent.idl>
7 
11 module pdumodel {
12 
16  interface Circuit_1_0_1 {
17 
18  constant int ERR_INVALID_PARAM = 1;
19  constant int ERR_METER_CHANNEL_BUSY = 2;
20 
22  enumeration Type {
26  THREE_PHASE
27  };
28 
30  structure Config {
31  int position;
33  };
34 
40  Config getConfig();
41 
43  structure Sensors {
53  };
54 
60  Sensors getSensors();
61 
67  vector<Pole_4_0_1> getPoles();
68 
70  structure PoleSettings {
71  pdumodel.PowerLine_2_0_0 line;
73  };
74 
76  structure Settings {
77  string name;
78  int rating;
79  int ctRating;
80  vector<PoleSettings> poleSettings;
81  };
82 
84  valueobject SettingsChangedEvent extends event.UserEvent {
85  Settings oldSettings;
87  };
88 
94  Settings getSettings();
95 
105  int setSettings(in Settings settings);
106 
107  };
108 
109 }
110 
111 #endif
A sensor with numeric readings.
Definition: NumericSensor.idl:12
sensors::NumericSensor_4_0_2 phaseAngle
Phase angle sensor.
Definition: Circuit.idl:49
vector< PoleSettings > poleSettings
Pole settings (excluding Neutral)
Definition: Circuit.idl:80
One-phase line-line.
Definition: Circuit.idl:24
BCM circuit.
Definition: Circuit.idl:16
string name
Circuit name.
Definition: Circuit.idl:77
sensors::NumericSensor_4_0_2 activePower
Active power sensor.
Definition: Circuit.idl:45
sensors::NumericSensor_4_0_2 reactivePower
Reactive power sensor.
Definition: Circuit.idl:46
int meterChannel
Meter channel index; -1 for unmetered poles.
Definition: Circuit.idl:72
Type
Circuit type.
Definition: Circuit.idl:22
int ctRating
Current transformer rating.
Definition: Circuit.idl:79
sensors::NumericSensor_4_0_2 current
RMS current sensor.
Definition: Circuit.idl:44
One-phase line-neutral.
Definition: Circuit.idl:23
Circuit configuration.
Definition: Circuit.idl:30
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
Circuit pole settings.
Definition: Circuit.idl:70
sensors::NumericSensor_4_0_2 unbalancedCurrent
Current unbalance sensor.
Definition: Circuit.idl:52
PDU Model.
Definition: Ade.idl:7
Circuit sensors.
Definition: Circuit.idl:43
One-phase line-line-neutral.
Definition: Circuit.idl:25
int rating
Circuit current rating.
Definition: Circuit.idl:78
Settings newSettings
Settings after change.
Definition: Circuit.idl:86
pdumodel::PowerLine_2_0_0 line
Power line.
Definition: Circuit.idl:71
sensors::NumericSensor_4_0_2 apparentPower
Apparent power sensor.
Definition: Circuit.idl:47
int position
Circuit position of first pole.
Definition: Circuit.idl:31
sensors::NumericSensor_4_0_2 powerFactor
Power factor sensor.
Definition: Circuit.idl:48
Circuit settings.
Definition: Circuit.idl:76
sensors::NumericSensor_4_0_2 displacementPowerFactor
Displacement power factor.
Definition: Circuit.idl:50
Type type
Circuit type.
Definition: Circuit.idl:32
sensors::NumericSensor_4_0_2 activeEnergy
Active energy sensor.
Definition: Circuit.idl:51