SerialCommon Class Reference

A helper class to add some protocol to the serial byte stream. More...

Inheritance diagram for SerialCommon:

[legend]Collaboration diagram for SerialCommon:

[legend]List of all members.

Public Member Functions
def	__init__
	Initialize the class with defaults from a configuration file and/or the command line.
def	__serialOptions
def	getConfig
	Return the configuration ConfigParser object.
Static Public Attributes
string	STARTCHARACTER = '\x01'
string	FILECHARACTER = '\x02'
string	ENDCHARACTER = '\x04'

---

Detailed Description

A helper class to add some protocol to the serial byte stream.

Definition at line 29 of file gSerial.py.

---

Member Function Documentation

def __init__ (    self,   config,   echo = None,   timeout = None )

Initialize the class with defaults from a configuration file and/or the command line. Parameters: config  - A ConfigParser configuration object echo  - Option to override the configuration file's echo value Definition at line 35 of file gSerial.py.

def __serialOptions (    self,   config )

Serial line options the [serial] block of the configuration file can be: port=PORT: Port, a number, default = 0 or a device name baud=BAUD: Baud rate, default 9600 rtscts=0/1: En/dis-able RTS/CTS flow control (default: disabled) xonxoff=0/1: En/dis-able software flow control (default: disabled) echo=0/1: En/dis-able local echo (default: disabled) debug=0/1: En/dis-able convert_nl=CR/LF/CRLF: Convert newline character(s) to one of CR, LF, CRLF (default: OS dependent) Definition at line 66 of file gSerial.py.

def getConfig (    self  )

Return the configuration ConfigParser object. Definition at line 112 of file gSerial.py.

---

Member Data Documentation

string ENDCHARACTER = '\x04' [static]

Definition at line 33 of file gSerial.py.

string FILECHARACTER = '\x02' [static]

Definition at line 32 of file gSerial.py.

string STARTCHARACTER = '\x01' [static]

Definition at line 31 of file gSerial.py.

---

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

• gSerial.py

---