Public Member Functions | Public Attributes
clearpath.horizon.payloads.PlatformInfo Class Reference
Inheritance diagram for clearpath.horizon.payloads.PlatformInfo:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
 Create A Horizon Message Payload - Platform Information.
def print_format
 Human Readable Payload String.

Public Attributes

 model
 passcode
 revision
 serial

Detailed Description

Horizon Message Payload - Platform Information

Definition at line 541 of file payloads.py.


Constructor & Destructor Documentation

def clearpath.horizon.payloads.PlatformInfo.__init__ (   self,
  passcode = 0,
  model = '',
  revision = 0,
  serial = 0,
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload - Platform Information.

Constructor for the Horizon Message Payload - Platform Information Class.
The constructor can be called two different ways:

  • PlatformInformation(model, raw=None, version, ...)
    Create a command message payload to send.
  • PlatformInformation(raw, version, timestamp)
    Parse raw data (most likely received) into payload variables.
Parameters:
modelThe Platform Model
rawRaw Payload data byte list to parse
revisionThe Platform Model Revision Number
serialThe Platform Serial Number
timestampPayload Send / Create Time (milliseconds)
versionHorizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)
Exceptions:
LookupErrorIf auto-detect version fails
ValueErrorIf values are out of range or if raw is invalid
Create A Horizon Message Payload - Platform Information

Definition at line 567 of file payloads.py.


Member Function Documentation

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 626 of file payloads.py.


Member Data Documentation

Definition at line 567 of file payloads.py.

Definition at line 567 of file payloads.py.

Definition at line 567 of file payloads.py.

Definition at line 567 of file payloads.py.


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


clearpath_base
Author(s): Mike Purvis
autogenerated on Sat Dec 28 2013 16:50:48