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

All runtime tunable parameters for pairing and radio diagnostics. More...

#include <tuning_config.h>

Collaboration diagram for esphome::home_io_control::TuningConfig:

Public Attributes

SX1262RxBandwidth sx1262_rx_bandwidth {SX1262RxBandwidth::BW_117_3_KHZ}
 SX1262 RX bandwidth selector.
uint16_t sx1262_response_preamble {SX1262_RESPONSE_PREAMBLE}
 SX1262 response preamble in bytes.
uint16_t sx1262_post_tx_settle_us {SX1262_POST_TX_SETTLE_US}
 Delay after SX1262 TX before RX (µs).
SX1276RxBandwidth sx1276_rx_bandwidth {SX1276RxBandwidth::BW_41_7_KHZ}
 SX1276 RX bandwidth selector.
uint16_t sx1276_response_preamble {SX1276_RESPONSE_PREAMBLE}
 SX1276 response preamble in bytes.
uint16_t sx1276_discovery_hop_slice_ms
 Per-channel dwell while SX1276 discovery hops.
uint16_t sx1262_discovery_hop_slice_ms
 Per-channel dwell while SX1262 discovery hops.
LR1121RxBandwidth lr1121_rx_bandwidth {LR1121RxBandwidth::BW_117_3_KHZ}
 LR1121 RX bandwidth selector.
uint16_t lr1121_response_preamble {LR1121_RESPONSE_PREAMBLE}
 LR1121 response preamble in bytes.
uint16_t lr1121_post_tx_settle_us {LR1121_POST_TX_SETTLE_US}
 Delay after LR1121 TX before RX (µs).
uint16_t lr1121_discovery_hop_slice_ms
 Per-channel dwell while LR1121 discovery hops.
uint8_t lbt_max_retries {LBT_MAX_RETRIES}
 LBT retries before forced TX.
int16_t lbt_rssi_threshold_dbm {LBT_RSSI_THRESHOLD_DBM}
 LBT channel-free threshold (dBm).
uint16_t exchange_start_response_wait_ms
 Reply window for a start frame (wakes a sleeping device).
uint16_t exchange_response_wait_ms
 Reply window for continuation frames and the post-auth final response.
std::vector< DiscoveryCommand > pairing_discovery_commands
 Ordered discovery commands.
std::vector< uint8_t > pairing_discovery_destination {0x00, 0x00, 0x00}
 Destination when auto=false.
bool pairing_discovery_destination_auto {true}
 When true, map commands to conventional addresses.
uint8_t pairing_discovery_payload {0}
 Optional payload byte (used for 0x2E).
bool pairing_discovery_payload_enabled {false}
 Whether the optional payload is enabled.
bool pairing_discovery_low_power {false}
 Set LOW_POWER flag in discovery frames.
uint16_t pairing_discovery_wait_ms
 Total wait window after sending discovery commands.
uint16_t pairing_discovery_initial_dwell_ms
 Initial dwell on CH2 before discovery hopping begins.
uint8_t pairing_key_exchange_retries
 Retries for the authenticated key exchange phase.
bool active {false}
 True when the YAML tuning: block is present.

Detailed Description

All runtime tunable parameters for pairing and radio diagnostics.

Values reset to their defaults on every boot. Each field initializes from a canonical constant — chip-neutral defaults live in proto_timing.h, chip-specific defaults in this header — shared with the ESPHome YAML schema. The hub stores a single TuningConfig instance and passes it to the radio driver and pairing flow. UI callbacks update the hub instance directly; the snapshot helpers emit the current values in YAML-compatible form so a working combination can be copied back into the configuration file.

Definition at line 161 of file tuning_config.h.

Member Data Documentation

◆ active

bool esphome::home_io_control::TuningConfig::active {false}

True when the YAML tuning: block is present.

Definition at line 206 of file tuning_config.h.

◆ exchange_response_wait_ms

uint16_t esphome::home_io_control::TuningConfig::exchange_response_wait_ms
Initial value:
{
RESPONSE_WAIT_MS}
esphome::home_io_control::RESPONSE_WAIT_MS
static constexpr int32_t RESPONSE_WAIT_MS
Wait for response to non-start frame.
Definition proto_timing.h:41

Reply window for continuation frames and the post-auth final response.

