Raritan PX2/PX3 JSON-RPC API
Pdu.idl
1 #ifndef __PDUMODEL_PDU_IDL__
2 #define __PDUMODEL_PDU_IDL__
3 
4 #include <Nameplate.idl>
5 #include <Outlet.idl>
6 #include <PeripheralDeviceManager.idl>
7 #include <Port.idl>
8 #include <OverCurrentProtector.idl>
9 #include <Inlet.idl>
10 #include <TransferSwitch.idl>
11 #include <StateSensor.idl>
12 #include <SensorLogger.idl>
13 #include <Controller.idl>
14 #include <InternalBeeper.idl>
15 
19 module pdumodel {
20 
22  interface Pdu_4_1_2 {
23 
24  constant int ERR_INVALID_PARAM = 1;
25 
27  structure MetaData {
29  string ctrlBoardSerial;
30  string hwRevision;
31  string fwRevision;
32  string macAddress;
36  boolean isInlineMeter;
38  };
40 
42  structure Sensors {
46  };
47 
49  structure Statistic {
50  vector<CircuitBreakerStatistic> cbStats;
51  vector<CtrlStatistic> ctrlStats;
52  vector<OutletStatistic> outletStats;
54  };
55 
57  enumeration StartupState {
60  SS_LASTKNOWN
61  };
62 
64  structure Settings {
65  string name;
67  int cycleDelay;
70  int powerOnDelay;
77  boolean latchingRelays;
80  };
81 
83  structure OutletSequenceState {
84  boolean sequenceRunning;
88  };
89 
91  valueobject SettingsChangedEvent extends event.UserEvent {
92  Settings oldSettings;
94  };
95 
97  valueobject LoadSheddingModeChangedEvent extends event.UserEvent {
98  boolean enabled;
99  };
100 
102  valueobject OutletSequenceStateChangedEvent extends idl.Event {
103  OutletSequenceState newState;
104  };
105 
111  Nameplate getNameplate();
112 
118  MetaData getMetaData();
119 
125  Sensors getSensors();
126 
132  sensors.Logger_2_1_5 getSensorLogger();
133 
139  vector<Controller_4_0_0> getControllers();
140 
146  vector<Outlet_2_1_1> getOutlets();
147 
153  vector<OverCurrentProtector_3_0_1> getOverCurrentProtectors();
154 
160  vector<Inlet_2_0_1> getInlets();
161 
166  vector<TransferSwitch_4_0_2> getTransferSwitches();
167 
173  peripheral.DeviceManager_3_0_0 getPeripheralDeviceManager();
174 
180  hmi.InternalBeeper_2_0_0 getBeeper();
181 
187  Settings getSettings();
188 
194  boolean isLoadSheddingActive();
195 
204  int setSettings(in Settings settings);
205 
211  void setLoadSheddingActive(in boolean active);
212 
222  vector<portsmodel.Port_2_0_1> getFeaturePorts();
223 
233  int enterRS485ConfigModeAndAssignCtrlBoardAddress(in int addr);
234 
247  int enterRS485ConfigModeAndAssignSCBoardAddress(in int deviceId, in int addr);
248 
254  int leaveRS485ConfigMode();
255 
263  int setAllOutletPowerStates(in Outlet_2_1_1.PowerState pstate);
264 
275  int setMultipleOutletPowerStates(in vector<int> outletNumbers,
276  in Outlet_2_1_1.PowerState state,
277  in boolean respectSequence);
278 
284  int cycleAllOutletPowerStates();
285 
295  int cycleMultipleOutletPowerStates(in vector<int> outletNumbers,
296  in boolean respectSequence);
297 
303  Statistic getStatistic();
304 
310  OutletSequenceState getOutletSequenceState();
311 
315  void cancelOutletSequence();
316 
317  };
318 
319 }
320 
321 #endif
peripheral::DeviceManager_3_0_0 Statistics peripheralStats
Peripheral device statistics.
Definition: Pdu.idl:53
A sensor with numeric readings.
Definition: NumericSensor.idl:12
boolean isEnergyPulseSupported
true if the PDU has one or more LED(s) capable of emitting pulses to measure consumed energy ...
Definition: Pdu.idl:37
string name
User-defined name.
Definition: Pdu.idl:65
Sensor with discrete readings.
Definition: StateSensor.idl:38
string macAddress
MAC address.
Definition: Pdu.idl:32
Outlet sequencing status
Definition: Pdu.idl:83
PDU statistics.
Definition: Pdu.idl:49
int outletsRemaining
Number of outlets remaining in the sequence.
Definition: Pdu.idl:87
sensors::NumericSensor_4_0_2 activeEnergy
Active energy sensor.
Definition: Pdu.idl:45
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:11
boolean hasLatchingOutletRelays
true if at least one outlet has a latching relay
Definition: Pdu.idl:35
boolean sequenceRunning
true if an outlet sequence is currently running
Definition: Pdu.idl:84
Peripheral device statistics.
Definition: PeripheralDeviceManager.idl:115
string ctrlBoardSerial
Main controller serial number.
Definition: Pdu.idl:29
vector< int > outletPowerStateSequence
The order in which multiple outlets should be switched.
Definition: Pdu.idl:69
Outlet will be switched on
Definition: Pdu.idl:58
boolean energyPulseEnabled
Enables energy consumption counting using the PDU&#39;s LED(s)
Definition: Pdu.idl:78
boolean isInlineMeter
true if all inlets have exactly one outlet
Definition: Pdu.idl:36
sensors::NumericSensor_4_0_2 activePower
Active power sensor.
Definition: Pdu.idl:44
vector< OutletStatistic > outletStats
Outlet statistics
Definition: Pdu.idl:52
int inRushGuardDelay
Minimum delay in milliseconds between switching two outlets on.
Definition: Pdu.idl:68
Outlet will be switched off
Definition: Pdu.idl:59
boolean latchingRelays
If true, relays keep their state during power-cycling.
Definition: Pdu.idl:77
int energyPulsesPerKWh
Ratio between LED pulses and energy consumption.
Definition: Pdu.idl:79
Peripheral Device Manager.
Definition: PeripheralDeviceManager.idl:14
Basic IDL definitions.
Definition: Event.idl:6
vector< CtrlStatistic > ctrlStats
Slave controller statistics.
Definition: Pdu.idl:51
PDU sensors.
Definition: Pdu.idl:42
int nextOutletToSwitch
Number (zero-based) of the next outlet in the sequence.
Definition: Pdu.idl:85
Component nameplate information.
Definition: Nameplate.idl:17
Sensor logger interface.
Definition: SensorLogger.idl:16
StartupState
Outlet power state on device startup
Definition: Pdu.idl:57
Ports.
Definition: Port.idl:9
Human Machine Interface.
Definition: ExternalBeeper.idl:9
Main PDU interface.
Definition: Pdu.idl:22
boolean hasMeteredOutlets
true if at least one outlet is metered
Definition: Pdu.idl:34
StartupState startupState
Default outlet state on device startup; can be overriden per outlet.
Definition: Pdu.idl:66
string fwRevision
Firmware revision.
Definition: Pdu.idl:31
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
PDU Model.
Definition: Ade.idl:7
Port interface.
Definition: Port.idl:12
vector< CircuitBreakerStatistic > cbStats
Circuit breaker statistics.
Definition: Pdu.idl:50
int cycleDelay
Default power-cycle interval in seconds; can be overriden per outlet.
Definition: Pdu.idl:67
int timeUntilNextSwitch
Time in milliseconds before the next outlet is switched.
Definition: Pdu.idl:86
boolean hasSwitchableOutlets
true if at least one outlet is switchable
Definition: Pdu.idl:33
PowerState
Outlet power state.
Definition: Outlet.idl:45
vector< sensors::StateSensor_4_0_2 > powerSupplyStatus
Power supply fault status.
Definition: Pdu.idl:43
Settings newSettings
Settings after change.
Definition: Pdu.idl:93
PDU settings.
Definition: Pdu.idl:64
Nameplate nameplate
Nameplate information
Definition: Pdu.idl:28
string hwRevision
Hardware revision.
Definition: Pdu.idl:30
Internal beeper interface.
Definition: InternalBeeper.idl:10
PDU metadata.
Definition: Pdu.idl:27
Outlet interface
Definition: Outlet.idl:24