Outlet interface More...
import"Outlet.idl";
Inheritance diagram for pdumodel::Outlet:
Classes | |
| struct | LedState |
| Outlet LED state More... | |
| struct | MetaData |
| Outlet metadata More... | |
| struct | Sensors |
| Outlet sensors More... | |
| struct | Settings |
| Outlet settings More... | |
| struct | State |
| Outlet state More... | |
Public Types | |
| enum | PowerState { PS_OFF , PS_ON } |
| Outlet power state. More... | |
| enum | StartupState { SS_ON , SS_OFF , SS_LASTKNOWN , SS_PDUDEF } |
| Outlet power state on device startup More... | |
Public Member Functions | |
| MetaData | getMetaData () |
| Retrieve the outlet metadata. More... | |
| Sensors | getSensors () |
| Get the outlet sensors. More... | |
| State | getState () |
| Retrieve the outlet state. More... | |
| int | setPowerState (in PowerState pstate) |
| Switch the outlet. More... | |
| int | cyclePowerState () |
| Power-cycle the outlet. More... | |
| Settings | getSettings () |
| Retrieve the outlet settings. More... | |
| int | setSettings (in Settings settings) |
| Change the outlet settings. More... | |
| void | getIOP (out Inlet i, out OverCurrentProtector o, out vector< Pole > p) |
| Get inlet, overcurrent protector and poles. More... | |
| Controller | getController () |
| Get the controller for this outlet. More... | |
| Waveform | getInrushWaveform () |
| Get the voltage and current waveforms at the time of last switch on operation. More... | |
| int | unstick () |
| Trigger an attempt to un-stick sticking relay contacts. More... | |
 Public Member Functions inherited from pdumodel::EDevice | |
| vector< EDevice > | getParents () |
| Get the list of devices that provide energy to this device. More... | |
| vector< EDevice > | getChildren () |
| Get the list of devices that are directly fed by this device. More... | |
| Waveform | getWaveform () |
| Get the current voltage and current waveforms for this device. More... | |
| Waveform | getPoleWaveform (in PowerLine line) |
| Get the current voltage and current waveforms for a pole of this device. More... | |
Public Attributes | |
| 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. | |
| valueobject | PowerControlEvent: event::UserEvent { PowerState state |
| Event: Power control was initiated. More... | |
| boolean | cycle |
| Whether the outlet was cycled. | |
| valueobject | StateChangedEvent: idl::Event { State oldState |
| Event: Outlet state has changed. More... | |
| State | newState |
| State after change. | |
| valueobject | SettingsChangedEvent: event::UserEvent { Settings oldSettings |
| Event: Outlet settings have been changed. More... | |
| Settings | newSettings |
| Settings after change. | |
Detailed Description
Outlet interface
Member Enumeration Documentation
◆ PowerState
◆ StartupState
Member Function Documentation
◆ 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()
| Controller pdumodel::Outlet::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()
| void pdumodel::Outlet::getIOP | ( | out Inlet | i, |
| out OverCurrentProtector | o, | ||
| out vector< Pole > | p | ||
| ) |
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
-
pstate New power state
- 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
Member Data Documentation
◆ PowerControlEvent
| valueobject pdumodel::Outlet::PowerControlEvent |
Event: Power control was initiated.
State the outlet was switched to (if cycle is false)
◆ SettingsChangedEvent
| valueobject pdumodel::Outlet::SettingsChangedEvent |
◆ StateChangedEvent
| valueobject pdumodel::Outlet::StateChangedEvent |
The documentation for this interface was generated from the following file:
