clearpath.horizon.payloads.Orientation Class Reference

Horizon Message Payload - Orientation. More...

Inheritance diagram for clearpath.horizon.payloads.Orientation:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Orientation.
def	print_format
	Human Readable Payload String.
Public Attributes
	pitch
	roll
	yaw

---

Detailed Description

Horizon Message Payload - Orientation.

Represents the payload of the data message 'orientation'

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - Orientation

Definition at line 2554 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.Orientation.__init__	(		self,
			roll = 0,
			pitch = 0,
			yaw = 0,
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Orientation.

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

• Orientation(roll, pitch, yaw, raw=None, ...)
  Create a command message payload to send.
  
• Orientation(raw, version, timestamp)
  Parse raw data (most likely received) into payload variables.
  

Parameters:

pitch	The vehicle's pitch angle
raw	Raw Payload data byte list to parse
roll	The vehicle's roll angle
timestamp	Payload Send / Create Time (milliseconds)
version	Horizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)
yaw	The vehicle's yaw (magnetic) angle

Exceptions:

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

Create A Horizon Message Payload - Orientation

Definition at line 2578 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.Orientation.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 2621 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.Orientation::pitch

Definition at line 2578 of file payloads.py.

clearpath::horizon::payloads.Orientation::roll

Definition at line 2578 of file payloads.py.

clearpath::horizon::payloads.Orientation::yaw

Definition at line 2578 of file payloads.py.

---

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

• payloads.py