Struct PayloadHeader

pub struct PayloadHeader {
    pub if_type: InterfaceType,
    pub if_num: u8,
    pub flags: u8,
    pub len: u16,
    pub offset: u16,
    pub checksum: u16,
    pub seq_num: u16,
    pub throttle_cmd: u8,
    pub pkt_type: PacketType,
}

Adapted from esp-hosted-mcu/common/esp_hosted_header.h This is at the start of the message, and is followed by the RPC header. See ESP-hosted-MCU readme, section 7.1.

Fields

if_type: InterfaceType

Interface type. Serial, AP etc.

if_num: u8

Interface number. 0 may be a good default?

flags: u8

len: u16

Payload length. The size, in bytes, of everything in the frame following this header

offset: u16

Offset. Always = 12 (This header’s size). Indicates the byte index the payload starts.

checksum: u16

Checksum, calculated over the entire frame.

seq_num: u16

Sequence number for tracking packets (Useful in debugging)

throttle_cmd: u8

Flow control

pkt_type: PacketType

Implementations

impl PayloadHeader

pub fn new( if_type: InterfaceType, if_num: u8, pkt_type: PacketType, payload_len: usize, ) -> Self

pub fn to_bytes(&self) -> [u8; 12]

Serialize into the 12-byte packed representation

pub fn from_bytes(buf: &[u8]) -> Result<Self, EspError>

Parse from a 12-byte slice (will panic if buf.len() < 12 or slice-to-array fails)

Trait Implementations

impl Format for PayloadHeader

where InterfaceType: Format, PacketType: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.