Home IO Control
ESPHome add-on for IO-Homecontrol devices
Loading...
Searching...
No Matches
esphome::home_io_control::RadioCaptureInfo Struct Reference

Diagnostic capture from a radio operation. More...

#include <radio_interface.h>

Collaboration diagram for esphome::home_io_control::RadioCaptureInfo:

Public Attributes

bool valid {false}
 True if capture is valid.
bool blocking_wait {false}
 True if captured during a blocking wait.
bool rx_done {false}
 True if RxDone IRQ fired.
bool crc_error {false}
 True if CRC error detected (SX1276: never set in IoHomeOn mode; SX1262: set on bad CRC).
uint32_t timestamp_ms {0}
 Timestamp of capture (millis).
uint32_t freq_hz {0}
 RF frequency of capture (Hz).
int16_t rssi_dbm {0}
 Received signal strength (dBm).
uint16_t irq_status {0}
 Raw IRQ status register value.
uint8_t irq_flags1 {0}
 IRQ flags group 1 (chip-specific).
uint8_t irq_flags2 {0}
 IRQ flags group 2 (chip-specific, includes CRC flag).
uint8_t packet_status {0}
 Packet status byte (chip-specific).
uint8_t rx_offset {0}
 RX buffer offset where frame starts (SX1262).
uint8_t reported_len {0}
 Length reported by the radio chip.
uint8_t raw_len {0}
 Number of valid bytes in raw[].
uint8_t frame_len {0}
 Number of valid bytes in frame[].
uint8_t raw [RADIO_PACKET_BUFFER_SIZE] {}
 Raw radio buffer bytes.
uint8_t frame [RADIO_PACKET_BUFFER_SIZE] {}
 Parsed protocol frame bytes.

Detailed Description

Diagnostic capture from a radio operation.

Populated after every wait_for_packet / check_for_packet. Contains both the raw bytes reported by the chip (before any protocol-specific recovery) and the parsed frame handed to the protocol layer.

Definition at line 63 of file radio_interface.h.

Member Data Documentation

◆ blocking_wait

bool esphome::home_io_control::RadioCaptureInfo::blocking_wait {false}

True if captured during a blocking wait.

Definition at line 65 of file radio_interface.h.

◆ crc_error

bool esphome::home_io_control::RadioCaptureInfo::crc_error {false}

True if CRC error detected (SX1276: never set in IoHomeOn mode; SX1262: set on bad CRC).

Definition at line 67 of file radio_interface.h.

◆ frame

uint8_t esphome::home_io_control::RadioCaptureInfo::frame[RADIO_PACKET_BUFFER_SIZE] {}

Parsed protocol frame bytes.

Definition at line 83 of file radio_interface.h.

◆ frame_len

uint8_t esphome::home_io_control::RadioCaptureInfo::frame_len {0}

Number of valid bytes in frame[].

Definition at line 81 of file radio_interface.h.

◆ freq_hz

uint32_t esphome::home_io_control::RadioCaptureInfo::freq_hz {0}

RF frequency of capture (Hz).

Definition at line 69 of file radio_interface.h.

◆ irq_flags1

uint8_t esphome::home_io_control::RadioCaptureInfo::irq_flags1 {0}

IRQ flags group 1 (chip-specific).

Definition at line 72 of file radio_interface.h.

◆ irq_flags2

uint8_t esphome::home_io_control::RadioCaptureInfo::irq_flags2 {0}

IRQ flags group 2 (chip-specific, includes CRC flag).

Definition at line 73 of file radio_interface.h.

◆ irq_status

uint16_t esphome::home_io_control::RadioCaptureInfo::irq_status {0}

Raw IRQ status register value.

Definition at line 71 of file radio_interface.h.

◆ packet_status

uint8_t esphome::home_io_control::RadioCaptureInfo::packet_status {0}

Packet status byte (chip-specific).

Definition at line 74 of file radio_interface.h.

◆ raw

uint8_t esphome::home_io_control::RadioCaptureInfo::raw[RADIO_PACKET_BUFFER_SIZE] {}

Raw radio buffer bytes.

Definition at line 82 of file radio_interface.h.

◆ raw_len

uint8_t esphome::home_io_control::RadioCaptureInfo::raw_len {0}

Number of valid bytes in raw[].

Definition at line 80 of file radio_interface.h.

◆ reported_len

uint8_t esphome::home_io_control::RadioCaptureInfo::reported_len {0}

Length reported by the radio chip.

Definition at line 76 of file radio_interface.h.

◆ rssi_dbm

int16_t esphome::home_io_control::RadioCaptureInfo::rssi_dbm {0}

Received signal strength (dBm).

Definition at line 70 of file radio_interface.h.

◆ rx_done

bool esphome::home_io_control::RadioCaptureInfo::rx_done {false}

True if RxDone IRQ fired.

Definition at line 66 of file radio_interface.h.

◆ rx_offset

uint8_t esphome::home_io_control::RadioCaptureInfo::rx_offset {0}

RX buffer offset where frame starts (SX1262).

Definition at line 75 of file radio_interface.h.

◆ timestamp_ms

uint32_t esphome::home_io_control::RadioCaptureInfo::timestamp_ms {0}

Timestamp of capture (millis).

Definition at line 68 of file radio_interface.h.

◆ valid

bool esphome::home_io_control::RadioCaptureInfo::valid {false}

True if capture is valid.

Definition at line 64 of file radio_interface.h.


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