Definition at line 187 of file tuning_config.h.

◆ exchange_start_response_wait_ms

uint16_t esphome::home_io_control::TuningConfig::exchange_start_response_wait_ms
Initial value:
{
RESPONSE_START_WAIT_MS}
esphome::home_io_control::RESPONSE_START_WAIT_MS
static constexpr int32_t RESPONSE_START_WAIT_MS
Wait for a response to a start frame — the first frame of an exchange, and the one a sleeping device ...
Definition proto_timing.h:67

Reply window for a start frame (wakes a sleeping device).

Definition at line 185 of file tuning_config.h.

◆ lbt_max_retries

uint8_t esphome::home_io_control::TuningConfig::lbt_max_retries {LBT_MAX_RETRIES}

LBT retries before forced TX.

Definition at line 177 of file tuning_config.h.

◆ lbt_rssi_threshold_dbm

int16_t esphome::home_io_control::TuningConfig::lbt_rssi_threshold_dbm {LBT_RSSI_THRESHOLD_DBM}

LBT channel-free threshold (dBm).

Definition at line 178 of file tuning_config.h.

◆ lr1121_discovery_hop_slice_ms

uint16_t esphome::home_io_control::TuningConfig::lr1121_discovery_hop_slice_ms
Initial value:
{
LR1121_DISCOVERY_HOP_SLICE_MS}
esphome::home_io_control::LR1121_DISCOVERY_HOP_SLICE_MS
static constexpr uint16_t LR1121_DISCOVERY_HOP_SLICE_MS
Per-channel dwell while LR1121 pairing discovery hops across channels.
Definition tuning_config.h:150

Per-channel dwell while LR1121 discovery hops.

Definition at line 175 of file tuning_config.h.

◆ lr1121_post_tx_settle_us

uint16_t esphome::home_io_control::TuningConfig::lr1121_post_tx_settle_us {LR1121_POST_TX_SETTLE_US}

Delay after LR1121 TX before RX (µs).

Definition at line 174 of file tuning_config.h.

◆ lr1121_response_preamble

uint16_t esphome::home_io_control::TuningConfig::lr1121_response_preamble {LR1121_RESPONSE_PREAMBLE}

LR1121 response preamble in bytes.

Definition at line 173 of file tuning_config.h.

◆ lr1121_rx_bandwidth

LR1121RxBandwidth esphome::home_io_control::TuningConfig::lr1121_rx_bandwidth {LR1121RxBandwidth::BW_117_3_KHZ}

LR1121 RX bandwidth selector.

Definition at line 172 of file tuning_config.h.

◆ pairing_discovery_commands

std::vector<DiscoveryCommand> esphome::home_io_control::TuningConfig::pairing_discovery_commands
Initial value:
{
DiscoveryCommand::DISCOVER}
esphome::home_io_control::DiscoveryCommand::DISCOVER
@ DISCOVER
Standard broadcast discovery request (to 0x00003B).
Definition tuning_config.h:72

Ordered discovery commands.

Definition at line 191 of file tuning_config.h.

◆ pairing_discovery_destination

std::vector<uint8_t> esphome::home_io_control::TuningConfig::pairing_discovery_destination {0x00, 0x00, 0x00}

Destination when auto=false.

Definition at line 193 of file tuning_config.h.

◆ pairing_discovery_destination_auto

bool esphome::home_io_control::TuningConfig::pairing_discovery_destination_auto {true}

When true, map commands to conventional addresses.

Definition at line 194 of file tuning_config.h.

◆ pairing_discovery_initial_dwell_ms

uint16_t esphome::home_io_control::TuningConfig::pairing_discovery_initial_dwell_ms
Initial value:
{
PAIRING_DISCOVERY_INITIAL_DWELL_MS}
esphome::home_io_control::PAIRING_DISCOVERY_INITIAL_DWELL_MS
static constexpr uint16_t PAIRING_DISCOVERY_INITIAL_DWELL_MS
Dwell on CH2 before discovery hopping begins.
Definition proto_timing.h:90

Initial dwell on CH2 before discovery hopping begins.

Definition at line 200 of file tuning_config.h.

◆ pairing_discovery_low_power

bool esphome::home_io_control::TuningConfig::pairing_discovery_low_power {false}

Set LOW_POWER flag in discovery frames.

