clearpath.horizon.transports Namespace Reference

Module. More...

Classes
class	Serial
	Horizon Serial Controller. More...
class	Transport
	Horizon Transport Controller. More...
Variables
string	__revision__ = "$Revision: 898 $"
	SVN Code Revision.
string	__version__ = "1.0"
	Module Version.
tuple	logger = logging.getLogger('clearpath.horizon.transports')
	Message Log.
tuple	MessageRecord = collections.namedtuple('MessageRecord', 'message, expiry')

---

Detailed Description

Module.

Horizon Transports Python Module

Horizon Message Transport Controllers
Supported Horizon version(s): 0.1 - 1.0

Supported Transports:

• Serial (RS-232)

Author:

Ryan Gariepy

Malcolm Robert

Date:

18/01/10

Todo:

Would be nice to support version translation in IP Servers, however, that would require additional work to detect the version that clients are using which is currently not supported by the current framework.

FIX encryption clearpath.utils
clearpath.horizon.messages
clearpath.horizon.payloads
pySerial [http://pyserial.sourceforge.net/]
-- for Serial

Version:

1.0

USE

The intended purpose of this module is to provide functionality to send and receive Horizon messages over the various transports with minimal knowledge of messages and no knowledge of message payloads. Further, as some transports support a one-to-many connection scheme, this module also provides message routing. Note that as this module implements the transports as defined in the Horizon specification, there is no support for version translation. If version translation is desired, refer to the module clearpath.horizon.forward.

HISTORY

Versions 0.1 - 0.3 {Ryan Gariepy}

• Initial Creation as protocol.py

Version 0.4 {Malcolm Robert}

• Moved to horizon_protocol.py
• Added protocol abstraction
• Added TCP/IP
• Added UDP
• Added logging
• Added version support
• Added Doxygen documentation
• Changed version scheme to match Horizon doc
• Horizon support for v0.4

Version 0.5

• Horizon support for v0.5

Version 0.6

• Moved to protocol.py
• Horizon support for v0.6
• Improved search for header in read
• Added TCP encryption

Version 0.7

• Moved to transport.py
• Added Server transports
• Added IPv6 support
• Horizon support for v 0.1 - 0.7
• Python 2.6+ & 3.x compatible

Version 0.8

• Horizon support for v 0.1 - 0.8

Version 1.0

• Added one-to-many support
• Horizon support for v 0.1 - 1.0

License

---

Variable Documentation

string clearpath::horizon::transports.__revision__ = "$Revision: 898 $"

SVN Code Revision.

Definition at line 204 of file transports.py.

string clearpath::horizon::transports.__version__ = "1.0"

Module Version.

Definition at line 201 of file transports.py.

tuple clearpath::horizon::transports.logger = logging.getLogger('clearpath.horizon.transports')

Message Log.

Definition at line 209 of file transports.py.

tuple clearpath::horizon::transports.MessageRecord = collections.namedtuple('MessageRecord', 'message, expiry')

Definition at line 196 of file transports.py.