clearpath::horizon::payloads::DifferentialSpeed Class Reference

Horizon Message Payload - Differential Speed. More...

Inheritance diagram for clearpath::horizon::payloads::DifferentialSpeed:

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Differential Speed.
def	print_format
	Human Readable Payload String.
Public Attributes
	left_accel
	left_speed
	right_accel
	right_speed

Detailed Description

Horizon Message Payload - Differential Speed.

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

Horizon Message Payload - Differential Speed

Definition at line 1265 of file payloads.py.

def clearpath::horizon::payloads::DifferentialSpeed::__init__	(	self,
		left_speed = `0`,
		right_speed = `0`,
		left_accel = `0`,
		right_accel = `0`,
		raw = `None`,
		timestamp = `0`
	)

Create A Horizon Message Payload - Differential Speed.

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

DifferentialSpeed(l_speed, r_accel, raw=None,...)
Create a command message payload to send.
DifferentialSpeed(raw, version, timestamp)
Parse raw data (most likely received) into payload variables.

Parameters:

	left_accel	Left Acceleration (m/s^2)
	left_speed	Left Speed (m/s)
	right_accel	Right Acceleration (m/s^2)
	right_speed	Right Speed (m/s)
	raw	Raw Payload data byte list to parse
	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 Speed

Definition at line 1291 of file payloads.py.

def clearpath::horizon::payloads::DifferentialSpeed::print_format ( self )

Human Readable Payload String.

Return the payload as a human readable string

Definition at line 1369 of file payloads.py.

Definition at line 1295 of file payloads.py.

Definition at line 1296 of file payloads.py.

Definition at line 1297 of file payloads.py.

Definition at line 1298 of file payloads.py.

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