Raritan PX2/PX3 JSON-RPC API
|
6 #ifndef __PDUMODEL_OUTLET_IDL__
7 #define __PDUMODEL_OUTLET_IDL__
9 #include <Nameplate.idl>
10 #include <NumericSensor.idl>
11 #include <StateSensor.idl>
14 #include <OverCurrentProtector.idl>
15 #include <Controller.idl>
31 constant
int ERR_OUTLET_NOT_SWITCHABLE = 1;
32 constant
int ERR_LOAD_SHEDDING_ACTIVE = 2;
33 constant
int ERR_OUTLET_DISABLED = 3;
34 constant
int ERR_OUTLET_NOT_OFF = 4;
36 constant
int ERR_INVALID_PARAM = 1;
117 valueobject PowerControlEvent extends
event.UserEvent {
123 valueobject StateChangedEvent extends
idl.Event {
129 valueobject SettingsChangedEvent extends
event.UserEvent {
@ SS_LASTKNOWN
Last known power state will be restored.
Definition: Outlet.idl:82
Outlet sensors
Definition: Outlet.idl:97
Controller_4_0_1 getController()
Get the controller for this outlet.
sensors::NumericSensor_4_0_4 unbalancedCurrent
Current unbalance sensor.
Definition: Outlet.idl:102
sensors::NumericSensor_4_0_4 voltage
RMS voltage sensor.
Definition: Outlet.idl:98
int relayCycleCnt
Relay switch count.
Definition: Outlet.idl:24
Settings newSettings
Settings after change.
Definition: Outlet.idl:131
sensors::NumericSensor_4_0_4 powerFactor
Power factor sensor.
Definition: Outlet.idl:106
string name
User-defined name.
Definition: Outlet.idl:88
int cycleDelay
Outlet-specific power-cycle delay
Definition: Outlet.idl:91
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
boolean isLoadShed
true if the outlet is currently switched off due to being non-critical and load shedding being active
Definition: Outlet.idl:72
StartupState
Outlet power state on device startup
Definition: Outlet.idl:79
@ SS_ON
Outlet will be switched on
Definition: Outlet.idl:80
Numerical usage ratings.
Definition: Nameplate.idl:15
boolean switchOnInProgress
true if the outlet is pending to be switched on after the sequencing delay has passed.
Definition: Outlet.idl:68
LedState ledState
LED state.
Definition: Outlet.idl:74
int unstick()
Trigger an attempt to un-stick sticking relay contacts.
State newState
State after change.
Definition: Outlet.idl:125
int setSettings(in Settings settings)
Change the outlet settings.
boolean available
powerState is available
Definition: Outlet.idl:64
@ PS_OFF
Switch off / Power is off.
Definition: Outlet.idl:51
Outlet settings
Definition: Outlet.idl:87
boolean cycleInProgress
if a power-cycle is in progress.
Definition: Outlet.idl:70
sensors::NumericSensor_4_0_4 displacementPowerFactor
Displacement power factor sensor.
Definition: Outlet.idl:107
sensors::NumericSensor_4_0_4 current
RMS current sensor.
Definition: Outlet.idl:99
@ SS_OFF
Outlet will be switched off
Definition: Outlet.idl:81
sensors::NumericSensor_4_0_4 apparentPower
Apparent power sensor.
Definition: Outlet.idl:105
int setPowerState(in PowerState pstate)
Switch the outlet.
PDU Model.
Definition: Ade.idl:12
int sequenceDelay
Delay in ms after this outlet when switching multiple outlets on.
Definition: Outlet.idl:93
Sensor with discrete readings.
Definition: StateSensor.idl:43
sensors::NumericSensor_4_0_4 phaseAngle
Phase angle sensor.
Definition: Outlet.idl:110
int relayFailCnt
Relay failure count.
Definition: Outlet.idl:25
sensors::NumericSensor_4_0_4 apparentEnergy
Apparent energy sensor.
Definition: Outlet.idl:109
Overcurrent protector interface.
Definition: OverCurrentProtector.idl:26
Basic IDL definitions.
Definition: Event.idl:10
Component nameplate information.
Definition: Nameplate.idl:23
boolean green
true if the green LED is enabled
Definition: Outlet.idl:58
Outlet LED state
Definition: Outlet.idl:56
Settings getSettings()
Retrieve the outlet settings.
sensors::NumericSensor_4_0_4 activeEnergy
Active energy sensor.
Definition: Outlet.idl:108
sensors::NumericSensor_4_0_4 activePower
Active power sensor.
Definition: Outlet.idl:103
MetaData getMetaData()
Retrieve the outlet metadata.
sensors::NumericSensor_4_0_4 maximumCurrent
Maximum current sensor.
Definition: Outlet.idl:101
PowerState
Outlet power state.
Definition: Outlet.idl:50
boolean red
true if the red LED is enabled
Definition: Outlet.idl:57
Sensors getSensors()
Get the outlet sensors.
StartupState startupState
Power state on device startup.
Definition: Outlet.idl:89
int cyclePowerState()
Power-cycle the outlet.
boolean cycle
Whether the outlet was cycled.
Definition: Outlet.idl:119
time lastPowerStateChange
Time of last power state change (UNIX timestamp, UTC)
Definition: Outlet.idl:75
sensors::NumericSensor_4_0_4 lineFrequency
AC line frequency sensor.
Definition: Outlet.idl:111
void getIOP(out Inlet_2_0_6 i, out OverCurrentProtector_3_0_6 o, out vector< Pole_7_0_0 > p)
Get inlet, overcurrent protector and poles.
A sensor with numeric readings.
Definition: NumericSensor.idl:17
Inlet interface
Definition: Inlet.idl:22
boolean nonCritical
true if outlet is non-critical (for load shedding)
Definition: Outlet.idl:92
sensors::NumericSensor_4_0_4 peakCurrent
Peak current sensor.
Definition: Outlet.idl:100
Outlet statistics
Definition: Outlet.idl:23
boolean usePduCycleDelay
true to use power-cycle delay as defined in PDU settings
Definition: Outlet.idl:90
sensors::NumericSensor_4_0_4 crestFactor
Crest factor sensor.
Definition: Outlet.idl:112
sensors::StateSensor_4_0_4 outletState
Outlet power state sensor
Definition: Outlet.idl:113
sensors::NumericSensor_4_0_4 reactivePower
Reactive power sensor.
Definition: Outlet.idl:104
Common base interface for any kind of electrical device that is used in the PDU model,...
Definition: EDevice.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:65
State getState()
Retrieve the outlet state.
Slave controller interface.
Definition: Controller.idl:26
Outlet state
Definition: Outlet.idl:63
boolean blinking
true if the LED is blinking
Definition: Outlet.idl:59
Outlet interface
Definition: Outlet.idl:29