| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Interface describing a physical serial port and the devices which can be attached to it. More...
import <SerialPort.idl;
| 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. | |
| Settings | getSettings () | 
| Get current settings. | |
| int | setSettings (in Settings settings) | 
| Set settings. | |
| State | getState () | 
| Get current port state. | |
| Object | getModem () | 
| Get modem connected to port. | |
| Public Attributes | |
| constant int | SUCCESS = 0 | 
| Error codes. | |
| constant int | ERR_INVALID_VALUE = 1 | 
| Invalid arguments. | |
Interface describing a physical serial port and the devices which can be attached to it.
Definition at line 16 of file SerialPort.idl.
Possible baud rates.
| Enumerator | |
|---|---|
| BR1200 | 1.200 kbit/s | 
| BR2400 | 2.400 kbit/s | 
| BR4800 | 4.800 kbit/s | 
| BR9600 | 9.600 kbit/s | 
| BR19200 | 19::200 kbit/s | 
| BR38400 | 38::400 kbit/s | 
| BR57600 | 57::600 kbit/s | 
| BR115200 | 115::200 kbit/s | 
Definition at line 46 of file SerialPort.idl.
Device type the port shall be looking for.
Definition at line 36 of file SerialPort.idl.
Possible states the port can be in at a given time.
Definition at line 26 of file SerialPort.idl.
| 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::ERR_INVALID_VALUE = 1 | 
Invalid arguments.
Definition at line 21 of file SerialPort.idl.
| constant int serial::SerialPort::SUCCESS = 0 |