clearpath.horizon.payloads.DifferentialOutput Class Reference

Horizon Message Payload - Differential Output. More...

Inheritance diagram for clearpath.horizon.payloads.DifferentialOutput:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Differential Motors.
def	print_format
	Human Readable Payload String.
Public Attributes
	left
	right

---

Detailed Description

Horizon Message Payload - Differential Output.

Represents the payload of the command and data messages 'differential motors'

Warning:

Data should not be modified once created

Request Data

Horizon Message Payload - Differential Motors

Definition at line 1559 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.DifferentialOutput.__init__	(		self,
			left = 0,
			right = 0,
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Differential Motors.

Constructor for the Horizon Message Payload - Differential Speed.
The constructor can be called two different ways:

• DifferentialMotors(left, right, raw=None,...)
  Create a command message payload to send.
  
• DifferentialMotors(raw, version, timestamp)
  Parse raw data (most likely received) into payload variables.
  

Parameters:

left	Left Motor Output
raw	Raw Payload data byte list to parse
right	Right Motor Output
timestamp	Payload Send / Create Time (milliseconds)
version	Horizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)

Exceptions:

LookupError	If auto-detect version fails
ValueError	If values are out of range or if raw is invalid

Create A Horizon Message Payload - Differential Motors

Definition at line 1583 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.DifferentialOutput.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 1635 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.DifferentialOutput::left

Definition at line 1583 of file payloads.py.

clearpath::horizon::payloads.DifferentialOutput::right

Definition at line 1583 of file payloads.py.

---

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

• payloads.py