Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
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 {
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 {
45  sensors.NumericSensor_4_0_1 voltage;
46  sensors.NumericSensor_4_0_1 lineFrequency;
47  sensors.NumericSensor_4_0_1 current;
48  sensors.NumericSensor_4_0_1 activePower;
49  sensors.NumericSensor_4_0_1 reactivePower;
50  sensors.NumericSensor_4_0_1 apparentPower;
51  sensors.NumericSensor_4_0_1 powerFactor;
52  sensors.NumericSensor_4_0_1 phaseAngle;
53  sensors.NumericSensor_4_0_1 displacementPowerFactor;
54  sensors.NumericSensor_4_0_1 activeEnergy;
55  sensors.NumericSensor_4_0_1 unbalancedCurrent;
56  sensors.StateSensor_4_0_1 powerQuality;
57  };
58 
64  Sensors getSensors();
65 
71  vector<Pole_4_0_0> getPoles();
72 
78  vector<Controller_3_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 
114  };
115 
116 }
117 
118 #endif
sensors::NumericSensor_4_0_1 activePower
Active power sensor.
Definition: PowerMeter.idl:48
int earthCtRating
P.E. current transformer rating in Amps (0 for none)
Definition: PowerMeter.idl:86
sensors::NumericSensor_4_0_1 phaseAngle
Phase angle sensor.
Definition: PowerMeter.idl:52
sensors::NumericSensor_4_0_1 lineFrequency
Line AC frequency sensor.
Definition: PowerMeter.idl:46
sensors::NumericSensor_4_0_1 powerFactor
Power factor sensor.
Definition: PowerMeter.idl:51
sensors::NumericSensor_4_0_1 apparentPower
Apparent power sensor.
Definition: PowerMeter.idl:50
sensors::StateSensor_4_0_1 powerQuality
Power quality sensor.
Definition: PowerMeter.idl:56
int currentRating
Current rating in Amps.
Definition: PowerMeter.idl:83
sensors::NumericSensor_4_0_1 activeEnergy
Active energy sensor.
Definition: PowerMeter.idl:54
Settings newSettings
Settings after change.
Definition: PowerMeter.idl:93
A three-phase power meter (PMC).
Definition: PowerMeter.idl:18
sensors::NumericSensor_4_0_1 displacementPowerFactor
Displacement power factor sensor.
Definition: PowerMeter.idl:53
sensors::NumericSensor_4_0_1 unbalancedCurrent
Current unbalance sensor.
Definition: PowerMeter.idl:55
sensors::NumericSensor_4_0_1 reactivePower
Reactive power sensor.
Definition: PowerMeter.idl:49
Power meter sensors.
Definition: PowerMeter.idl:44
int phaseCtRating
Phase current transformer rating in Amps (0 for none)
Definition: PowerMeter.idl:84
sensors::NumericSensor_4_0_1 voltage
RMS voltage sensor.
Definition: PowerMeter.idl:45
Power meter settings.
Definition: PowerMeter.idl:81
int neutralCtRating
Neutral current transformer rating in Amps (0 for none)
Definition: PowerMeter.idl:85
Power meter configuration.
Definition: PowerMeter.idl:31
Type
Power meter type.
Definition: PowerMeter.idl:24
Single-phase meter (A)
Definition: PowerMeter.idl:25
int modbusUnitAddress
Modbus unit address (1..255, 0 to disable Modbus for this meter)
Definition: PowerMeter.idl:87
Type type
Power meter type.
Definition: PowerMeter.idl:33
sensors::NumericSensor_4_0_1 current
RMS current sensor.
Definition: PowerMeter.idl:47
int powerMeterId
The meter board ID.
Definition: PowerMeter.idl:32
Split-phase meter (A, B)
Definition: PowerMeter.idl:26
string name
User-defined name.
Definition: PowerMeter.idl:82