Midnight Sun Firmware
Loading...
Searching...
No Matches
FotaPacket

Public Member Functions

None __init__ (self, int packet_type, int datagram_id, int sequence_num, bytes payload)
 
str __repr__ (self)
 
bytearray pack (self)
 
def packet_type (self)
 
def datagram_id (self)
 
def sequence_num (self)
 
def payload_len (self)
 
def payload (self)
 
def crc32_value (self)
 

Static Public Attributes

int SOF = 0xAA
 
int EOF = 0xBB
 
int MAX_PAYLOAD_BYTES = 64
 

Static Private Member Functions

None _check_args (int packet_type, int datagram_id, int sequence_num, bytes payload)
 

Private Attributes

 _packet_type
 
 _datagram_id
 
 _sequence_num
 
 _payload
 
 _payload_len
 
 _crc32_value
 

Detailed Description

@brief Defines serialized format of a FOTA packet

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
int  packet_type,
int  datagram_id,
int  sequence_num,
bytes  payload 
)
@brief Initialize FotaPacket object

Member Function Documentation

◆ __repr__()

str __repr__ (   self)
@brief Readable representation of FotaPacket object

◆ _check_args()

None _check_args ( int  packet_type,
int  datagram_id,
int  sequence_num,
bytes  payload 
)
staticprivate
@brief Validate byte sizes of object parameters

◆ crc32_value()

def crc32_value (   self)
@brief Packet CRC32 value

◆ datagram_id()

def datagram_id (   self)
@brief Datagram ID number

◆ pack()

bytearray pack (   self)
@brief Serialize packet values for transmission

◆ packet_type()

def packet_type (   self)
@brief Packet type

◆ payload()

def payload (   self)
@brief Packet payload

◆ payload_len()

def payload_len (   self)
@brief Packet payload length

◆ sequence_num()

def sequence_num (   self)
@brief Packet sequence number

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