| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Sub controller interface. More...
 
  
| Classes | |
| struct | MetaData | 
| Sub controller metadata.  More... | |
| struct | MetaDataChangedEvent | 
| Event: Controller metadata has changed.  More... | |
| struct | StatusChangedEvent | 
| Event: Controller communication status has changed.  More... | |
| Public Types | |
| enum | Status { OK , COMMUNICATION_UNSTABLE , COMMUNICATION_FAILURE , UNKNOWN , INCOMPATIBLE , FIRMWARE_UPDATE } | 
| Communication status.  More... | |
| enum | Type { OUTLET_CTRL , INLET_CTRL , METER_CTRL } | 
| Sub controller type.  More... | |
| Public Member Functions | |
| Status | getCommunicationStatus () | 
| Retrieve the current status of communication with controller.  More... | |
| CtrlStatistic | getStatistics () | 
| Retrieve statistics.  More... | |
| MetaData | getMetaData () | 
| Retrieve the sub controller metadata.  More... | |
| int | reset () | 
| Reset this sub controller.  More... | |
| Public Attributes | |
| constant int | ERR_NOT_SUPPORTED = 1 | 
| Operation not supported. | |
Sub controller interface.
Communication status.
| Enumerator | |
|---|---|
| OK | Communication with controller is known to be working. | 
| COMMUNICATION_UNSTABLE | Controller can be communicated with sporadically. | 
| COMMUNICATION_FAILURE | Controller can't be communicated with. | 
| UNKNOWN | Communication status is unknown, e.g. after startup. | 
| INCOMPATIBLE | The characteristics of the controller don't meet the expectations. | 
| FIRMWARE_UPDATE | A controller firmware update is in progress. | 
| Status pdumodel::Controller::getCommunicationStatus | ( | ) | 
Retrieve the current status of communication with controller.
| MetaData pdumodel::Controller::getMetaData | ( | ) | 
Retrieve the sub controller metadata.
| CtrlStatistic pdumodel::Controller::getStatistics | ( | ) | 
Retrieve statistics.
| int pdumodel::Controller::reset | ( | ) | 
Reset this sub controller.
Note: Depending on the hardware setup of the specific device, calling this method may also cause other sub controllers to be reset.