tuning.py File Reference

ESPHome tuning schema and code generation for Home IO Control. More...

Go to the source code of this file.

Namespaces
namespace	home_io_control
namespace	home_io_control.tuning

Functions
	home_io_control.tuning._id_key (param_key)
	home_io_control.tuning._one_of_string (param_name, options, coerce_number=False)
	home_io_control.tuning._parse_destination_to_bytes (value)
	home_io_control.tuning._parse_payload (value)
	home_io_control.tuning._inject_tuning_companion_ids (config)
	home_io_control.tuning._cpp_bool (value)
	home_io_control.tuning._assign (struct, field, value)
	home_io_control.tuning._apply_tuning_config (config, var)
	home_io_control.tuning._create_tuning_entities (config, var)
	home_io_control.tuning._create_number (config, var, key, min_value, max_value, step, unit="")
	home_io_control.tuning._create_select (config, var, key, options)
	home_io_control.tuning.to_code (config, var)

Variables
	home_io_control.tuning.home_io_control_ns = cg.esphome_ns.namespace("home_io_control")
str	home_io_control.tuning.CONF_TUNING = "tuning"
str	home_io_control.tuning.CONF_UI_CONTROLS = "ui_controls"
str	home_io_control.tuning._COMPANION_ID_BASE = "home_io_control"
str	home_io_control.tuning.CONF_SX1262_RX_BANDWIDTH = "sx1262_rx_bandwidth"
str	home_io_control.tuning.CONF_SX1262_RESPONSE_PREAMBLE = "sx1262_response_preamble"
str	home_io_control.tuning.CONF_SX1262_POST_TX_SETTLE_US = "sx1262_post_tx_settle_us"
str	home_io_control.tuning.CONF_SX1276_RX_BANDWIDTH = "sx1276_rx_bandwidth"
str	home_io_control.tuning.CONF_SX1276_RESPONSE_PREAMBLE = "sx1276_response_preamble"
str	home_io_control.tuning.CONF_SX1276_DISCOVERY_HOP_SLICE_MS = "sx1276_discovery_hop_slice_ms"
str	home_io_control.tuning.CONF_SX1262_DISCOVERY_HOP_SLICE_MS = "sx1262_discovery_hop_slice_ms"
str	home_io_control.tuning.CONF_LR1121_RX_BANDWIDTH = "lr1121_rx_bandwidth"
str	home_io_control.tuning.CONF_LR1121_RESPONSE_PREAMBLE = "lr1121_response_preamble"
str	home_io_control.tuning.CONF_LR1121_POST_TX_SETTLE_US = "lr1121_post_tx_settle_us"
str	home_io_control.tuning.CONF_LR1121_DISCOVERY_HOP_SLICE_MS = "lr1121_discovery_hop_slice_ms"
str	home_io_control.tuning.CONF_COLD_BROADCAST_REPLY_PREAMBLE = "cold_broadcast_reply_preamble"
str	home_io_control.tuning.CONF_NORMAL_START_PREAMBLE = "normal_start_preamble"
str	home_io_control.tuning.CONF_LBT_MAX_RETRIES = "lbt_max_retries"
str	home_io_control.tuning.CONF_LBT_RSSI_THRESHOLD_DBM = "lbt_rssi_threshold_dbm"
str	home_io_control.tuning.CONF_LOW_POWER_WAKE_BELIEF = "low_power_wake_belief"
str	home_io_control.tuning.CONF_EXCHANGE_START_RESPONSE_WAIT_MS = "exchange_start_response_wait_ms"
str	home_io_control.tuning.CONF_EXCHANGE_RESPONSE_WAIT_MS = "exchange_response_wait_ms"
str	home_io_control.tuning.CONF_EXCHANGE_TOTAL_BUDGET_MS = "exchange_total_budget_ms"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_COMMANDS = "pairing_discovery_commands"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_DESTINATION = "pairing_discovery_destination"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_PAYLOAD = "pairing_discovery_payload"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_LOW_POWER = "pairing_discovery_low_power"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_ACK_CAPABLE = "pairing_discovery_ack_capable"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_PREAMBLE = "pairing_discovery_preamble"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_WAIT_MS = "pairing_discovery_wait_ms"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_INITIAL_DWELL_MS = "pairing_discovery_initial_dwell_ms"
str	home_io_control.tuning.CONF_PAIRING_KEY_EXCHANGE_RETRIES = "pairing_key_exchange_retries"
str	home_io_control.tuning.CONF_SCAN_POWER_CLASSES = "scan_power_classes"
str	home_io_control.tuning.CONF_PAIRING_DISCOVER_CONFIRM = "pairing_discover_confirm"
str	home_io_control.tuning.CONF_PAIRING_DISCOVERY_LISTEN_CHANNELS = "pairing_discovery_listen_channels"
str	home_io_control.tuning.CONF_PAIRING_KEY_INIT_DELAY_MS = "pairing_key_init_delay_ms"
	home_io_control.tuning.TuningConfig = home_io_control_ns.class_("TuningConfig")
	home_io_control.tuning.IOHomeTuningNumber
	home_io_control.tuning.IOHomeTuningSelect
	home_io_control.tuning.SX1262RxBandwidth = home_io_control_ns.enum("SX1262RxBandwidth", is_class=True)
	home_io_control.tuning.SX1276RxBandwidth = home_io_control_ns.enum("SX1276RxBandwidth", is_class=True)
	home_io_control.tuning.LR1121RxBandwidth = home_io_control_ns.enum("LR1121RxBandwidth", is_class=True)
	home_io_control.tuning.DiscoveryCommand = home_io_control_ns.enum("DiscoveryCommand", is_class=True)
	home_io_control.tuning.ScanPowerClasses = home_io_control_ns.enum("ScanPowerClasses", is_class=True)
	home_io_control.tuning.DiscoverConfirmMode = home_io_control_ns.enum("DiscoverConfirmMode", is_class=True)
	home_io_control.tuning.DiscoveryListenChannels = home_io_control_ns.enum("DiscoveryListenChannels", is_class=True)
