Raritan PX2/PX3 JSON-RPC API
SerialPort.idl
1 #include <GsmModem.idl>
2 #include <AnalogModem.idl>
3 
5 module serial {
6 
11  interface SerialPort_3_0_1 {
15  constant int SUCCESS = 0;
16  constant int ERR_INVALID_VALUE = 1;
17 
21  enumeration PortState {
25  DISCONNECTED
26  };
27 
31  enumeration DetectionType {
35  FORCE_GSMMODEM
36  };
37 
41  enumeration BaudRate {
49  BR115200
50  };
51 
55  structure MetaData {
56  boolean hasModemSupport;
57  };
59 
64  structure State {
66  string deviceName;
67  };
68 
72  structure Settings {
76  };
77 
81  valueobject ModemEvent extends idl.Event {
82  Object modem;
83  };
84 
88  valueobject ModemAddedEvent extends ModemEvent {
89  };
90 
94  valueobject ModemRemovedEvent extends ModemEvent {
95  };
96 
102  MetaData getMetaData();
103 
109  Settings getSettings();
110 
119  int setSettings(in Settings settings);
120 
126  State getState();
127 
134  Object getModem();
135  };
136 
137 }
Always assume a console (terminal) is connected.
Definition: SerialPort.idl:33
2.400 kbit/s
Definition: SerialPort.idl:43
BaudRate
Possible baud rates.
Definition: SerialPort.idl:41
Structure holding information about the current state of the port.
Definition: SerialPort.idl:64
Port settings.
Definition: SerialPort.idl:72
19::200 kbit/s
Definition: SerialPort.idl:46
(Static) meta data containing port properties
Definition: SerialPort.idl:55
PortState state
Current connection state.
Definition: SerialPort.idl:65
Always assume an analog modem is connected.
Definition: SerialPort.idl:34
The console application is running on the port.
Definition: SerialPort.idl:22
DetectionType
Device type the port shall be looking for.
Definition: SerialPort.idl:31
An analog modem is attached to the port.
Definition: SerialPort.idl:23
Serial Ports.
Definition: AnalogModem.idl:7
Basic IDL definitions.
Definition: Event.idl:6
38::400 kbit/s
Definition: SerialPort.idl:47
A GSM modem is attached to the port.
Definition: SerialPort.idl:24
BaudRate modemBaudRate
Baud rate to be used for communicating with an attached modem.
Definition: SerialPort.idl:74
boolean hasModemSupport
Whether or not the port can detect modems (if false, this port can only operate in console mode) ...
Definition: SerialPort.idl:56
4.800 kbit/s
Definition: SerialPort.idl:44
string deviceName
Name of the device currently connected.
Definition: SerialPort.idl:66
Try to automatically determine the connected device.
Definition: SerialPort.idl:32
Interface describing a physical serial port and the devices which can be attached to it...
Definition: SerialPort.idl:11
DetectionType detectType
Type of connected device to be assumed in device detection.
Definition: SerialPort.idl:75
PortState
Possible states the port can be in at a given time.
Definition: SerialPort.idl:21
57::600 kbit/s
Definition: SerialPort.idl:48
BaudRate consoleBaudRate
Baud rate to be used for running the console application.
Definition: SerialPort.idl:73
9.600 kbit/s
Definition: SerialPort.idl:45
1.200 kbit/s
Definition: SerialPort.idl:42