clearpath.horizon.payloads.PowerStatus Class Reference

Horizon Message Payload - Power Status. More...

Inheritance diagram for clearpath.horizon.payloads.PowerStatus:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Power Status.
def	print_format
	Human Readable Payload String.
Public Attributes
	capacities
	Capacity Measurements.
	charges
	Charge Measurements.
	descriptions
	Battery Descriptions.

---

Detailed Description

Horizon Message Payload - Power Status.

Represents the payload of the data message 'power status'

Warning:

Data should not be modified once created

Since:

0.8

Horizon Message Payload - Power Status

Definition at line 992 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.PowerStatus.__init__	(		self,
			charges = [],
			capacities = [],
			descriptions = [],
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Power Status.

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

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

Parameters:

charges	List of battery percentages
capacities	List of battery capacities
descriptions	List of tuple([present,in_use,type])
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 raw is invalid

Create A Horizon Message Payload - Power Status

Definition at line 1016 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.PowerStatus.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 1104 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.PowerStatus::capacities

Capacity Measurements.

Definition at line 1018 of file payloads.py.

clearpath::horizon::payloads.PowerStatus::charges

Charge Measurements.

Definition at line 1017 of file payloads.py.

clearpath::horizon::payloads.PowerStatus::descriptions

Battery Descriptions.

Definition at line 1019 of file payloads.py.

---

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

• payloads.py