dict	home_io_control.tuning.SX1262_BANDWIDTH_OPTIONS
dict	home_io_control.tuning.SX1276_BANDWIDTH_OPTIONS
dict	home_io_control.tuning.LR1121_BANDWIDTH_OPTIONS
dict	home_io_control.tuning.DISCOVERY_COMMAND_OPTIONS
list	home_io_control.tuning.DISCOVERY_COMMAND_PRESETS
list	home_io_control.tuning.DISCOVERY_DESTINATION_OPTIONS
list	home_io_control.tuning.PAIRING_DISCOVERY_PAYLOAD_OPTIONS = ["none", "0x00"]
dict	home_io_control.tuning.SCAN_POWER_CLASSES_OPTIONS
dict	home_io_control.tuning.DISCOVER_CONFIRM_MODE_OPTIONS
dict	home_io_control.tuning.DISCOVERY_LISTEN_CHANNELS_OPTIONS
dict	home_io_control.tuning.UI_NAMES
dict	home_io_control.tuning._NUMBER_PARAMS
tuple	home_io_control.tuning._BOOL_PARAMS = (CONF_PAIRING_DISCOVERY_LOW_POWER, CONF_PAIRING_DISCOVERY_ACK_CAPABLE, CONF_LOW_POWER_WAKE_BELIEF)
list	home_io_control.tuning._BOOL_SELECT_OPTIONS = ["Off", "On"]
dict	home_io_control.tuning._SELECT_OPTIONS
	home_io_control.tuning._validate_bandwidth
	home_io_control.tuning._validate_sx1276_bandwidth
	home_io_control.tuning._validate_lr1121_bandwidth
	home_io_control.tuning._validate_discovery_command
	home_io_control.tuning._validate_discovery_destination
	home_io_control.tuning._validate_discovery_payload
	home_io_control.tuning._validate_scan_power_classes
	home_io_control.tuning._validate_discover_confirm_mode
	home_io_control.tuning._validate_discovery_listen_channels
	home_io_control.tuning.TUNING_SCHEMA
	home_io_control.tuning.TUNING_CONFIG_SCHEMA = cv.All(TUNING_SCHEMA, _inject_tuning_companion_ids)

Detailed Description

ESPHome tuning schema and code generation for Home IO Control.

Provides the YAML tuning: block under home_io_control: and optionally generates Home Assistant number and select entities so users can adjust pairing and radio parameters at runtime. Tuned values are volatile and reset on every boot.

Definition in file tuning.py.