clearpath.horizon.payloads.SystemStatus Class Reference

Horizon Message Payload - System Status. More...

Inheritance diagram for clearpath.horizon.payloads.SystemStatus:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - System Status.
def	print_format
	Human Readable Payload String.
Public Attributes
	currents
	temperatures
	uptime
	voltages

---

Detailed Description

Horizon Message Payload - System Status.

Represents the payload of the data message 'system status'

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - System Status

Definition at line 879 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.SystemStatus.__init__	(		self,
			uptime = 0,
			voltage = [],
			current = [],
			temperature = [],
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - System Status.

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

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

Parameters:

current	A list of currents [-320A,320A]
raw	Raw Payload data byte list to parse
temperature	A list of temperatures [-320 degC, 320 degC]
timestamp	Payload Send / Create Time (milliseconds)
uptime	System uptime ([0,4294967295] milliseconds)
version	Horizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)
voltage	A list of voltages [-320V,320V]

Exceptions:

LookupError	If auto-detect version fails
ValueError	If raw is invalid

Create A Horizon Message Payload - System Status

Definition at line 905 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.SystemStatus.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 975 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.SystemStatus::currents

Definition at line 905 of file payloads.py.

clearpath::horizon::payloads.SystemStatus::temperatures

Definition at line 905 of file payloads.py.

clearpath::horizon::payloads.SystemStatus::uptime

Definition at line 905 of file payloads.py.

clearpath::horizon::payloads.SystemStatus::voltages

Definition at line 905 of file payloads.py.

---

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

• payloads.py