|
Legrand / Raritan / Server Technology Xerus™ PDU JSON-RPC API
|
Interface describing a physical serial port and the devices which can be attached to it. More...
Classes | |
| struct | MetaData |
| (Static) meta data containing port properties More... | |
| struct | ModemAddedEvent |
| Event emitted when a modem is connected. More... | |
| struct | ModemEvent |
| Event emitted when the modem connection state changes. More... | |
| struct | ModemRemovedEvent |
| Event emitted when a modem is disconnected. More... | |
| struct | Settings |
| Port settings. More... | |
| struct | State |
| Structure holding information about the current state of the port. More... | |
Public Types | |
| enum | PortState { CONSOLE , ANALOGMODEM , GSMMODEM , DISCONNECTED } |
| Possible states the port can be in at a given time. More... | |
| enum | DetectionType { AUTOMATIC , FORCE_CONSOLE , FORCE_ANALOGMODEM , FORCE_GSMMODEM } |
| Device type the port shall be looking for. More... | |
| enum | BaudRate { BR1200 , BR2400 , BR4800 , BR9600 , BR19200 , BR38400 , BR57600 , BR115200 } |
| Possible baud rates. More... | |
Public Member Functions | |
| MetaData | getMetaData () |
| Get port meta data. More... | |
| Settings | getSettings () |
| Get current settings. More... | |
| int | setSettings (in Settings settings) |
| Set settings. More... | |
| State | getState () |
| Get current port state. More... | |
| Object | getModem () |
| Get modem connected to port. More... | |
Public Attributes | |
| constant int | SUCCESS = 0 |
| Error codes. More... | |
| constant int | ERR_INVALID_VALUE = 1 |
| Invalid arguments. | |
Interface describing a physical serial port and the devices which can be attached to it.
| MetaData serial::SerialPort::getMetaData | ( | ) |
Get port meta data.
| Object serial::SerialPort::getModem | ( | ) |
Get modem connected to port.
AnalogModem or GsmModem) | State serial::SerialPort::getState | ( | ) |
Get current port state.
| int serial::SerialPort::setSettings | ( | in Settings | settings | ) |
Set settings.
| settings | – new settings |
| constant int serial::SerialPort::SUCCESS = 0 |
Error codes.
No error