Raritan PX2/PX3 JSON-RPC API
PowerMeter.idl
1 #ifndef __PDUMODEL_POWER_METER_IDL__
2 #define __PDUMODEL_POWER_METER_IDL__
3 
4 #include <Controller.idl>
5 #include <NumericSensor.idl>
6 #include <Pole.idl>
7 #include <StateSensor.idl>
8 #include <UserEvent.idl>
9 
13 module pdumodel {
14 
18  interface PowerMeter_1_1_2 {
19 
20  constant int ERR_INVALID_PARAM = 1;
21  constant int ERR_MODBUS_UNIT_IN_USE = 2;
22 
24  enumeration Type {
27  THREE_PHASE
28  };
29 
31  structure Config {
34  };
35 
41  Config getConfig();
42 
44  structure Sensors {
57  };
58 
64  Sensors getSensors();
65 
71  vector<Pole_4_0_1> getPoles();
72 
78  vector<Controller_4_0_0> getControllers();
79 
81  structure Settings {
82  string name;
88  };
89 
91  valueobject SettingsChangedEvent extends event.UserEvent {
92  Settings oldSettings;
94  };
95 
101  Settings getSettings();
102 
112  int setSettings(in Settings settings);
113 
116  boolean pulseEnabled;
117  vector<int> poles;
119  };
120 
122  valueobject EnergyPulseSettingsChangedEvent extends event.UserEvent {
123  EnergyPulseSettings oldSettings;
124  EnergyPulseSettings newSettings;
125  };
126 
132  EnergyPulseSettings getEnergyPulseSettings();
133 
142  int setEnergyPulseSettings(in EnergyPulseSettings settings);
143 
144  };
145 
146 }
147 
148 #endif
sensors::NumericSensor_4_0_2 reactivePower
Reactive power sensor.
Definition: PowerMeter.idl:49
A sensor with numeric readings.
Definition: NumericSensor.idl:12
sensors::NumericSensor_4_0_2 apparentPower
Apparent power sensor.
Definition: PowerMeter.idl:50
int powerMeterId
The meter board ID.
Definition: PowerMeter.idl:32
Sensor with discrete readings.
Definition: StateSensor.idl:38
string name
User-defined name.
Definition: PowerMeter.idl:82
sensors::NumericSensor_4_0_2 unbalancedCurrent
Current unbalance sensor.
Definition: PowerMeter.idl:55
Power meter settings.
Definition: PowerMeter.idl:81
sensors::NumericSensor_4_0_2 lineFrequency
Line AC frequency sensor.
Definition: PowerMeter.idl:46
int phaseCtRating
Phase current transformer rating in Amps (0 for none)
Definition: PowerMeter.idl:84
Single-phase meter (A)
Definition: PowerMeter.idl:25
sensors::NumericSensor_4_0_2 displacementPowerFactor
Displacement power factor sensor.
Definition: PowerMeter.idl:53
Energy LED pulse settings.
Definition: PowerMeter.idl:115
Power meter configuration.
Definition: PowerMeter.idl:31
int earthCtRating
P.E. current transformer rating in Amps (0 for none)
Definition: PowerMeter.idl:86
sensors::NumericSensor_4_0_2 activePower
Active power sensor.
Definition: PowerMeter.idl:48
sensors::StateSensor_4_0_2 powerQuality
Power quality sensor.
Definition: PowerMeter.idl:56
Split-phase meter (A, B)
Definition: PowerMeter.idl:26
Type
Power meter type.
Definition: PowerMeter.idl:24
sensors::NumericSensor_4_0_2 phaseAngle
Phase angle sensor.
Definition: PowerMeter.idl:52
Type type
Power meter type.
Definition: PowerMeter.idl:33
Power meter sensors.
Definition: PowerMeter.idl:44
int modbusUnitAddress
Modbus unit address (1..255, 0 to disable Modbus for this meter)
Definition: PowerMeter.idl:87
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
sensors::NumericSensor_4_0_2 powerFactor
Power factor sensor.
Definition: PowerMeter.idl:51
PDU Model.
Definition: Ade.idl:7
A three-phase power meter (PMC).
Definition: PowerMeter.idl:18
sensors::NumericSensor_4_0_2 activeEnergy
Active energy sensor.
Definition: PowerMeter.idl:54
int currentRating
Current rating in Amps.
Definition: PowerMeter.idl:83
int neutralCtRating
Neutral current transformer rating in Amps (0 for none)
Definition: PowerMeter.idl:85
boolean pulseEnabled
true to enable the energy LED pulse
Definition: PowerMeter.idl:116
int pulsesPerKWh
Number of LED pulses per kWh of energy.
Definition: PowerMeter.idl:118
sensors::NumericSensor_4_0_2 voltage
RMS voltage sensor.
Definition: PowerMeter.idl:45
vector< int > poles
Emit pulses for energy counted on any of these poles.
Definition: PowerMeter.idl:117
Settings newSettings
Settings after change.
Definition: PowerMeter.idl:93
sensors::NumericSensor_4_0_2 current
RMS current sensor.
Definition: PowerMeter.idl:47