Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Outlet.idl
1 #ifndef __PDUMODEL_OUTLET_IDL__
2 #define __PDUMODEL_OUTLET_IDL__
3 
4 #include <Nameplate.idl>
5 #include <NumericSensor.idl>
6 #include <StateSensor.idl>
7 #include <Pole.idl>
8 #include <Inlet.idl>
9 #include <OverCurrentProtector.idl>
10 #include <Controller.idl>
11 
15 module pdumodel {
16 
18  structure OutletStatistic {
21  };
22 
24  interface Outlet_1_5_7 extends EDevice {
25 
26  constant int ERR_OUTLET_NOT_SWITCHABLE = 1;
27  constant int ERR_LOAD_SHEDDING_ACTIVE = 2;
28  constant int ERR_OUTLET_DISABLED = 3;
29  constant int ERR_OUTLET_NOT_OFF = 4;
30 
31  constant int ERR_INVALID_PARAM = 1;
32 
34  structure MetaData {
35  string label;
36  string receptacleType;
39  boolean isSwitchable;
40  boolean isLatching;
42  };
43 
45  enumeration PowerState {
47  PS_ON
48  };
49 
51  structure LedState {
52  boolean red;
53  boolean green;
54  boolean blinking;
55  };
56 
58  structure State {
59  boolean available;
61  boolean switchOnInProgress;
64  boolean cycleInProgress;
66  LedState ledState;
69  };
70 
72  enumeration StartupState {
76  SS_PDUDEF
77  };
78 
80  structure Settings {
81  string name;
83  boolean usePduCycleDelay;
84  int cycleDelay;
85  boolean nonCritical;
87  };
88 
90  structure Sensors {
91  sensors.NumericSensor_4_0_1 voltage;
92  sensors.NumericSensor_4_0_1 current;
93  sensors.NumericSensor_4_0_1 peakCurrent;
94  sensors.NumericSensor_4_0_1 maximumCurrent;
95  sensors.NumericSensor_4_0_1 unbalancedCurrent;
96  sensors.NumericSensor_4_0_1 activePower;
97  sensors.NumericSensor_4_0_1 apparentPower;
98  sensors.NumericSensor_4_0_1 powerFactor;
99  sensors.NumericSensor_4_0_1 activeEnergy;
100  sensors.NumericSensor_4_0_1 apparentEnergy;
101  sensors.NumericSensor_4_0_1 phaseAngle;
102  sensors.NumericSensor_4_0_1 lineFrequency;
103  sensors.StateSensor_4_0_1 outletState;
104  };
105 
107  valueobject PowerControlEvent extends event.UserEvent {
108  PowerState state;
109  boolean cycle;
110  };
111 
113  valueobject StateChangedEvent extends idl.Event {
114  State oldState;
116  };
117 
119  valueobject SettingsChangedEvent extends event.UserEvent {
120  Settings oldSettings;
122  };
123 
129  MetaData getMetaData();
130 
136  Sensors getSensors();
137 
143  State getState();
144 
155  int setPowerState(in PowerState pstate);
156 
165  int cyclePowerState();
166 
172  Settings getSettings();
173 
182  int setSettings(in Settings settings);
183 
191  void getIOP(out Inlet_1_2_7 i, out OverCurrentProtector_2_1_3 o, out vector<Pole_3_0_0> p);
192 
198  Controller_3_0_0 getController();
199 
213  int unstick();
214  };
215 
216 }
217 
218 #endif
int maxRelayCycleCnt
Maximum relay cycle count.
Definition: Outlet.idl:41
Slave controller interface.
Definition: Controller.idl:21
Numerical usage ratings.
Definition: Nameplate.idl:10
string name
User-defined name.
Definition: Outlet.idl:81
boolean green
true if the green LED is enabled
Definition: Outlet.idl:53
sensors NumericSensor_4_0_1 lineFrequency
AC line frequency sensor.
Definition: Outlet.idl:102
Outlet sensors
Definition: Outlet.idl:90
boolean isLatching
true if the outlet is able to keep its state after power loss
Definition: Outlet.idl:40
Outlet metadata
Definition: Outlet.idl:34
boolean cycle
Whether the outlet was cycled.
Definition: Outlet.idl:109
Rating rating
Numerical usage ratings.
Definition: Outlet.idl:38
int relayFailCnt
Relay failure count.
Definition: Outlet.idl:20
sensors NumericSensor_4_0_1 maximumCurrent
Maximum current sensor.
Definition: Outlet.idl:94
Common base interface for any kind of electrical device that is used in the PDU model, such as inlets, OCPs and outlets.
Definition: EDevice.idl:19
sensors NumericSensor_4_0_1 current
RMS current sensor.
Definition: Outlet.idl:92
sensors NumericSensor_4_0_1 activeEnergy
Active energy sensor.
Definition: Outlet.idl:99
Outlet interface
Definition: Outlet.idl:24
PowerState powerState
Current power state of outlet (represented by the control state of the relay, which was set by the la...
Definition: Outlet.idl:60
time lastPowerStateChange
Time of last power state change.
Definition: Outlet.idl:68
Outlet LED state
Definition: Outlet.idl:51
string receptacleType
Receptacle type.
Definition: Outlet.idl:36
int sequenceDelay
Delay in ms after this outlet when switching multiple outlets on.
Definition: Outlet.idl:86
sensors NumericSensor_4_0_1 powerFactor
Power factor sensor.
Definition: Outlet.idl:98
Outlet will be switched off
Definition: Outlet.idl:74
Outlet state
Definition: Outlet.idl:58
Overcurrent protector interface.
Definition: OverCurrentProtector.idl:21
Component nameplate information.
Definition: Nameplate.idl:17
string label
Outlet label
Definition: Outlet.idl:35
Outlet statistics
Definition: Outlet.idl:18
sensors NumericSensor_4_0_1 peakCurrent
Peak current sensor.
Definition: Outlet.idl:93
sensors NumericSensor_4_0_1 phaseAngle
Phase angle sensor.
Definition: Outlet.idl:101
sensors StateSensor_4_0_1 outletState
Outlet power state sensor
Definition: Outlet.idl:103
Switch off / Power is off.
Definition: Outlet.idl:46
State newState
State after change.
Definition: Outlet.idl:115
StartupState startupState
Power state on device startup.
Definition: Outlet.idl:82
Last known power state will be restored.
Definition: Outlet.idl:75
Settings newSettings
Settings after change.
Definition: Outlet.idl:121
Outlet settings
Definition: Outlet.idl:80
sensors NumericSensor_4_0_1 activePower
Active power sensor.
Definition: Outlet.idl:96
boolean usePduCycleDelay
true to use power-cycle delay as defined in PDU settings
Definition: Outlet.idl:83
boolean red
true if the red LED is enabled
Definition: Outlet.idl:52
boolean available
powerState is available
Definition: Outlet.idl:59
boolean blinking
true if the LED is blinking
Definition: Outlet.idl:54
sensors NumericSensor_4_0_1 apparentEnergy
Apparent energy sensor.
Definition: Outlet.idl:100
sensors NumericSensor_4_0_1 voltage
RMS voltage sensor.
Definition: Outlet.idl:91
Outlet will be switched on
Definition: Outlet.idl:73
sensors NumericSensor_4_0_1 apparentPower
Apparent power sensor.
Definition: Outlet.idl:97
int cycleDelay
Outlet-specific power-cycle delay
Definition: Outlet.idl:84
PowerState
Outlet power state.
Definition: Outlet.idl:45
boolean nonCritical
true if outlet is non-critical (for load shedding)
Definition: Outlet.idl:85
StartupState
Outlet power state on device startup
Definition: Outlet.idl:72
boolean isSwitchable
true if the outlet is switchable
Definition: Outlet.idl:39
Inlet interface
Definition: Inlet.idl:17
Nameplate namePlate
Nameplate information
Definition: Outlet.idl:37
sensors NumericSensor_4_0_1 unbalancedCurrent
Current unbalance sensor.
Definition: Outlet.idl:95
int relayCycleCnt
Relay switch count.
Definition: Outlet.idl:19