clearpath::horizon::payloads::PowerStatus Class Reference

Horizon Message Payload - Power Status. More...

Inheritance diagram for clearpath::horizon::payloads::PowerStatus:

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'

Horizon Message Payload - Power Status

Definition at line 992 of file payloads.py.

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.

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

Human Readable Payload String.

Return the payload as a human readable string

Definition at line 1104 of file payloads.py.

Capacity Measurements.

Definition at line 1023 of file payloads.py.

Charge Measurements.

Definition at line 1021 of file payloads.py.

Battery Descriptions.

Definition at line 1025 of file payloads.py.

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