clearpath::horizon::payloads Namespace Reference

Horizon Protocol Message Payloads Python Module. More...

Classes

class  Acceleration
class  AccelerometerConfig
class  Ack
 Horizon Message Payload - Acknowledgment. More...
class  AckermannOutput
 Horizon Message Payload - Ackermann Output. More...
class  BatteryEstimationConfig
class  Config
class  ConfigRequest
class  ControlFlags
class  CurrentSensorConfig
class  DifferentialControl
 Horizon Message Payload - Differential Control. More...
class  DifferentialCurrent
class  DifferentialCurrentControl
class  DifferentialOutput
 Horizon Message Payload - Differential Output. More...
class  DifferentialSpeed
 Horizon Message Payload - Differential Speed. More...
class  Distance
 Horizon Message Payload - Distance. More...
class  DistanceTiming
 Horizon Message Payload - Distance & Timing. More...
class  Echo
class  Encoders
 Horizon Message Payload - Encoders. More...
class  EncodersConfig
class  FirmwareInfo
 Horizon Message Payload - Firmware Information. More...
class  Gear
 Horizon Message Payload - Gear. More...
class  GearStatus
 Horizon Message Payload - Gear Status. More...
class  GyroConfig
class  Magnetometer
class  MagnetometerConfig
class  MaxAccel
 Horizon Message Payload - Max Acceleration. More...
class  MaxSpeed
 Horizon Message Payload - Max Speed. More...
class  Null
 Horizon Message Payload - Null. More...
class  Orientation
 Horizon Message Payload - Orientation. More...
class  OrientationSensorConfig
class  Payload
 Horizon Payload. More...
class  PlatformInfo
class  PlatformKinematics
class  PlatformName
class  PlatformTime
 Horizon Message Payload - Platform Time. More...
class  PowerStatus
 Horizon Message Payload - Power Status. More...
class  ProcessorStatus
 Horizon Message Payload - Processor Status. More...
class  RawAccelerometer
class  RawCurrentSensor
class  RawEncoders
 Horizon Message Payload - Raw Encoders. More...
class  RawGyro
class  RawMagnetometer
class  RawOrientationSensor
class  RawSensor
class  RawTemperatureSensor
class  RawVoltageSensor
class  Reset
 Horizon Message Payload - Reset. More...
class  RestoreSystemConfig
class  Rotation
 Horizon Message Payload - Rotation. More...
class  SafetyStatus
 Horizon Message Payload - Safety System. More...
class  StoreSystemConfig
class  Subscribe
 Horizon Message Payload - Request Subscription. More...
class  SystemStatus
 Horizon Message Payload - System Status. More...
class  TemperatureSensorConfig
class  Turn
 Horizon Message Payload - Turn. More...
class  VariableSensorConfig
class  Velocity
 Horizon Message Payload - Velocity. More...
class  VoltageSensorConfig

Variables

string __revision__ = "$Revision: 920 $"
 SVN Code Revision.
string __version__ = "1.0"
 Module Version.
tuple logger = logging.getLogger('clearpath.horizon.payloads')
 Message Log.

Detailed Description

Horizon Protocol Message Payloads Python Module.

Horizon Protocol Message Payload Definitions
Abstracted from knowing message codes and message header.
Supported Horizon version(s): 0.1 - 1.0

Author:
Ryan Gariepy
Malcolm Robert
Michael Purvis
Date:
25/01/10 clearpath.utils
Version:
1.0

USE

The intended purpose of this module is to provide the various Payload definitions for the various messages within Horizon. The Payload class abstracts a payload and can represent a payload within a message without having any knowledge of the contained format whereas subclasses should know how payload data is formatted for one or more messages that they represent. These classes have no knowledge of message fields that do not fall within the payload field.

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


Variable Documentation

string clearpath::horizon::payloads::__revision__ = "$Revision: 920 $"

SVN Code Revision.

Definition at line 164 of file payloads.py.

Module Version.

Definition at line 161 of file payloads.py.

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

Message Log.

Definition at line 169 of file payloads.py.

 All Classes Namespaces Files Functions Variables Typedefs Properties


clearpath_base
Author(s): Mike Purvis
autogenerated on Fri Jan 11 10:11:33 2013