| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Transfer switch interface. More...
 
  
| Classes | |
| struct | MetaData | 
| Transfer switch metadata.  More... | |
| struct | Sensors | 
| Transfer switch sensors.  More... | |
| struct | Settings | 
| Transfer switch settings.  More... | |
| struct | SettingsChangedEvent | 
| Event: Transfer switch settings have been changed.  More... | |
| struct | Statistics | 
| Transfer switch statistics.  More... | |
| struct | TransferLogEntry | 
| Transfer log entry.  More... | |
| Public Types | |
| enum | Type { STS , ATS , HTS } | 
| Transfer switch type.  More... | |
| enum | TransferReason { REASON_UNKNOWN , REASON_STARTUP , REASON_MANUAL_TRANSFER , REASON_AUTO_RETRANSFER , REASON_POWER_FAILURE , REASON_POWER_QUALITY , REASON_OVERLOAD , REASON_OVERHEAT , REASON_INTERNAL_FAILURE } | 
| typedef map< string, int > | Parameters | 
| Transfer switch parameter map.  More... | |
| Public Member Functions | |
| MetaData | getMetaData () | 
| Retrieve the transfer switch metadata.  More... | |
| Sensors | getSensors () | 
| Get the transfer switch sensors.  More... | |
| vector< ThrowPole > | getPoles () | 
| Get the list of transfer switch poles.  More... | |
| Settings | getSettings () | 
| Retrieve the transfer switch settings.  More... | |
| int | setSettings (in Settings settings) | 
| Change the transfer switch settings.  More... | |
| Statistics | getStatistics () | 
| Retrieve the transfer switch statistics.  More... | |
| int | transferToSource (in int source, in boolean faultOverride) | 
| Select the active inlet.  More... | |
| TransferReason | getLastTransferReason () | 
| Get the reason for the last transfer.  More... | |
| Waveform | getLastTransferWaveform () | 
| Get the voltage and current waveforms during the last transfer.  More... | |
| vector< TransferLogEntry > | getTransferLog () | 
| Retrieve the transfer log.  More... | |
| Parameters | getParameters () | 
| Retrieve the transfer switch parameters.  More... | |
| int | setParameters (in Parameters parameters) | 
| Update one or more transfer switch parameters.  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_INVALID_PARAM = 1 | 
| Invalid parameters. | |
| constant int | ERR_SWITCH_PREVENTED = 2 | 
| Switching failed due to an alarm that may be overridden. | |
| constant int | ERR_SWITCH_FAILED = 3 | 
| Switching failed, no override possible. | |
| constant int | OPERATIONAL_STATE_OFF = 0 | 
| Both inlets are off. | |
| constant int | OPERATIONAL_STATE_NORMAL = 1 | 
| Active inlet equals preferred inlet. | |
| constant int | OPERATIONAL_STATE_STANDBY = 2 | 
| Active inlet and preferred inlet are different. | |
| constant int | OPERATIONAL_STATE_NON_REDUNDANT = 3 | 
| Active inlet equals preferred inlet, standby power critical. | |
| constant int | SWITCH_FAULT_I1_SHORT = 1 | 
| Inlet 1 switch is permanently closed. | |
| constant int | SWITCH_FAULT_I1_OPEN = 2 | 
| Inlet 1 switch is permanently open. | |
| constant int | SWITCH_FAULT_I2_SHORT = 4 | 
| Inlet 2 switch is permanently closed. | |
| constant int | SWITCH_FAULT_I2_OPEN = 8 | 
| Inlet 2 switch is permanently open. | |
Transfer switch interface.
| typedef map<string, int> pdumodel::TransferSwitch::Parameters | 
Transfer switch parameter map.
The set of parameters, their meaning and allowed set of values are technology-dependent and subject to change. Do not modify any values without instruction from Raritan!
| TransferReason pdumodel::TransferSwitch::getLastTransferReason | ( | ) | 
Get the reason for the last transfer.
| Waveform pdumodel::TransferSwitch::getLastTransferWaveform | ( | ) | 
Get the voltage and current waveforms during the last transfer.
| MetaData pdumodel::TransferSwitch::getMetaData | ( | ) | 
Retrieve the transfer switch metadata.
| Parameters pdumodel::TransferSwitch::getParameters | ( | ) | 
Retrieve the transfer switch parameters.
| vector< ThrowPole > pdumodel::TransferSwitch::getPoles | ( | ) | 
Get the list of transfer switch poles.
| Sensors pdumodel::TransferSwitch::getSensors | ( | ) | 
Get the transfer switch sensors.
| Settings pdumodel::TransferSwitch::getSettings | ( | ) | 
Retrieve the transfer switch settings.
| Statistics pdumodel::TransferSwitch::getStatistics | ( | ) | 
Retrieve the transfer switch statistics.
| vector< TransferLogEntry > pdumodel::TransferSwitch::getTransferLog | ( | ) | 
Retrieve the transfer log.
| int pdumodel::TransferSwitch::setParameters | ( | in Parameters | parameters | ) | 
Update one or more transfer switch parameters.
| parameters | Map of transfer switch parameters. Parameters which are not in the map remain unchanged. | 
| int pdumodel::TransferSwitch::setSettings | ( | in Settings | settings | ) | 
Change the transfer switch settings.
| int pdumodel::TransferSwitch::transferToSource | ( | in int | source, | 
| in boolean | faultOverride | ||
| ) | 
Select the active inlet.
If the new inlet is available, it will become both active and preferred.
| source | New active inlet index | 
| faultOverride | Force switch even if the phase sync angle between the inputs is too large |