SerialSender Class Reference

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

Inheritance diagram for SerialSender:

[legend]Collaboration diagram for SerialSender:

[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	begin
	Announce that a block of data is about to be sent.
def	send
	Send a buffer of data.
def	end
	Announce the end of the block of data.

---

Detailed Description

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

Definition at line 119 of file gSerial.py.

---

Member Function Documentation

def __init__ (    self,   config,   echo = False )

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 121 of file gSerial.py.

def begin (    self,   filename = None )

Announce that a block of data is about to be sent. Optionally request that the other side tags it with a specific file name. Parameters: filename  Optional filename Definition at line 130 of file gSerial.py.

def end (    self  )

Announce the end of the block of data. Definition at line 151 of file gSerial.py.

def send (    self,   buf )

Send a buffer of data. Optionally print the buffer for debugging Parameters: buf  Buffer of data to send Definition at line 140 of file gSerial.py.

---

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

• gSerial.py

---