clearpath.horizon.demo Namespace Reference

Module. More...


Detailed Description

Module.

Horizon Interface Demo Python Module & Script

Horizon Basic Command-Line Controller.
Supported Horizon version(s): 0.1 - 1.0

Author:
Ryan Gariepy
Malcolm Robert
Date:
14/01/10 clearpath.utils
clearpath.horizon
clearpath.horizon.messages
clearpath.horizon.payloads
clearpath.horizon.protocol
clearpath.horizon.transports
pyCrypto [http://www.dlitz.net/software/pycrypto/]
-- for encryption
pySerial [http://pyserial.sourceforge.net/]
-- for serial support
Version:
1.0

USE

The intended purpose of this module is to provide a CMD wrapper for the Horizon interface to provide the user with a basic command-line demo that can fully control a Horizon based platform. Further, this module provides script code to bootstrap the CMD wrapper.

While the wrapper (HorizonDemo) can be used directly, it is only useful for command-line controls and its use outside of this module is discouraged. To use the wrapper, instantiate and open Horizon, then instantiate the wrapper with the parameters port (the prompt prefix), horizon (the opened Horizon), and output (filename to output data messages to). Instantiation will automatically poll the platform for information then print to standard out a splash. Then, to enter the interactive shell, call cmdloop. Note that this method will block (calling Horizon methods as needed) until the user exits the interactive shell.

This script is executed by running 'python -m clearpath.horizon.demo' To list the required and optional command-line arguments run 'python -m clearpath.horizon.demo --help'

Various logging messages (debug, warning,...) are logged with the standard Python logger to the log named 'clearpath.horizon.demo'.
Messages are ignored by default; remove the only handler from it and turn on propagation to get messages to propagate. When this module is run as a script, logging messages are turned on according to command-line arguments.

HISTORY

Version 0.1 - 0.3 {Ryan Gariepy}

Version 0.4 {Malcolm Robert}

Version 0.5

Version 0.6

Version 0.7

Version 0.8

Version 1.0

License



clearpath_base
Author(s): Mike Purvis
autogenerated on Sun Oct 5 2014 22:52:08