Data32bitPacket Class Reference

The Data32bitPacket is used to send 32bit data instructions to the uC all availible instructions are defined in the Data32bitHeader
More...

Inheritance diagram for Data32bitPacket:

Collaboration diagram for Data32bitPacket:

Public Member Functions
def	__init__ (self, header, value=0, time=0)
	constructor for the Data32bitPacket More...
def	__str__ (self)
def	from_bytearray (self, byte_array)
	constructs a Data32bitPacket from a bytearray More...
def	set_header (self, header)
	setter method for the header attribute More...
def	set_value (self, value)
def	to_bytearray (self)
	placeholder for converting the package to a bytearray More...
def	value (self)
	getter method for the value attribute More...
Public Member Functions inherited from Packet
def	__init__ (self)
def	check_and_log (self)
	check_and_log logs the packet if the header is in the logging lists More...
def	from_bytearray (cls, byte_array)
	method to construct a packet from a bytearray depending on the header the correct packet type is returned More...
def	header (self)
	getter method for the header attribute More...
def	set_exec_time (self, time)
	setter method for the execution time attribute More...
def	set_header (self, header)
	setter method for the header attribute More...
def	time (self)
	getter method for the time attribute More...
def	to_bytearray (self)
	placeholder for converting the package to a bytearray More...

Detailed Description

The Data32bitPacket is used to send 32bit data instructions to the uC all availible instructions are defined in the Data32bitHeader

Definition at line 125 of file packet.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			header,
			value = 0,
			time = 0
	)

constructor for the Data32bitPacket

Parameters

header	(Data32bitHeader) the header of the packet
value	(uint_32) the value to be sent (optional, default = 0)
time	(uint_32) the time of execution of the packet (optional, default = 0)

Reimplemented from Packet.

Definition at line 130 of file packet.py.

Member Function Documentation

__str__()

def __str__

(

self

)

Definition at line 162 of file packet.py.

from_bytearray()

def from_bytearray	(		self,
			byte_array
	)

constructs a Data32bitPacket from a bytearray

Parameters

byte_array

9 byte bytearray to construct the Packet from

Returns

: Data32bitPacket @raise Exception: if package construction fails

Reimplemented from Packet.

Definition at line 166 of file packet.py.

set_header()

def set_header	(		self,
			header
	)

setter method for the header attribute

Parameters

header

(byte/uint_8) the header of the packet

Reimplemented from Packet.

Definition at line 147 of file packet.py.

set_value()

def set_value	(		self,
			value
	)

Definition at line 153 of file packet.py.

to_bytearray()

def to_bytearray

(

self

)

placeholder for converting the package to a bytearray

Returns

: the packet as a bytearray

Reimplemented from Packet.

Definition at line 159 of file packet.py.

value()

def value

(

self

)

getter method for the value attribute

Returns

: the value of the packet

Definition at line 141 of file packet.py.

---

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

• /github/workspace/uC_api/packet.py