Outlet interface
More...
|
constant int | ERR_OUTLET_NOT_SWITCHABLE = 1 |
| Outlet is not switchable.
|
|
constant int | ERR_LOAD_SHEDDING_ACTIVE = 2 |
| Load-shedding is enabled (deprecated)
|
|
constant int | ERR_OUTLET_DISABLED = 3 |
| Outlet is disabled.
|
|
constant int | ERR_OUTLET_NOT_OFF = 4 |
| Outlet is on or in power-cylce; unstick not possible.
|
|
constant int | ERR_INVALID_PARAM = 1 |
| Invalid parameters.
|
|
◆ PowerState
Outlet power state.
Used both for switching and representing the current state
Enumerator |
---|
PS_OFF | Switch off / Power is off.
|
PS_ON | Switch on / Power is on.
|
◆ StartupState
Outlet power state on device startup
Enumerator |
---|
SS_ON | Outlet will be switched on
|
SS_OFF | Outlet will be switched off
|
SS_LASTKNOWN | Last known power state will be restored.
|
SS_PDUDEF | Use default state as defined in PDU settings.
|
◆ cyclePowerState()
int pdumodel::Outlet::cyclePowerState |
( |
| ) |
|
Power-cycle the outlet.
- Returns
- 0 if OK
-
1 if the outlet is not switchable
-
3 if the outlet is disabled
◆ getController()
Get the controller for this outlet.
- Returns
- Sub controller reference
◆ getInrushWaveform()
Waveform pdumodel::Outlet::getInrushWaveform |
( |
| ) |
|
Get the voltage and current waveforms at the time of last switch on operation.
- Note
- If waveform reading is not supported or a waveform could not be acquired for other reasons (e.g. the outlet not actually be switchable, or the outlet board being reset since the outlet was turned on), an empty waveform is returned.
- Returns
- Waveform samples
◆ getIOP()
Get inlet, overcurrent protector and poles.
- Parameters
-
i | Result: Inlet reference |
o | Result: Overcurrent protector reference |
p | Result: List of poles |
◆ getMetaData()
MetaData pdumodel::Outlet::getMetaData |
( |
| ) |
|
Retrieve the outlet metadata.
- Returns
- Outlet metadata
◆ getSensors()
Sensors pdumodel::Outlet::getSensors |
( |
| ) |
|
Get the outlet sensors.
- Returns
- Outlet sensors
◆ getSettings()
Settings pdumodel::Outlet::getSettings |
( |
| ) |
|
Retrieve the outlet settings.
- Returns
- Outlet settings
◆ getState()
State pdumodel::Outlet::getState |
( |
| ) |
|
Retrieve the outlet state.
- Returns
- Outlet state
◆ setPowerState()
int pdumodel::Outlet::setPowerState |
( |
in PowerState |
pstate | ) |
|
Switch the outlet.
- Parameters
-
- Returns
- 0 if OK
-
1 if the outlet is not switchable
-
3 if the outlet is disabled
◆ setSettings()
int pdumodel::Outlet::setSettings |
( |
in Settings |
settings | ) |
|
Change the outlet settings.
- Parameters
-
settings | New outlet settings |
- Returns
- 0 if OK
-
1 if any parameters are invalid
◆ unstick()
int pdumodel::Outlet::unstick |
( |
| ) |
|
Trigger an attempt to un-stick sticking relay contacts.
Warning: Please contact Tech Support before using this.
Tries repairing relay contacts that are sticked together due to wear by switching the relay in a certain pattern. Prior to running this method, the outlet must be in 'off' state to acknowledge that loads were disconnected.
- Returns
- 0 if unsticking was triggered successfully
-
1 if outlet is not switchable
-
3 if the outlet is disabled
-
4 if relay is in a power cycle or on
The documentation for this interface was generated from the following file: