clearpath.horizon.transports.Serial Class Reference

Horizon Serial Controller. More...

Inheritance diagram for clearpath.horizon.transports.Serial:

List of all members.

Classes
class	Receiver
Public Member Functions
def	__init__
def	__str__
def	autodetect
def	close
def	is_open
def	open
def	send_message
def	send_raw
Public Attributes
	port
	receive_callback
	receiver
	serial_write_lock
	store_timeout
Private Attributes
	_opened
	_serial

---

Detailed Description

Horizon Serial Controller.

Provides a method to send and receive messages over RS-232.
Guarantees order of arrival and arrival.
Low Bandwidth use only.

pySerial [http://pyserial.sourceforge.net/]

Since:

0.1

Horizon Transport Controller - Serial Device

Definition at line 241 of file transports.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.transports.Serial.__init__	(		self,
			port = None,
			store_timeout = 0,
			receive_callback = None
	)

Create A Horizon Serial Transport

Definition at line 244 of file transports.py.

---

Member Function Documentation

def clearpath.horizon.transports.Serial.__str__

(

self

)

Return the transport device name.

Definition at line 302 of file transports.py.

def clearpath.horizon.transports.Serial.autodetect	(		cls,
			kwargs
	)

Definition at line 281 of file transports.py.

def clearpath.horizon.transports.Serial.close

(

self

)

Definition at line 352 of file transports.py.

def clearpath.horizon.transports.Serial.is_open

(

self

)

Definition at line 362 of file transports.py.

def clearpath.horizon.transports.Serial.open

(

self

)

Definition at line 307 of file transports.py.

def clearpath.horizon.transports.Serial.send_message	(		self,
			message
	)

Serial Transport Device Send Horizon Message

Definition at line 366 of file transports.py.

def clearpath.horizon.transports.Serial.send_raw	(		self,
			raw
	)

Definition at line 371 of file transports.py.

---

Member Data Documentation

clearpath::horizon::transports.Serial::_opened [private]

Definition at line 244 of file transports.py.

clearpath::horizon::transports.Serial::_serial [private]

Definition at line 244 of file transports.py.

clearpath::horizon::transports.Serial::port

Definition at line 244 of file transports.py.

clearpath::horizon::transports.Serial::receive_callback

Definition at line 244 of file transports.py.

clearpath::horizon::transports.Serial::receiver

Definition at line 307 of file transports.py.

clearpath::horizon::transports.Serial::serial_write_lock

Definition at line 244 of file transports.py.

clearpath::horizon::transports.Serial::store_timeout

Definition at line 244 of file transports.py.

---

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

• transports.py