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>
16#include <Waveform.idl>
32 constant
int ERR_OUTLET_NOT_SWITCHABLE = 1;
33 constant
int ERR_LOAD_SHEDDING_ACTIVE = 2;
34 constant
int ERR_OUTLET_DISABLED = 3;
35 constant
int ERR_OUTLET_NOT_OFF = 4;
36 constant
int ERR_RELAY_CONTROL_DISABLED = 5;
38 constant
int ERR_INVALID_PARAM = 1;
40 constant
int ERR_OPERATION_UNSUPPORTED = 1;
Sub controller interface.
Common base interface for any kind of electrical device that is used in the PDU model,...
State getState()
Retrieve the outlet state.
int setSettings(in Settings settings)
Change the outlet settings.
PowerState
Outlet power state.
@ PS_OFF
Switch off / Power is off.
int setPowerState(in PowerState pstate)
Switch the outlet.
Controller getController()
Get the controller for this outlet.
MetaData getMetaData()
Retrieve the outlet metadata.
int setServiceModeEnabled(in boolean enabled)
Enable or disable service mode on this outlet.
int unstick()
Trigger an attempt to un-stick sticking relay contacts.
Settings getSettings()
Retrieve the outlet settings.
int cyclePowerState()
Power-cycle the outlet.
StartupState
Outlet power state on device startup
@ SS_LASTKNOWN
Last known power state will be restored.
@ SS_OFF
Outlet will be switched off
@ SS_ON
Outlet will be switched on
Sensors getSensors()
Get the outlet sensors.
Waveform getInrushWaveform()
Get the voltage and current waveforms at the time of last switch on operation.
void getIOP(out Inlet i, out OverCurrentProtector o, out vector< Pole > p)
Get inlet, overcurrent protector and poles.
Overcurrent protector interface.
A sensor with numeric readings.
Sensor with discrete readings.
Common base for all events.
Component nameplate information.
int relayFailCnt
Relay failure count.
int relayCycleCnt
Relay switch count.
boolean green
true if the green LED is enabled
boolean blinking
true if the LED is blinking
boolean red
true if the red LED is enabled
Event: Power control was initiated.
boolean cycle
Whether the outlet was cycled.
PowerState state
State the outlet was switched to (if cycle is false)
sensors::NumericSensor activeEnergy
Active energy sensor.
sensors::NumericSensor powerFactor
Power factor sensor.
sensors::NumericSensor voltage
RMS voltage sensor (may be a VoltageMonitoringSensor)
sensors::NumericSensor peakCurrent
Peak current sensor.
sensors::NumericSensor phaseAngle
Phase angle sensor.
sensors::NumericSensor lineFrequency
AC line frequency sensor.
sensors::NumericSensor activePower
Active power sensor.
sensors::NumericSensor current
RMS current sensor.
sensors::NumericSensor crestFactor
Crest factor sensor.
sensors::NumericSensor inrushCurrent
In-rush current occuring after turning outlet on.
sensors::NumericSensor displacementPowerFactor
Displacement power factor sensor.
sensors::NumericSensor voltageThd
Voltage total harmonic distortion sensor.
sensors::NumericSensor apparentPower
Apparent power sensor.
sensors::NumericSensor apparentEnergy
Apparent energy sensor.
sensors::NumericSensor unbalancedCurrent
Current unbalance sensor.
sensors::StateSensor outletState
Outlet power state sensor
sensors::NumericSensor maximumCurrent
Maximum current sensor.
sensors::NumericSensor reactivePower
Reactive power sensor.
sensors::NumericSensor currentThd
Current total harmonic distortion sensor.
Event: Service mode has been changed.
boolean enabled
Whether service mode is enabled after the change.
Event: Outlet settings have been changed.
Settings newSettings
Settings after change.
Settings oldSettings
Settings before change.
string name
User-defined name.
StartupState startupState
Power state after power is applied to the outlet.
boolean nonCritical
true if outlet is non-critical (for load shedding)
int cycleDelay
Outlet-specific power-cycle delay
int sequenceDelay
Delay in ms after this outlet when switching multiple outlets on.
boolean usePduCycleDelay
true to use power-cycle delay as defined in PDU settings
Event: Outlet state has changed.
State newState
State after change.
State oldState
State before change.
boolean isLoadShed
true if the outlet is currently switched off due to being non-critical and load shedding being active
boolean cycleInProgress
if a power-cycle is in progress.
boolean hasInrushWaveform
Whether a valid waveform of last switch-on operation can be read using getInrushWaveform().
LedState ledState
LED state (deprecated and always sent as 'off')
boolean inServiceMode
Whether the outlet is currently placed into service mode.
boolean isSuspended
Whether the outlet was turned off automatically due to being suspected to have caused an OCP trip eve...
boolean switchOnInProgress
true if the outlet is pending to be switched on after the sequencing delay has passed.
PowerState powerState
Current power state of outlet (represented by the control state of the relay, which was set by the la...
time lastPowerStateChange
Time of last power state change (UNIX timestamp, UTC)
boolean available
powerState is available