dpySerialPort Namespace Reference

Deepsy SERIAL PORT namespace that includes the different enums, structs or method signatures that should be used.

Classes
class	SerialPortAvailabilityObserver
	Service Availability observer class. More...
struct	SerialPortConf

Typedefs
typedef boost::function< void(boost::system::error_code &ec)>	handler_function
	Handler for status function callback. More...
typedef boost::function< void(boost::system::error_code, std::map< std::string, dpySerialPort::SerialPortConf > serialPortMap)>	serialPort_list_handler
	Prototype of the handler function for getting serial port list. More...
typedef boost::function< void(boost::system::error_code error_code, const std::string &portid, const std::string &data)>	serialport_receive_handler_function
	Prototype of the handler function for receiving serial port message. More...

Enumerations
enum	ParityType {   NONE = 0, ODD = 1, EVEN = 2, MARK = 3,   SPACE = 4 }
enum	FlowControl { FLOW_NONE = 0, XONXOFF = 1, RTSCTS = 2, DSRDTR = 3 }
enum	SerialPortProtocol { RS485 = 0, RS232 = 1, RSJ1708 = 2 }
enum	GpioManagedType { RFS = 0, PIC = 1 }

Typedef Documentation

typedef boost::function<void(boost::system::error_code &ec)> handler_function

This type of function is called when the status callback is done.

Parameters

error_code	error code (if any)
info	vector with the status of the processesResult of an operation handler function.

typedef boost::function<void(boost::system::error_code, std::map<std::string, dpySerialPort::SerialPortConf> serialPortMap)> serialPort_list_handler

Parameters

error_code	error code (if any)
serial	port map of serial ports ids and configurations

typedef boost::function<void(boost::system::error_code error_code, const std::string &portid, const std::string &data)> serialport_receive_handler_function

Parameters

error_code	error code (if any)
id	serial port identifier
data	message to receive

Enumeration Type Documentation

enum FlowControl

Enumerator
XONXOFF	Xon/Xoff.
RTSCTS	Rts/Cts.
DSRDTR	Dsr/Dtr.

enum GpioManagedType

Enumerator
RFS	RFS Gpio.
PIC	Pic MCU Gpio.

enum SerialPortProtocol

Enumerator
RS485	485
RS232	232
RSJ1708	J1708.