|
Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
|
import <Port.idl;
Classes | |
| struct | DetectionMode |
| Port detection mode. More... | |
| struct | DeviceChangedEvent |
| Event: The device connected to the port has changed. More... | |
| struct | DeviceTypeWithId |
| struct | Properties |
| Port properties. More... | |
| struct | PropertiesChangedEvent |
| Event: The port properties have changed. More... | |
Public Types | |
| enum | DetectionType { AUTO , PINNED , DISABLED } |
| Port detection type. More... | |
| enum | DeviceTypeId { UNSPECIFIED , OTHER , SENSOR_HUB , BEEPER , ASSET_STRIP , POWER_CIM , GATEWAY_SENSOR } |
| devices types that may be connected to port More... | |
Public Member Functions | |
| Properties | getProperties () |
| Get the current properties of the port. | |
| void | setName (in string name) |
| NOT USED RIGHT NOW! | |
| int | setDetectionMode (in DetectionMode mode) |
| Set the detection mode for the port. | |
| vector< string > | getDetectableDevices () |
| Get all detectable devices of this port. | |
| Object | getDevice () |
| Get the connected device of the port. | |
| Object | getDeviceConfig (in string deviceType) |
| Get device type specific configuration interface. | |
| PortFuse | getFuse () |
| Get the fuse for this port. | |
Public Attributes | |
| constant int | NO_ERROR = 0 |
| Error codes. | |
| constant int | ERR_INVALID_PARAM = 1 |
| invalid parameter for an operation | |
| constant int | ERR_DEVICE_BUSY = 2 |
| operation fails because connected device is busy | |
devices types that may be connected to port
| Enumerator | |
|---|---|
| UNSPECIFIED | not specified, means "not detected" in Properties::detectedDeviceTypeId |
| OTHER | other types, not listet below |
| SENSOR_HUB | sensor hub |
| BEEPER | external beeper |
| ASSET_STRIP | asset strip |
| POWER_CIM | power cim |
| GATEWAY_SENSOR | modbus RTU gateway sensor |
| vector< string > portsmodel::Port::getDetectableDevices | ( | ) |
Get all detectable devices of this port.
| Object portsmodel::Port::getDevice | ( | ) |
Get the connected device of the port.
| Object portsmodel::Port::getDeviceConfig | ( | in string | deviceType | ) |
Get device type specific configuration interface.
| deviceType | Device type to get configuration interface for |
| PortFuse portsmodel::Port::getFuse | ( | ) |
Get the fuse for this port.
| Properties portsmodel::Port::getProperties | ( | ) |
Get the current properties of the port.
| int portsmodel::Port::setDetectionMode | ( | in DetectionMode | mode | ) |
Set the detection mode for the port.
| mode | new detection mode |
| void portsmodel::Port::setName | ( | in string | name | ) |
NOT USED RIGHT NOW!
Set the port name
| name | new port name |
| constant int portsmodel::Port::ERR_DEVICE_BUSY = 2 |
| constant int portsmodel::Port::ERR_INVALID_PARAM = 1 |
| constant int portsmodel::Port::NO_ERROR = 0 |