Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
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_3_1_1 {
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;
37  };
38 
40  structure Sensors {
41  vector<sensors.StateSensor_4_0_1> powerSupplyStatus;
42  sensors.NumericSensor_4_0_1 activePower;
43  sensors.NumericSensor_4_0_1 activeEnergy;
44  };
45 
47  structure Statistic {
48  vector<CircuitBreakerStatistic> cbStats;
49  vector<CtrlStatistic> ctrlStats;
50  vector<OutletStatistic> outletStats;
51  peripheral.DeviceManager_2_0_1.Statistics peripheralStats;
52  };
53 
55  enumeration StartupState {
58  SS_LASTKNOWN
59  };
60 
62  structure Settings {
63  string name;
65  int cycleDelay;
68  int powerOnDelay;
75  boolean latchingRelays;
76  };
77 
79  structure OutletSequenceState {
80  boolean sequenceRunning;
84  };
85 
87  valueobject SettingsChangedEvent extends event.UserEvent {
88  Settings oldSettings;
90  };
91 
93  valueobject LoadSheddingModeChangedEvent extends event.UserEvent {
94  boolean enabled;
95  };
96 
98  valueobject OutletSequenceStateChangedEvent extends idl.Event {
99  OutletSequenceState newState;
100  };
101 
107  Nameplate getNameplate();
108 
114  MetaData getMetaData();
115 
121  Sensors getSensors();
122 
128  sensors.Logger_2_1_3 getSensorLogger();
129 
135  vector<Controller_3_0_0> getControllers();
136 
142  vector<Outlet_1_5_7> getOutlets();
143 
149  vector<OverCurrentProtector_2_1_3> getOverCurrentProtectors();
150 
156  vector<Inlet_1_2_7> getInlets();
157 
162  vector<TransferSwitch_3_1_2> getTransferSwitches();
163 
169  peripheral.DeviceManager_2_0_1 getPeripheralDeviceManager();
170 
176  hmi.InternalBeeper_2_0_0 getBeeper();
177 
183  Settings getSettings();
184 
190  boolean isLoadSheddingActive();
191 
200  int setSettings(in Settings settings);
201 
207  void setLoadSheddingActive(in boolean active);
208 
218  vector<portsmodel.Port_2_0_1> getFeaturePorts();
219 
229  int enterRS485ConfigModeAndAssignCtrlBoardAddress(in int addr);
230 
243  int enterRS485ConfigModeAndAssignSCBoardAddress(in int deviceId, in int addr);
244 
250  int leaveRS485ConfigMode();
251 
260  int setAllOutletPowerStates(in Outlet_1_5_7.PowerState pstate);
261 
272  int setMultipleOutletPowerStates(in vector<int> outletNumbers,
273  in Outlet_1_5_7.PowerState state,
274  in boolean respectSequence);
275 
282  int cycleAllOutletPowerStates();
283 
293  int cycleMultipleOutletPowerStates(in vector<int> outletNumbers,
294  in boolean respectSequence);
295 
301  Statistic getStatistic();
302 
308  OutletSequenceState getOutletSequenceState();
309 
313  void cancelOutletSequence();
314 
315  };
316 
317 }
318 
319 #endif
boolean latchingRelays
If true, relays keep their state during power-cycling.
Definition: Pdu.idl:75
int nextOutletToSwitch
Number (zero-based) of the next outlet in the sequence.
Definition: Pdu.idl:81
PDU sensors.
Definition: Pdu.idl:40
vector< CtrlStatistic > ctrlStats
Slave controller statistics.
Definition: Pdu.idl:49
boolean hasMeteredOutlets
true if at least one outlet is metered
Definition: Pdu.idl:34
string ctrlBoardSerial
Main controller serial number.
Definition: Pdu.idl:29
Main PDU interface.
Definition: Pdu.idl:22
string name
User-defined name.
Definition: Pdu.idl:63
boolean isInlineMeter
true if all inlets have exactly one outlet
Definition: Pdu.idl:36
StartupState
Outlet power state on device startup
Definition: Pdu.idl:55
PDU metadata.
Definition: Pdu.idl:27
int timeUntilNextSwitch
Time in milliseconds before the next outlet is switched.
Definition: Pdu.idl:82
vector< CircuitBreakerStatistic > cbStats
Circuit breaker statistics.
Definition: Pdu.idl:48
peripheral DeviceManager_2_0_1 Statistics peripheralStats
Peripheral device statistics.
Definition: Pdu.idl:51
boolean hasLatchingOutletRelays
true if at least one outlet has a latching relay
Definition: Pdu.idl:35
string hwRevision
Hardware revision.
Definition: Pdu.idl:30
int inRushGuardDelay
Minimum delay in milliseconds between switching two outlets on.
Definition: Pdu.idl:66
Component nameplate information.
Definition: Nameplate.idl:17
StartupState startupState
Default outlet state on device startup; can be overriden per outlet.
Definition: Pdu.idl:64
Nameplate nameplate
Nameplate information
Definition: Pdu.idl:28
int cycleDelay
Default power-cycle interval in seconds; can be overriden per outlet.
Definition: Pdu.idl:65
PDU settings.
Definition: Pdu.idl:62
string fwRevision
Firmware revision.
Definition: Pdu.idl:31
Outlet sequencing status
Definition: Pdu.idl:79
Settings newSettings
Settings after change.
Definition: Pdu.idl:89
Outlet will be switched off
Definition: Pdu.idl:57
sensors NumericSensor_4_0_1 activePower
Active power sensor.
Definition: Pdu.idl:42
Outlet will be switched on
Definition: Pdu.idl:56
boolean hasSwitchableOutlets
true if at least one outlet is switchable
Definition: Pdu.idl:33
string macAddress
MAC address.
Definition: Pdu.idl:32
vector< OutletStatistic > outletStats
Outlet statistics
Definition: Pdu.idl:50
PDU statistics.
Definition: Pdu.idl:47
int outletsRemaining
Number of outlets remaining in the sequence.
Definition: Pdu.idl:83
vector< sensors.StateSensor_4_0_1 > powerSupplyStatus
Power supply fault status.
Definition: Pdu.idl:41
sensors NumericSensor_4_0_1 activeEnergy
Active energy sensor.
Definition: Pdu.idl:43
boolean sequenceRunning
true if an outlet sequence is currently running
Definition: Pdu.idl:80
vector< int > outletPowerStateSequence
The order in which multiple outlets should be switched.
Definition: Pdu.idl:67