clearpath.horizon.payloads.AckermannOutput Class Reference

Horizon Message Payload - Ackermann Output. More...

Inheritance diagram for clearpath.horizon.payloads.AckermannOutput:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Ackermann Servos.
def	print_format
	Human Readable Payload String.
Public Attributes
	brake
	Brake.
	steering
	Steering.
	throttle
	Throttle.

---

Detailed Description

Horizon Message Payload - Ackermann Output.

Represents the payload of the command and data messages 'ackermann servos'

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - Ackermann Servos

Definition at line 1653 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.AckermannOutput.__init__	(		self,
			steering = 0,
			throttle = 0,
			brake = 0,
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Ackermann Servos.

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

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

Parameters:

brake	The brake position
raw	Raw Payload data byte list to parse
steering	The steering position
throttle	The throttle position
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 - Ackermann Servos

Definition at line 1678 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.AckermannOutput.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 1745 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.AckermannOutput::brake

Brake.

Definition at line 1679 of file payloads.py.

clearpath::horizon::payloads.AckermannOutput::steering

Steering.

Definition at line 1680 of file payloads.py.

clearpath::horizon::payloads.AckermannOutput::throttle

Throttle.

Definition at line 1681 of file payloads.py.

---

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

• payloads.py