Home IO Control
ESPHome add-on for IO-Homecontrol devices
Loading...
Searching...
No Matches
__init__.py
Go to the documentation of this file.
1## @file
2## @brief ESPHome hub schema and code generation for Home IO Control.
3## @ingroup hioc_codegen
4##
5## Defines the top-level ``home_io_control:`` schema (CONFIG_SCHEMA, FINAL_VALIDATE_SCHEMA)
6## and the hub's to_code(). The parts it composes live in leaf modules that never import
7## this file: hub_names.py (YAML keys, C++ handles), hub_validators.py (option tables and
8## field validators), oneway_controllers.py, hub_entities.py and lr1121_update_codegen.py.
9## ESPHome requires the component's schema, to_code() and metadata to live here.
10
11import esphome.codegen as cg
12import esphome.config_validation as cv
13from esphome import pins
14from esphome.components import spi
15from esphome.const import CONF_ID
16
17from . import tuning as tuning_module
18from .hub_names import (
19 CONF_ACCEPT_FOREIGN_PAIRING,
20 CONF_ACCEPT_FOREIGN_PAIRING_SWITCH_ID,
21 CONF_BUSY_PIN,
22 CONF_DIAGNOSTIC_PROBES,
23 CONF_DIO0_PIN,
24 CONF_DIO1_PIN,
25 CONF_DIO4_PIN,
26 CONF_DISCOVER_AND_PAIR_BUTTON,
27 CONF_EXPOSED_SENDERS,
28 CONF_FEM,
29 CONF_FEM_EN_PIN,
30 CONF_FEM_PA_PIN,
31 CONF_LR1121_FIRMWARE_UPDATE,
32 CONF_NODE_ID,
33 CONF_ONEWAY_CONTROLLERS,
34 CONF_PA_PIN,
35 CONF_RADIO_TYPE,
36 CONF_RECOVER_ONEWAY_KEY,
37 CONF_RECOVER_ONEWAY_KEY_SWITCH_ID,
38 CONF_RST_PIN,
39 CONF_SCAN_PAIRED_DEVICES_BUTTON,
40 CONF_SYSTEM_KEY,
41 CONF_TCXO_VOLTAGE,
42 CONF_TX_POWER,
43 CONF_VFEM_PIN,
44 IOHomeAcceptForeignPairingSwitch,
45 IOHomeControlComponent,
46 IOHomeRecoverOneWayKeySwitch,
47)
48from .hub_validators import (
49 FEM_PROFILES,
50 PA_PIN_OPTIONS,
51 RADIO_TYPE_OPTIONS,
52 TCXO_VOLTAGE_OPTIONS,
53 validate_fem,
54 validate_device_id,
55 validate_node_id,
56 validate_system_key,
57)
58from .lr1121_update_codegen import (
59 LR1121_FIRMWARE_UPDATE_SCHEMA,
60 create_lr1121_firmware_update,
61 validate_lr1121_firmware_update,
62)
63from .oneway_controllers import (
64 ONEWAY_CONTROLLER_SCHEMA,
65 create_oneway_controller_entities,
66 final_validate_oneway_controller_addresses,
67 validate_oneway_controllers,
68 oneway_controller_expression,
69)
70from .hub_entities import (
71 create_discover_and_pair_button,
72 create_hub_arming_switch,
73 create_scan_paired_devices_button,
74 inject_accept_foreign_pairing_switch_id,
75 inject_discover_and_pair_button_id,
76 inject_discover_and_pair_result_sensor_id,
77 inject_recover_oneway_key_switch_id,
78 inject_scan_paired_devices_button_id,
79)
80
81# Re-exported for the platform modules (button.py, cover.py, platform_common.py, ...), which
82# import these names from the package itself. CONF_DISCOVER_AND_PAIR_BUTTON,
83# IOHomeControlComponent and validate_device_id are re-exported too; this file already imports
84# them above for its own use.
85from .hub_names import ( # noqa: F401
86 CONF_HOME_IO_CONTROL_ID,
87 CONF_LOW_POWER,
88 IOHomeDiscoverButton,
89 IOHomePairingResultTextSensor,
90 home_io_control_ns,
91)
92from .hub_validators import ( # noqa: F401
93 device_type_expression,
94 inherit_esphome_device,
95 validate_device_type,
96 validate_linked_remote_entry,
97 validate_status_poll_interval,
98)
99
100DEPENDENCIES = ["api", "spi"]
101AUTO_LOAD = ["button", "climate", "cover", "light", "lock", "number", "select", "sensor", "switch", "text_sensor"]
102MULTI_CONF = False
103
104
105FINAL_VALIDATE_SCHEMA = final_validate_oneway_controller_addresses
106
107
108CONFIG_SCHEMA = cv.All(
109 cv.Schema(
110 {
111 cv.GenerateID(): cv.declare_id(IOHomeControlComponent),
112 cv.Required(CONF_RST_PIN): pins.internal_gpio_output_pin_schema,
113 cv.Optional(CONF_DIO0_PIN): pins.internal_gpio_input_pin_schema,
114 cv.Optional(CONF_DIO4_PIN): pins.internal_gpio_input_pin_schema,
115 # The chip's IRQ line: SX1262's DIO1, or LR1121's DIO9
116 cv.Optional(CONF_DIO1_PIN): pins.internal_gpio_input_pin_schema,
117 cv.Optional(CONF_BUSY_PIN): pins.internal_gpio_input_pin_schema,
118 cv.Required(CONF_NODE_ID): validate_node_id,
119 cv.Required(CONF_SYSTEM_KEY): cv.sensitive(validate_system_key),
120 cv.Optional(CONF_TX_POWER, default=17): cv.int_range(min=0, max=22),
121 cv.Optional(CONF_PA_PIN, default="BOOST"): cv.enum(
122 PA_PIN_OPTIONS, upper=True
123 ),
124 cv.Required(CONF_RADIO_TYPE): cv.enum(RADIO_TYPE_OPTIONS, lower=True),
125 cv.Optional(CONF_FEM_EN_PIN): pins.internal_gpio_output_pin_schema,
126 cv.Optional(CONF_VFEM_PIN): pins.internal_gpio_output_pin_schema,
127 cv.Optional(CONF_FEM_PA_PIN): pins.internal_gpio_output_pin_schema,
128 cv.Optional(CONF_FEM, default="none"): cv.one_of(*FEM_PROFILES, lower=True),
129 cv.Optional(CONF_TCXO_VOLTAGE, default="1_8V"): cv.enum(
130 TCXO_VOLTAGE_OPTIONS, upper=True
131 ),
132 cv.Optional(CONF_EXPOSED_SENDERS, default=[]): cv.ensure_list(
133 validate_device_id
134 ),
135 cv.Optional(CONF_ACCEPT_FOREIGN_PAIRING, default=False): cv.boolean,
136 cv.Optional(CONF_RECOVER_ONEWAY_KEY, default=False): cv.boolean,
137 cv.Optional(CONF_SCAN_PAIRED_DEVICES_BUTTON, default=False): cv.boolean,
138 cv.Optional(CONF_DISCOVER_AND_PAIR_BUTTON, default=False): cv.boolean,
139 cv.Optional(CONF_ONEWAY_CONTROLLERS, default=[]): cv.ensure_list(
140 ONEWAY_CONTROLLER_SCHEMA
141 ),
142 cv.Optional(CONF_DIAGNOSTIC_PROBES, default=False): cv.boolean,
143 cv.Optional(CONF_LR1121_FIRMWARE_UPDATE): LR1121_FIRMWARE_UPDATE_SCHEMA,
144 cv.Optional(tuning_module.CONF_TUNING): tuning_module.TUNING_CONFIG_SCHEMA,
145 }
146 )
147 .extend(cv.COMPONENT_SCHEMA)
148 .extend(spi.spi_device_schema(True, 8e6, "mode0")),
149 inject_accept_foreign_pairing_switch_id,
150 inject_recover_oneway_key_switch_id,
151 inject_scan_paired_devices_button_id,
152 inject_discover_and_pair_button_id,
153 inject_discover_and_pair_result_sensor_id,
154 validate_oneway_controllers,
155 validate_lr1121_firmware_update,
156 validate_fem,
157)
158
159
160async def to_code(config):
161 # Hub-level management actions and result events are compiled behind native API
162 # feature flags. Home IO Control enables the required compile-time switches here
163 # so users only need a normal `api:` block in YAML.
164 # ESPHome 2026.x additionally gates user-defined actions behind
165 # USE_API_USER_DEFINED_ACTIONS.
166 cg.add_define("USE_API_USER_DEFINED_ACTIONS")
167 cg.add_define("USE_API_CUSTOM_SERVICES")
168 cg.add_define("USE_API_HOMEASSISTANT_SERVICES")
169
170 var = cg.new_Pvariable(config[CONF_ID])
171 await cg.register_component(var, config)
172 await spi.register_spi_device(var, config)
173
174 rst_pin = await cg.gpio_pin_expression(config[CONF_RST_PIN])
175 cg.add(var.set_rst_pin(rst_pin))
176
177 if CONF_DIO0_PIN in config:
178 dio0_pin = await cg.gpio_pin_expression(config[CONF_DIO0_PIN])
179 cg.add(var.set_dio0_pin(dio0_pin))
180
181 if CONF_DIO4_PIN in config:
182 dio4_pin = await cg.gpio_pin_expression(config[CONF_DIO4_PIN])
183 cg.add(var.set_dio4_pin(dio4_pin))
184
185 if CONF_DIO1_PIN in config:
186 dio1_pin = await cg.gpio_pin_expression(config[CONF_DIO1_PIN])
187 cg.add(var.set_dio1_pin(dio1_pin))
188
189 if CONF_BUSY_PIN in config:
190 busy_pin = await cg.gpio_pin_expression(config[CONF_BUSY_PIN])
191 cg.add(var.set_busy_pin(busy_pin))
192
193 if CONF_FEM_EN_PIN in config:
194 fem_en_pin = await cg.gpio_pin_expression(config[CONF_FEM_EN_PIN])
195 cg.add(var.set_fem_en_pin(fem_en_pin))
196
197 if CONF_VFEM_PIN in config:
198 vfem_pin = await cg.gpio_pin_expression(config[CONF_VFEM_PIN])
199 cg.add(var.set_vfem_pin(vfem_pin))
200
201 if CONF_FEM_PA_PIN in config:
202 fem_pa_pin = await cg.gpio_pin_expression(config[CONF_FEM_PA_PIN])
203 cg.add(var.set_fem_pa_pin(fem_pa_pin))
204
205 cg.add(var.set_fem_profile(FEM_PROFILES[config[CONF_FEM]]))
206
207 cg.add(var.set_node_id(config[CONF_NODE_ID]))
208 cg.add(var.set_system_key(config[CONF_SYSTEM_KEY]))
209 cg.add(var.set_tx_power(config[CONF_TX_POWER]))
210 cg.add(var.set_pa_pin(config[CONF_PA_PIN]))
211
212 cg.add(var.set_radio_type(config[CONF_RADIO_TYPE]))
213
214 cg.add(var.set_tcxo_voltage(config[CONF_TCXO_VOLTAGE]))
215
216 for sender_id in config[CONF_EXPOSED_SENDERS]:
217 cg.add(var.add_exposed_sender(sender_id))
218
219 for identity in config[CONF_ONEWAY_CONTROLLERS]:
220 cg.add(
221 var.add_oneway_controller(
222 oneway_controller_expression(identity, config[CONF_NODE_ID])
223 )
224 )
225 await create_oneway_controller_entities(identity, var)
226
227 if config[CONF_ACCEPT_FOREIGN_PAIRING]:
228 await create_hub_arming_switch(
229 config,
230 var,
231 cls=IOHomeAcceptForeignPairingSwitch,
232 id_key=CONF_ACCEPT_FOREIGN_PAIRING_SWITCH_ID,
233 name="Recover System Key",
234 )
235
236 if config[CONF_RECOVER_ONEWAY_KEY]:
237 await create_hub_arming_switch(
238 config,
239 var,
240 cls=IOHomeRecoverOneWayKeySwitch,
241 id_key=CONF_RECOVER_ONEWAY_KEY_SWITCH_ID,
242 name="Recover 1W Controller Key",
243 )
244
245 if config[CONF_SCAN_PAIRED_DEVICES_BUTTON]:
246 await create_scan_paired_devices_button(config, var)
247
248 if config[CONF_DISCOVER_AND_PAIR_BUTTON]:
249 await create_discover_and_pair_button(config, var)
250
251 cg.add(var.set_diagnostic_probes_enabled(config[CONF_DIAGNOSTIC_PROBES]))
252
253 if CONF_LR1121_FIRMWARE_UPDATE in config:
254 await create_lr1121_firmware_update(config, var)
255
256 if tuning_module.CONF_TUNING in config:
257 await tuning_module.to_code(config[tuning_module.CONF_TUNING], var)
home_io_control.to_code
to_code(config)
Definition __init__.py:160