Definition at line 197 of file tuning_config.h.

◆ pairing_discovery_payload

uint8_t esphome::home_io_control::TuningConfig::pairing_discovery_payload {0}

Optional payload byte (used for 0x2E).

Definition at line 195 of file tuning_config.h.

◆ pairing_discovery_payload_enabled

bool esphome::home_io_control::TuningConfig::pairing_discovery_payload_enabled {false}

Whether the optional payload is enabled.

Definition at line 196 of file tuning_config.h.

◆ pairing_discovery_wait_ms

uint16_t esphome::home_io_control::TuningConfig::pairing_discovery_wait_ms
Initial value:
{
PAIRING_DISCOVERY_WAIT_MS}
esphome::home_io_control::PAIRING_DISCOVERY_WAIT_MS
static constexpr uint16_t PAIRING_DISCOVERY_WAIT_MS
Canonical defaults for the chip-neutral runtime-tunable pairing/discovery parameters.
Definition proto_timing.h:89

Total wait window after sending discovery commands.

Definition at line 198 of file tuning_config.h.

◆ pairing_key_exchange_retries

uint8_t esphome::home_io_control::TuningConfig::pairing_key_exchange_retries
Initial value:
{
PAIRING_KEY_EXCHANGE_RETRIES}
esphome::home_io_control::PAIRING_KEY_EXCHANGE_RETRIES
static constexpr uint8_t PAIRING_KEY_EXCHANGE_RETRIES
Retries for the authenticated key-exchange phase.
Definition proto_timing.h:91

Retries for the authenticated key exchange phase.

Definition at line 202 of file tuning_config.h.

◆ sx1262_discovery_hop_slice_ms

uint16_t esphome::home_io_control::TuningConfig::sx1262_discovery_hop_slice_ms
Initial value:
{
SX1262_DISCOVERY_HOP_SLICE_MS}
esphome::home_io_control::SX1262_DISCOVERY_HOP_SLICE_MS
static constexpr uint16_t SX1262_DISCOVERY_HOP_SLICE_MS
Per-channel dwell while SX1262 pairing discovery hops across channels.
Definition tuning_config.h:131

Per-channel dwell while SX1262 discovery hops.

Definition at line 170 of file tuning_config.h.

◆ sx1262_post_tx_settle_us

uint16_t esphome::home_io_control::TuningConfig::sx1262_post_tx_settle_us {SX1262_POST_TX_SETTLE_US}

Delay after SX1262 TX before RX (µs).

Definition at line 165 of file tuning_config.h.

◆ sx1262_response_preamble

uint16_t esphome::home_io_control::TuningConfig::sx1262_response_preamble {SX1262_RESPONSE_PREAMBLE}

SX1262 response preamble in bytes.

Definition at line 164 of file tuning_config.h.

◆ sx1262_rx_bandwidth

SX1262RxBandwidth esphome::home_io_control::TuningConfig::sx1262_rx_bandwidth {SX1262RxBandwidth::BW_117_3_KHZ}

SX1262 RX bandwidth selector.

Definition at line 163 of file tuning_config.h.

◆ sx1276_discovery_hop_slice_ms

uint16_t esphome::home_io_control::TuningConfig::sx1276_discovery_hop_slice_ms
Initial value:
{
SX1276_DISCOVERY_HOP_SLICE_MS}
esphome::home_io_control::SX1276_DISCOVERY_HOP_SLICE_MS
static constexpr uint16_t SX1276_DISCOVERY_HOP_SLICE_MS
Per-channel dwell while SX1276 pairing discovery hops across channels.
Definition tuning_config.h:124

Per-channel dwell while SX1276 discovery hops.

Definition at line 168 of file tuning_config.h.

◆ sx1276_response_preamble

uint16_t esphome::home_io_control::TuningConfig::sx1276_response_preamble {SX1276_RESPONSE_PREAMBLE}

SX1276 response preamble in bytes.

Definition at line 167 of file tuning_config.h.

◆ sx1276_rx_bandwidth

SX1276RxBandwidth esphome::home_io_control::TuningConfig::sx1276_rx_bandwidth {SX1276RxBandwidth::BW_41_7_KHZ}

SX1276 RX bandwidth selector.

Definition at line 166 of file tuning_config.h.

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