serial::SerialPort_3_0_1 Interface Reference

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	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.
valueobject	ModemEvent: idl::Event { Object modem
	Event emitted when the modem connection state changes. More...
valueobject	ModemAddedEvent: ModemEvent { }
	Event emitted when a modem is connected.
valueobject	ModemRemovedEvent: ModemEvent { }
	Event emitted when a modem is disconnected.

Detailed Description

Interface describing a physical serial port and the devices which can be attached to it.

Member Enumeration Documentation

enum serial::SerialPort_3_0_1::BaudRate

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

enum serial::SerialPort_3_0_1::DetectionType

Device type the port shall be looking for.

Enumerator
AUTOMATIC	Try to automatically determine the connected device.
FORCE_CONSOLE	Always assume a console (terminal) is connected.
FORCE_ANALOGMODEM	Always assume an analog modem is connected.
FORCE_GSMMODEM	Always assume a GSM modem is connected.

enum serial::SerialPort_3_0_1::PortState

Possible states the port can be in at a given time.

Enumerator
CONSOLE	The console application is running on the port.
ANALOGMODEM	An analog modem is attached to the port.
GSMMODEM	A GSM modem is attached to the port.
DISCONNECTED	No device matching the configured mode is detected.

Member Function Documentation

MetaData serial::SerialPort_3_0_1::getMetaData

(

)

Get port meta data.

Returns

– Meta data

Object serial::SerialPort_3_0_1::getModem

(

)

Get modem connected to port.

Returns

– an instance of the connected modem (either AnalogModem or GsmModem)

Settings serial::SerialPort_3_0_1::getSettings

(

)

Get current settings.

Returns

– Settings

State serial::SerialPort_3_0_1::getState

(

)

Get current port state.

Returns

– Port state

int serial::SerialPort_3_0_1::setSettings

(

in Settings

settings

)

Set settings.

Parameters

settings

– new settings

Returns

SUCCESS – on success

ERR_INVALID_VALUE – if any passed value was invalid

Member Data Documentation

valueobject serial::SerialPort_3_0_1::ModemEvent

Event emitted when the modem connection state changes.

Either a AnalogModem or a GsmModem

constant int serial::SerialPort_3_0_1::SUCCESS = 0

Error codes.

No error

---

The documentation for this interface was generated from the following file:

• pdu-json-rpc-api/idl/SerialPort.idl