clearpath::horizon::payloads::FirmwareInfo Class Reference

Horizon Message Payload - Firmware Information. More...

Inheritance diagram for clearpath::horizon::payloads::FirmwareInfo:

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Firmware Information.
def	print_format
	Human Readable Payload String.
Public Attributes
	firmware
	version
	written

Detailed Description

Horizon Message Payload - Firmware Information.

Represents the payload of the data message 'firmware information'

Horizon Message Payload - Firmare Information

Definition at line 795 of file payloads.py.

def clearpath::horizon::payloads::FirmwareInfo::__init__	(	self,
		firmware = `tuple([1,0]`,
		raw = `None`,
		timestamp = `0`,
		written = `datetime.datetime(2000,1`
	)

Create A Horizon Message Payload - Firmware Information.

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

FirmwareInformation(firmware, raw=None, version,...)
Create a command message payload to send.
FirmwareInformation(raw, version, timestamp)
Parse raw data (most likely received) into payload variables.
Version auto-detection is supported.

Parameters:

	firmware	Firmware version (major,minor)
	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)
	written	Time & Date written (year: 2000-2127)

Exceptions:

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

Create A Horizon Message Payload - Firmware Information

Definition at line 820 of file payloads.py.

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

Human Readable Payload String.

Return the payload as a human readable string

Definition at line 863 of file payloads.py.

Definition at line 839 of file payloads.py.

Definition at line 830 of file payloads.py.

Definition at line 853 of file payloads.py.

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