| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Main PDU interface. More...
| Classes | |
| struct | LoadSheddingModeChangedEvent | 
| Event: Load shedding mode was enabled or disabled.  More... | |
| struct | MetaData | 
| PDU metadata.  More... | |
| struct | OutletSequenceState | 
| Outlet sequencing status  More... | |
| struct | OutletSequenceStateChangedEvent | 
| Event: Outlet sequencing state has changed.  More... | |
| struct | Sensors | 
| PDU sensors.  More... | |
| struct | Settings | 
| PDU settings.  More... | |
| struct | SettingsChangedEvent | 
| Event: PDU settings have been changed.  More... | |
| struct | Statistic | 
| PDU statistics.  More... | |
| Public Types | |
| enum | PduOrientation { PO_NONE , PO_BOTTOMFEED , PO_TOPFEED } | 
| PDU orientations.  More... | |
| enum | StartupState { SS_ON , SS_OFF , SS_LASTKNOWN } | 
| Outlet power state on device startup  More... | |
| Public Member Functions | |
| Nameplate | getNameplate () | 
| Retrieve the PDU nameplate information.  More... | |
| MetaData | getMetaData () | 
| Retrieve the PDU metadata.  More... | |
| Sensors | getSensors () | 
| Retrieve the PDU sensors.  More... | |
| sensors::Logger | getSensorLogger () | 
| Get the sensor logger.  More... | |
| sensors::AlertedSensorManager | getAlertedSensorManager () | 
| Get the alerted sensor manager.  More... | |
| vector< Controller > | getControllers () | 
| Get the list of sub controllers.  More... | |
| vector< Outlet > | getOutlets () | 
| Get the list of outlets.  More... | |
| vector< OverCurrentProtector > | getOverCurrentProtectors () | 
| Get the list of overcurrent protectors.  More... | |
| vector< Inlet > | getInlets () | 
| Get the list of inlets.  More... | |
| vector< TransferSwitch > | getTransferSwitches () | 
| Returns list of Transfer Switches.  More... | |
| peripheral::DeviceManager | getPeripheralDeviceManager () | 
| Get the peripheral device manager.  More... | |
| hmi::InternalBeeper | getBeeper () | 
| Get the built-in beeper, if there is any.  More... | |
| Settings | getSettings () | 
| Retrieve the PDU settings.  More... | |
| boolean | isLoadSheddingActive () | 
| Retrieve the current load shedding state.  More... | |
| int | setSettings (in Settings settings) | 
| Change the PDU settings.  More... | |
| void | setLoadSheddingActive (in boolean active) | 
| Enable or disable load shedding.  More... | |
| vector< portsmodel::Port > | getFeaturePorts () | 
| Get all feature ports of this device.  More... | |
| vector< portsmodel::Port > | getSensorPorts () | 
| Get all sensor ports of this device.  More... | |
| vector< portsmodel::Port > | getRemoteHubPorts () | 
| Get all remote hub ports of this device.  More... | |
| int | enterRS485ConfigModeAndAssignCtrlBoardAddress (in int addr) | 
| Enter RS485 config mode and assign an address to a relay board.  More... | |
| int | enterRS485ConfigModeAndAssignSCBoardAddress (in int deviceId, in int addr) | 
| Enter RS485 config mode and assign an address to a sub controller device with a given device ID.  More... | |
| int | leaveRS485ConfigMode () | 
| Leave RS485 config mode.  More... | |
| int | setAllOutletPowerStates (in Outlet::PowerState pstate) | 
| Switch all outlets.  More... | |
| int | setMultipleOutletPowerStates (in vector< int > outletNumbers, in Outlet::PowerState state, in boolean respectSequence) | 
| Switch multiple outlets.  More... | |
| int | cycleAllOutletPowerStates () | 
| Power-cycle all outlets.  More... | |
| int | cycleMultipleOutletPowerStates (in vector< int > outletNumbers, in boolean respectSequence) | 
| Power-cycle multiple outlets.  More... | |
| Statistic | getStatistic () | 
| Retrieve PDU statistics.  More... | |
| OutletSequenceState | getOutletSequenceState () | 
| Retrieve the current outlet sequencing status.  More... | |
| void | cancelOutletSequence () | 
| Stop a currently running outlet sequence. | |
| Public Attributes | |
| constant int | ERR_INVALID_PARAM = 1 | 
| Invalid parameters. | |
Main PDU interface.
| int pdumodel::Pdu::cycleAllOutletPowerStates | ( | ) | 
Power-cycle all outlets.
| int pdumodel::Pdu::cycleMultipleOutletPowerStates | ( | in vector< int > | outletNumbers, | 
| in boolean | respectSequence | ||
| ) | 
Power-cycle multiple outlets.
| outletNumbers | List of outlet numbers (0-based) | 
| respectSequence | trueto switch in defined sequence order | 
| int pdumodel::Pdu::enterRS485ConfigModeAndAssignCtrlBoardAddress | ( | in int | addr | ) | 
Enter RS485 config mode and assign an address to a relay board.
| addr | New relay board address | 
| int pdumodel::Pdu::enterRS485ConfigModeAndAssignSCBoardAddress | ( | in int | deviceId, | 
| in int | addr | ||
| ) | 
Enter RS485 config mode and assign an address to a sub controller device with a given device ID.
| deviceId | Device id of the sub controller which is supposed to get the address | 
| addr | New relay board address | 
| sensors::AlertedSensorManager pdumodel::Pdu::getAlertedSensorManager | ( | ) | 
Get the alerted sensor manager.
| hmi::InternalBeeper pdumodel::Pdu::getBeeper | ( | ) | 
Get the built-in beeper, if there is any.
| vector< Controller > pdumodel::Pdu::getControllers | ( | ) | 
Get the list of sub controllers.
| vector< portsmodel::Port > pdumodel::Pdu::getFeaturePorts | ( | ) | 
Get all feature ports of this device.
This returns an entry for all feature ports, no matter whether something is connected or not. A device with n feature ports will return n entries here.
| vector< Inlet > pdumodel::Pdu::getInlets | ( | ) | 
Get the list of inlets.
| MetaData pdumodel::Pdu::getMetaData | ( | ) | 
Retrieve the PDU metadata.
| Nameplate pdumodel::Pdu::getNameplate | ( | ) | 
Retrieve the PDU nameplate information.
| vector< Outlet > pdumodel::Pdu::getOutlets | ( | ) | 
Get the list of outlets.
| OutletSequenceState pdumodel::Pdu::getOutletSequenceState | ( | ) | 
Retrieve the current outlet sequencing status.
| vector< OverCurrentProtector > pdumodel::Pdu::getOverCurrentProtectors | ( | ) | 
Get the list of overcurrent protectors.
| peripheral::DeviceManager pdumodel::Pdu::getPeripheralDeviceManager | ( | ) | 
Get the peripheral device manager.
| vector< portsmodel::Port > pdumodel::Pdu::getRemoteHubPorts | ( | ) | 
Get all remote hub ports of this device.
This returns an entry for all remote hub ports, no matter whether something is connected or not. A device with n remote hub ports will return n entries here.
| sensors::Logger pdumodel::Pdu::getSensorLogger | ( | ) | 
Get the sensor logger.
| vector< portsmodel::Port > pdumodel::Pdu::getSensorPorts | ( | ) | 
Get all sensor ports of this device.
This returns an entry for all sensor ports, no matter whether something is connected or not. A device with n sensor ports will return n entries here.
| Sensors pdumodel::Pdu::getSensors | ( | ) | 
Retrieve the PDU sensors.
| Settings pdumodel::Pdu::getSettings | ( | ) | 
Retrieve the PDU settings.
| Statistic pdumodel::Pdu::getStatistic | ( | ) | 
Retrieve PDU statistics.
| vector< TransferSwitch > pdumodel::Pdu::getTransferSwitches | ( | ) | 
Returns list of Transfer Switches.
This list may be empty.
| boolean pdumodel::Pdu::isLoadSheddingActive | ( | ) | 
Retrieve the current load shedding state.
true if load shedding is currently enabled | int pdumodel::Pdu::leaveRS485ConfigMode | ( | ) | 
Leave RS485 config mode.
| int pdumodel::Pdu::setAllOutletPowerStates | ( | in Outlet::PowerState | pstate | ) | 
Switch all outlets.
| pstate | New power state for all outlets | 
| void pdumodel::Pdu::setLoadSheddingActive | ( | in boolean | active | ) | 
Enable or disable load shedding.
| active | trueto enable,falseto disable load shedding | 
| int pdumodel::Pdu::setMultipleOutletPowerStates | ( | in vector< int > | outletNumbers, | 
| in Outlet::PowerState | state, | ||
| in boolean | respectSequence | ||
| ) | 
Switch multiple outlets.
| outletNumbers | List of outlet numbers (0-based) | 
| state | New power state for all outlets in list | 
| respectSequence | trueto switch in defined sequence order | 
| int pdumodel::Pdu::setSettings | ( | in Settings | settings | ) | 
Change the PDU settings.
| settings | New PDU settings |