Home IO Control
ESPHome add-on for IO-Homecontrol devices
Loading...
Searching...
No Matches
hub_status.cpp
Go to the documentation of this file.
1#include "hub_internal.h"
2
3#include "hub_decisions.h"
4#include "proto_commands.h"
5
6#include <cinttypes>
7
8/// @file hub_status.cpp
9/// @brief Inbound status handling and passive receive-side state updates.
10/// @ingroup hioc_hub
11///
12/// This file owns the receive-side state path for the hub:
13/// - decode status-bearing frames into normalized device state,
14/// - decide when passive traffic should arm one-shot or tracked follow-up polls,
15/// - ACK authenticated device-initiated status updates.
16///
17/// @todo Validate the unsolicited CMD_STATUS_UPDATE path on hardware that actually emits
18/// device-initiated updates after pairing, including inbound authentication,
19/// three-channel ACK broadcast, and Home Assistant state publication without polling.
20///
21/// The goal of the split is to keep hub_core.cpp focused on lifecycle,
22/// device registry, and scheduling while leaving the protocol-specific receive
23/// interpretation in one place.
24
25namespace esphome {
26namespace home_io_control {
27
28namespace {
29
30constexpr uint8_t PRIVATE_RESPONSE_MIN_DATA_LEN = 6; ///< Minimum payload length for 0x04 position-bearing replies.
31 ///< Bytes 0–5 (stopped flag + target + current) are mandatory;
32 ///< byte 7 (settle hint) is optional and checked separately.
33constexpr uint8_t STATUS_UPDATE_MIN_DATA_LEN = 11; ///< Minimum payload length for 0x71 device-initiated updates.
34constexpr uint8_t GET_NAME_RESPONSE_MIN_DATA_LEN = 1; ///< Minimum payload length for 0x51 name-bearing replies.
35constexpr uint8_t GET_INFO2_RESPONSE_MIN_DATA_LEN = 12; ///< Minimum payload length for 0x57 type/subtype metadata.
36constexpr uint8_t ERROR_RESPONSE_MIN_DATA_LEN = 1; ///< Minimum payload length for 0xFE result-bearing replies.
37constexpr uint8_t EXTENDED_TILT_RESPONSE_MIN_DATA_LEN =
38 15; ///< Minimum payload length for tilt-capable extended status replies.
39constexpr uint8_t STATUS_STOPPED_FLAGS_OFFSET = 0; ///< Byte containing STATUS_STOPPED.
40constexpr uint8_t PRIVATE_RESPONSE_DELAY_HINT_OFFSET = 7; ///< Coarse follow-up delay hint byte in many 0x04 replies.
41// A 0x04 payload does not describe its own layout — which fields these offsets name depends on
42// the request that drew the reply, and only the caller knows that. A reply to a tilt EXECUTE puts
43// the tilt selector 0x20 at offset 4 and a 16-bit slat angle at 5..6, straddling the bytes a
44// reply to a status poll uses for the current position (4..5). Do not try to recover the
45// difference by sniffing the payload: 0x20 is also a perfectly legal current-position MSB (raw
46// 0x2000-0x20FF is 16.0%-16.5%), and a tilt ack is 8 bytes like any hint-carrying position reply,
47// so neither a `data[4] == STATUS_TILT_SELECTOR` test nor a length test can separate them — the
48// first would blank real readings from any cover resting near 16%. The request-derived
49// `trust_position` parameter on update_device_status_() is the discriminator, and the only
50// correct one. See tests/corpus/captures/exchange/tilt_cover_exchange_ack_tilt_block*.yaml.
51constexpr uint8_t PRIVATE_RESPONSE_TARGET_OFFSET = 2; ///< Target-position MSB offset in 0x04 replies.
52constexpr uint8_t PRIVATE_RESPONSE_CURRENT_OFFSET = 4; ///< Current-position MSB offset in 0x04 replies.
53constexpr uint8_t STATUS_UPDATE_TARGET_OFFSET = 5; ///< Target-position MSB offset in 0x71 updates.
54constexpr uint8_t STATUS_UPDATE_CURRENT_OFFSET = 7; ///< Current-position MSB offset in 0x71 updates.
55constexpr uint8_t GET_INFO2_TYPE_OFFSET = 10; ///< Packed device type byte in 0x57 replies.
56constexpr uint8_t GET_INFO2_TYPE_SUBTYPE_OFFSET = 11; ///< Packed type low bits plus subtype byte in 0x57 replies.
57constexpr uint8_t EXTENDED_TILT_SELECTOR_OFFSET = 12; ///< Selector byte announcing extended tilt payload.
58constexpr uint8_t EXTENDED_TILT_MSB_OFFSET = 13; ///< Tilt-position MSB within extended replies.
59constexpr uint8_t EXTENDED_TILT_LSB_OFFSET = 14; ///< Tilt-position LSB within extended replies.
60constexpr uint8_t PRIVATE_RESPONSE_HINT_UNUSED = 0xFF; ///< Value used by devices that do not expose a follow-up timer.
61constexpr uint8_t PRIVATE_RESPONSE_HINT_ZERO =
62 0x00; ///< Value treated as invalid or uninformative for follow-up timing.
63constexpr uint32_t PRIVATE_RESPONSE_HINT_SCALE_MS = 1000; ///< Private-response delay hint is expressed in seconds.
64constexpr uint32_t PRIVATE_RESPONSE_HINT_BIAS_MS =
65 1000; ///< Observed devices need an extra second beyond the hint value.
66
67/// @brief Decode the shared target/current position fields used by private response and status‑update frames.
68/// Different frame types use different byte offsets, but the normalization policy is identical once offsets known.
69/// @param dev Device record to update.
70/// @param frame IoFrame containing a status‑bearing command.
71/// @param target_offset Byte offset of target MSB within frame.data.
72/// @param current_offset Byte offset of current MSB within frame.data.
73/// @param allow_tilt_from_extended_response If true and frame is extended, decode tilt from the extended tilt bytes.
74void decode_status_fields(IoDevice &dev, const IoFrame &frame, uint8_t target_offset, uint8_t current_offset,
75 bool allow_tilt_from_extended_response) {
76 uint16_t const tgt = (frame.data[target_offset] << 8) | frame.data[target_offset + 1];
77 uint16_t const cur = (frame.data[current_offset] << 8) | frame.data[current_offset + 1];
78 decode_position_report(tgt, cur, dev.is_stopped, dev.target, dev.position);
80 // A decoded position is the observation this prediction existed to stand in for.
81 dev.optimistic.clear_position();
82
83 if (allow_tilt_from_extended_response && device_supports_tilt(dev.type) &&
84 frame.data_len >= EXTENDED_TILT_RESPONSE_MIN_DATA_LEN &&
85 frame.data[EXTENDED_TILT_SELECTOR_OFFSET] == STATUS_TILT_SELECTOR) {
86 uint16_t const tilt_raw = (frame.data[EXTENDED_TILT_MSB_OFFSET] << 8) | frame.data[EXTENDED_TILT_LSB_OFFSET];
87 dev.tilt = decode_tilt_report(tilt_raw);
88 dev.optimistic.clear_tilt();
89 }
90}
91
92/// @brief Compute the delay before the next status poll for a private‑response device.
93/// @param dev Device record.
94/// @param frame The private response frame (may contain a coarse retry hint in byte 7).
95/// @param policy Policy used to look up the configured poll interval.
96/// @param id Device ID for policy lookup.
97/// @return Delay in milliseconds, or 0 if the device is stopped.
98uint32_t compute_private_response_delay_ms(const IoDevice &dev, const IoFrame &frame, const StatusPollPolicy &policy,
99 const std::string &id) {
100 if (effective_is_stopped(dev))
101 return 0;
102
103 // Private responses carry a coarse follow‑up timer in byte 7 on many devices. Decode it here
104 // (0 = absent) and let settle_delay_ms() reconcile it with the configured interval and default.
105 // Some devices omit byte 7 entirely (data_len == 6); treat those as hint-absent.
106 uint32_t hint_delay_ms = 0;
107 if (frame.data_len > PRIVATE_RESPONSE_DELAY_HINT_OFFSET &&
108 frame.data[PRIVATE_RESPONSE_DELAY_HINT_OFFSET] != PRIVATE_RESPONSE_HINT_UNUSED &&
109 frame.data[PRIVATE_RESPONSE_DELAY_HINT_OFFSET] != PRIVATE_RESPONSE_HINT_ZERO) {
110 hint_delay_ms = (frame.data[PRIVATE_RESPONSE_DELAY_HINT_OFFSET] * PRIVATE_RESPONSE_HINT_SCALE_MS) +
111 PRIVATE_RESPONSE_HINT_BIAS_MS;
112 }
113 // A private response is the shared reply to both polls (0x03) and commands (0x00); it carries no
114 // marker for STOP, so the STOP cap is applied by the command path, not here.
115 return settle_delay_ms(policy.get_interval(id), hint_delay_ms, /*cap_for_stop=*/false);
116}
117
118/// @brief Compute the delay before the next status poll for a device‑originated status update.
119/// @param dev Device record.
120/// @param policy Policy used to look up the configured poll interval.
121/// @param id Device ID for policy lookup.
122/// @return Delay in milliseconds for tracked polling; 0 if stopped.
123uint32_t compute_status_update_delay_ms(const IoDevice &dev, const StatusPollPolicy &policy, const std::string &id) {
124 if (effective_is_stopped(dev))
125 return 0;
126 // Device-originated updates carry no follow-up hint and are never STOP replies.
127 return settle_delay_ms(policy.get_interval(id), /*hint_delay_ms=*/0, /*cap_for_stop=*/false);
128}
129
130/// @brief Apply a private-response frame to the device record.
131/// @param id Device ID for policy lookup.
132/// @param dev Device record to update.
133/// @param frame Private-response frame.
134/// @param policy Poll policy for scheduling follow-up polls.
135/// @param trust_position False to skip decoding target/current from `frame` — the immediate
136/// reply to our own just-sent CMD_EXECUTE has been observed (real hardware, see
137/// tests/corpus/captures/exchange/somfy_awning_exchange_ack_reports_stale_target_*.yaml) echoing
138/// pre-command target/current values rather than the freshly-commanded target. `is_stopped` is
139/// still applied either way; the optimistic target already set by the caller (or the follow-up
140/// status poll a few seconds later) remains the source of truth for target/current in that case.
141void apply_private_response_status(const std::string &id, IoDevice &dev, const IoFrame &frame, StatusPollPolicy &policy,
142 bool trust_position = true) {
143 dev.is_stopped = (frame.data[STATUS_STOPPED_FLAGS_OFFSET] & STATUS_STOPPED) != 0;
144 dev.last_status = millis();
145 if (trust_position) {
146 decode_status_fields(dev, frame, PRIVATE_RESPONSE_TARGET_OFFSET, PRIVATE_RESPONSE_CURRENT_OFFSET, true);
147 } else {
149 }
150
151 if (effective_is_stopped(dev) || !policy.is_tracking_active(id, dev.last_status)) {
152 policy.clear(id);
153 return;
154 }
155
156 uint32_t const delay_ms = compute_private_response_delay_ms(dev, frame, policy, id);
157 const bool hint_present = frame.data_len > PRIVATE_RESPONSE_DELAY_HINT_OFFSET;
158 const uint8_t hint_byte =
159 hint_present ? frame.data[PRIVATE_RESPONSE_DELAY_HINT_OFFSET] : PRIVATE_RESPONSE_HINT_UNUSED;
160 const bool has_hint =
161 hint_present && hint_byte != PRIVATE_RESPONSE_HINT_UNUSED && hint_byte != PRIVATE_RESPONSE_HINT_ZERO;
162 ESP_LOGD(
163 detail::TAG, "Device %s: next status poll in %" PRIu32 " ms (device hint=%s, configured interval=%" PRIu32 " ms)",
164 id.c_str(), delay_ms, has_hint ? std::to_string(hint_byte).append("s").c_str() : "none", policy.get_interval(id));
165 uint32_t const new_deadline = dev.last_status + delay_ms;
166 uint32_t const existing_deadline = policy.get_next_update(id);
167 // Don't push the deadline forward — only move it earlier. This prevents repeated command
168 // responses (e.g. multiple rapid STOP presses) from compounding the wait time.
169 policy.set_next_update(
170 id, (existing_deadline != 0 && existing_deadline < new_deadline) ? existing_deadline : new_deadline);
171}
172
173/// @brief Apply a device-originated status-update frame to the device record.
174/// @param id Device ID for policy lookup.
175/// @param dev Device record to update.
176/// @param frame Status-update frame.
177/// @param policy Poll policy for scheduling follow-up polls.
178void apply_unsolicited_status_update(const std::string &id, IoDevice &dev, const IoFrame &frame,
179 StatusPollPolicy &policy) {
180 dev.is_stopped = (frame.data[STATUS_STOPPED_FLAGS_OFFSET] & STATUS_STOPPED) != 0;
181 dev.last_status = millis();
182 decode_status_fields(dev, frame, STATUS_UPDATE_TARGET_OFFSET, STATUS_UPDATE_CURRENT_OFFSET, false);
183
184 if (effective_is_stopped(dev) || !policy.is_tracking_active(id, dev.last_status)) {
185 policy.clear(id);
186 return;
187 }
188
189 policy.set_next_update(id, dev.last_status + compute_status_update_delay_ms(dev, policy, id));
190}
191
192/// @brief Apply INFO2 metadata to the device record when YAML has not already declared it.
193/// @param dev Device record to update.
194/// @param frame INFO2 response frame.
195void apply_info2_response(IoDevice &dev, const IoFrame &frame) {
196 if (dev.type != DeviceType::UNKNOWN)
197 return;
198
199 dev.type = decode_packed_device_type(frame.data[GET_INFO2_TYPE_OFFSET], frame.data[GET_INFO2_TYPE_SUBTYPE_OFFSET]);
200 dev.subtype = decode_packed_device_subtype(frame.data[GET_INFO2_TYPE_SUBTYPE_OFFSET]);
201 if (default_inverted_for_type(dev.type))
202 dev.inverted = true;
203}
204
205/// @brief Apply a name response frame to the device record.
206/// @param dev Device record to update.
207/// @param frame Name response frame.
208void apply_name_response(IoDevice &dev, const IoFrame &frame) {
209 std::string const name = decode_device_name_payload(frame.data, frame.data_len);
210 memset(dev.name, 0, sizeof(dev.name));
211 if (!name.empty())
212 memcpy(dev.name, name.c_str(), name.length());
213}
214
215} // namespace
216
217void IOHomeControlComponent::begin_status_poll_tracking_(const std::string &device_id, uint32_t initial_delay_ms) {
218 if (this->get_device(device_id) == nullptr)
219 return;
220 this->poll_policy_.begin_tracking(device_id, initial_delay_ms, millis());
221}
222
223void IOHomeControlComponent::schedule_status_poll_(const std::string &device_id, uint32_t delay_ms) {
224 // The timeout name is per-device so repeated remote traffic resets the pending poll instead of
225 // stacking multiple delayed callbacks for the same actuator.
226 const std::string timeout_name = "remote_poll_" + device_id;
227 this->set_timeout(timeout_name.c_str(), delay_ms,
228 [this, device_id]() { this->queue_request_device_status(device_id); });
229}
230
231void IOHomeControlComponent::schedule_device_polls_(const std::vector<std::string> &device_ids, uint32_t delay_ms) {
232 for (const auto &device_id : device_ids) {
233 this->begin_status_poll_tracking_(device_id, 0);
234 this->schedule_status_poll_(device_id, delay_ms);
235 }
236}
237
238void IOHomeControlComponent::schedule_linked_remote_polls_(const std::string &remote_id, uint32_t delay_ms) {
239 const std::vector<std::string> *linked = this->registry_.linked_devices(remote_id);
240 if (linked == nullptr)
241 return;
242 this->schedule_device_polls_(*linked, delay_ms);
243}
244
246 const std::string &src_id) const {
247 std::vector<std::string> devices;
248 if (const std::vector<std::string> *id_linked = this->registry_.linked_devices(src_id)) {
249 devices = *id_linked;
250 }
252 if (const std::vector<std::string> *class_linked = this->registry_.linked_devices_for_class(info.target_type)) {
253 for (const auto &device_id : *class_linked) {
254 if (std::find(devices.begin(), devices.end(), device_id) == devices.end())
255 devices.push_back(device_id);
256 }
257 }
258 }
259 return devices;
260}
261
263 const std::vector<std::string> &device_ids) {
264 if (!info.has_intent)
265 return false;
266
267 const bool is_stop = info.main0 == POS_STOP;
268 const std::optional<float> target = is_stop ? std::nullopt : oneway_intent_to_target(info.main0, info.main1);
269
270 for (const auto &device_id : device_ids) {
271 const IoDevice *dev = this->registry_.get(device_id);
272 if (dev != nullptr && info.target_type != DeviceType::UNKNOWN && dev->type != DeviceType::UNKNOWN &&
273 dev->type != info.target_type) {
274 continue; // Type mismatch: still polled by schedule_device_polls_(), just not moved optimistically.
275 }
276 if (is_stop) {
277 this->registry_.apply_optimistic_stop(device_id);
278 } else if (target.has_value()) {
279 this->registry_.apply_optimistic_target(device_id, *target);
280 }
281 }
282 return is_stop;
283}
284
286 const std::string &src_id) {
287 if (!info.has_intent)
288 return;
289 // All overheard 1W traffic is DEBUG-logged regardless (see log_1w_remote_frame()); the HA event
290 // additionally requires the sender to be on the `exposed_senders` allowlist, since 1W broadcasts
291 // carry no ownership marker and this radio may overhear a neighbor's remote (or sensor) as
292 // easily as the user's own. DEBUG-log the reason it did or didn't fire so a live log capture is
293 // enough to diagnose a misconfigured allowlist vs. a disconnected API.
294 if (!this->is_connected()) {
295 ESP_LOGD(detail::TAG, "1W sender %s has intent but the API is not connected, skipping %s", src_id.c_str(),
297 return;
298 }
299 if (!detail::is_exposed_sender(this->exposed_senders_, src_id)) {
300 ESP_LOGD(detail::TAG, "1W sender %s has intent but is not in exposed_senders, skipping %s", src_id.c_str(),
302 return;
303 }
304 ESP_LOGD(detail::TAG, "Firing %s for sender %s", detail::ONEWAY_SENDER_EVENT, src_id.c_str());
305 this->fire_homeassistant_event(detail::ONEWAY_SENDER_EVENT, detail::build_sender_event_data(info, linked));
306}
307
308void IOHomeControlComponent::update_device_status_(const IoFrame &frame, bool trust_position) {
309 const std::string id = node_id_to_string(frame.src);
310 IoDevice *device_ptr = this->registry_.get(id);
311 if (device_ptr == nullptr) {
312 detail::log_frame_issue(this, "rx", "unregistered_device", frame, frame_length(frame));
313 return;
314 }
315 IoDevice &dev = *device_ptr;
317
318 if (frame.cmd == CMD_PRIVATE_RESP) {
319 if (frame.data_len < PRIVATE_RESPONSE_MIN_DATA_LEN) {
320 detail::log_frame_issue(this, "rx", "unsupported_payload", frame, frame_length(frame));
321 return;
322 }
323
324 // CMD_PRIVATE_RESP (0x04) serves as the reply to both status polls (0x03) and execute
325 // commands (0x00). The position fields are shared across both response types, but the
326 // immediate reply to our own execute command is not necessarily trustworthy for them (see
327 // apply_private_response_status()'s trust_position parameter).
328 apply_private_response_status(id, dev, frame, this->poll_policy_, trust_position);
329 // The device names, in its own status payload, the controller that last commanded it. Skipped
330 // on an execute ack (trust_position == false): that reply's payload layout is request-derived
331 // rather than self-describing (see the offset comment at the top of this file), and our own
332 // ack is not a report of the *last* command anyway — the settle poll a few seconds later is.
333 if (trust_position) {
336 }
339 this->notify_device_update_(id);
340 return;
341 }
342
343 if (frame.cmd == CMD_STATUS_UPDATE) {
344 if (frame.data_len < STATUS_UPDATE_MIN_DATA_LEN) {
345 detail::log_frame_issue(this, "rx", "unsupported_payload", frame, frame_length(frame));
346 return;
347 }
348
349 // Status-update frames come from the device itself rather than from a direct controller poll.
350 // They use different offsets for the target/current fields and do not carry reliable tilt data.
351 apply_unsolicited_status_update(id, dev, frame, this->poll_policy_);
355
356 // What caused the device to move (wind sensor, timer, a remote). Empty when the payload is
357 // too short to carry the byte — a 11-14 byte 0x71 is still applied for its position fields,
358 // it just has no originator to report. This reads the same data[14] byte the last-command
359 // record above just decoded, but through a separate, older, unguarded accessor kept for its
360 // own pinned test (StatusUpdateOriginatorIsAtOffset14AndDecodePathUndisturbed) — it can render
361 // a byte here that the "Last Command Source" sensor leaves empty, on the one payload shape
362 // that differs between them: an all-zero commander (which apply_last_command_record() above
363 // treats as "no record", see decode_last_command_record()'s doc comment) paired with a
364 // populated originator byte. No capture has shown that combination in practice.
365 const std::string originator = detail::describe_status_update_originator(frame);
366 if (!originator.empty())
367 ESP_LOGD(detail::TAG, "Device %s: status update originator=%s", id.c_str(), originator.c_str());
368
369 detail::log_status_update(id, dev, " (status update)");
370 this->notify_device_update_(id);
371 return;
372 }
373
374 if (frame.cmd == CMD_GET_NAME_RESP) {
375 if (frame.data_len < GET_NAME_RESPONSE_MIN_DATA_LEN) {
376 detail::log_frame_issue(this, "rx", "unsupported_payload", frame, frame_length(frame));
377 return;
378 }
379
380 apply_name_response(dev, frame);
381 ESP_LOGI(detail::TAG, "Device %s: name=%s", id.c_str(), dev.name[0] == '\0' ? "" : dev.name);
382 this->notify_device_update_(id);
383 return;
384 }
385
386 if (frame.cmd == CMD_GET_INFO2_RESP) {
387 if (frame.data_len < GET_INFO2_RESPONSE_MIN_DATA_LEN) {
388 detail::log_frame_issue(this, "rx", "unsupported_payload", frame, frame_length(frame));
389 return;
390 }
391
392 // INFO2 is metadata, not movement state. Only learn type from radio if still UNKNOWN;
393 // YAML-declared type takes priority.
394 const bool type_was_unknown = dev.type == DeviceType::UNKNOWN;
395 apply_info2_response(dev, frame);
396 ESP_LOGI(detail::TAG, "Device %s: type=%s (%u) class=%s profile=%s subtype=%u", id.c_str(),
399 if (type_was_unknown && dev.type != DeviceType::UNKNOWN) {
400 ESP_LOGI(detail::TAG,
401 "Device %s: type learned at runtime, not declared in YAML — add `%s` to skip "
402 "re-learning it on every future boot",
403 id.c_str(), detail::describe_learned_device_type(dev.type).c_str());
404 }
405 return;
406 }
407
408 if (frame.cmd == CMD_ERROR_RESP) {
409 if (frame.data_len < ERROR_RESPONSE_MIN_DATA_LEN) {
410 detail::log_frame_issue(this, "rx", "unsupported_payload", frame, frame_length(frame));
411 return;
412 }
413
414 detail::record_command_result(dev, id, frame.data[0]);
415 this->notify_device_update_(id);
416 return;
417 }
418}
419
421 // A gap of a full quiet period or more since the last frame means the previous burst already
422 // released any deferred poll, so this frame starts a new burst window rather than extending the
423 // old one (which would make ONEWAY_POLL_DEFER_CAP_MS fire on the very next frame).
425 this->first_1w_activity_ms_ = now;
426 this->last_1w_activity_ms_ = now;
427}
428
430 if (!decisions::is_one_way_pairing_gesture((frame.ctrl0 & CTRL0_PROTOCOL_1W) != 0, frame.dst, frame.cmd))
431 return;
432 memcpy(this->recent_oneway_pairing_sighting_.src, frame.src, NODE_ID_SIZE);
433 memcpy(this->recent_oneway_pairing_sighting_.dst, frame.dst, NODE_ID_SIZE);
434 this->recent_oneway_pairing_sighting_.cmd = frame.cmd;
435 this->recent_oneway_pairing_sighting_.rssi = this->radio_->get_last_capture().rssi_dbm;
436 this->recent_oneway_pairing_sighting_.seen_ms = now;
437}
438
440 IoFrame frame;
441 if (!parse(packet.data, packet.len, frame)) {
442 detail::log_component_capture(this->radio_, "parse_fail", packet.data, packet.len);
443 return;
444 }
445
446 detail::log_component_capture(this->radio_, "parse_ok", packet.data, packet.len, &frame);
447
448 // === Key-extraction responder ("Accept Foreign Pairing") ===
449 // Runs before the exchange-internal drop below: a hub-issued 0x3C challenging our own 0x37 is
450 // addressed to us and is ours to answer (key_extraction_responder.cpp). Self-gated on armed + our
451 // throwaway ID, so the disarmed path (and every command other than 0x28/0x2C/0x31/0x32/0x36/0x3C)
452 // is bit-for-bit unchanged by this ordering — try_handle_frame() returns false immediately
453 // whenever it doesn't apply, and this reorder can only affect frames where BOTH this call and
454 // the is_exchange_internal_command() check below would otherwise fire, i.e. only 0x3C/0x3D (that
455 // predicate's entire domain, hub_decisions.h).
456 if (this->key_extraction_.try_handle_frame(frame))
457 return;
458
459 // Exchange-internal frames (0x3C challenge request, 0x3D challenge response) belonging to
460 // *another* controller's authenticated exchange carry no extractable status data for a passive
461 // observer — skip silently. They remain visible in io_capture (stage=parse_ok).
463 return;
464 }
465
466 // === 1W remote frame decode ===
467 // 1W remotes broadcast commands to a typed device-class address (e.g., "all awnings").
468 // Decode the frame content for diagnostic logging, then fall through to linked_remotes
469 // handling which may schedule a status poll for devices this remote controls.
470 if ((frame.ctrl0 & CTRL0_PROTOCOL_1W) != 0) {
471 const std::string src_id = node_id_to_string(frame.src);
472 const uint32_t now = millis();
473
474 // Any 1W frame means a remote is transmitting right now, duplicate or not — record it before
475 // the dedup check so loop() keeps background polls off the radio for the rest of the burst.
476 this->record_1w_activity_(now);
477 // Remember a pairing-gesture sighting the same way, before dedup, so a repeated gesture frame
478 // still refreshes the timestamp (issue #27/#65) — see record_oneway_pairing_gesture_()'s doc
479 // comment for why the discovery telemetry window alone isn't enough to catch this.
480 this->record_oneway_pairing_gesture_(frame, now);
481
482 // Decode once and reuse for the dedup key, logging, and (when it carries a command intent) the
483 // sender HA event, so a physical remote press (or sensor trigger) can drive automations directly.
484 // The decode must happen *before* the dedup check: a move and a stop share the CMD_EXECUTE
485 // command byte and are told apart only by the decoded intent, which is part of the key.
486 const OneWayFrameInfo info = decode_1w_frame(frame);
487
488 // Opt-in, receive-only 1W key adoption (oneway_key_adoption.cpp). Both calls sit after
489 // the parse and before the dedup check so an add-controller broadcast is seen even when its
490 // repeats would collapse into one logical press. Both self-gate on armed, so the disarmed
491 // path is unchanged; they observe the frame rather than consuming it, and execution always
492 // continues into the normal logging path below. Order matters only in that the class
493 // observation must be recorded before an adoption can consume it.
494 this->oneway_key_adoption_.record_observed_class(info);
495 this->oneway_key_adoption_.try_adopt(frame);
496
497 // 1W remotes repeat each command 4× at 40ms intervals across channels, and a held button keeps
498 // resending. Collapse that into one logical press per remote+command+intent.
499 const decisions::OneWayDedupState incoming{src_id, frame.cmd, info.has_intent, info.main0, info.main1, now};
501 return;
502 this->last_1w_logged_ = incoming;
503
504 const std::vector<std::string> *linked = this->registry_.linked_devices(src_id);
505 detail::log_1w_remote_frame(info, linked);
506 this->maybe_fire_sender_event_(info, linked != nullptr && !linked->empty(), src_id);
507 // Id-linked devices plus, for a typed broadcast, class-linked devices — deduplicated so a
508 // device linked both ways is only touched once per press.
509 const std::vector<std::string> target_devices = this->resolve_1w_target_devices_(info, src_id);
510 const bool is_stop = this->apply_optimistic_linked_state_(info, target_devices);
511 this->schedule_device_polls_(target_devices, is_stop ? 0 : REMOTE_ACTIVITY_STATUS_POLL_DELAY_MS);
512 return;
513 }
514
515 if (frame.cmd == CMD_STATUS_UPDATE && memcmp(frame.dst, this->node_id_, NODE_ID_SIZE) == 0) {
516 if (this->authenticate_request_(frame, packet.freq_hz)) {
517 IoFrame resp;
518 if (!create_status_update_resp(resp, this->node_id_, frame.src)) {
519 detail::log_frame_issue(this, "rx", "ack_build_failed", frame, packet.len);
520 return;
521 }
522 // Device-originated updates may arrive while the sender and receiver are not aligned on the
523 // same hop channel anymore. Broadcasting the ACK across all three IO-homecontrol channels
524 // matched the behavior of real controllers and made updates reliable in practice.
528 this->update_device_status_(frame);
529 } else {
530 detail::log_frame_issue(this, "rx", "auth_failed", frame, packet.len);
531 }
532 return;
533 }
534
535 if (frame.cmd == CMD_PRIVATE_RESP || frame.cmd == CMD_STATUS_UPDATE) {
536 // Passive receive mode can still observe replies/status from other exchanges (another
537 // controller sharing a device, or an attacker who knows the device's node ID -- node IDs
538 // travel in the clear, see README.md's "Reporting Unsupported Devices"). Nothing here proves
539 // the frame's source currently holds the system key, so its content is never applied -- see
540 // ADR 0022. State goes stale until this hub's own next authenticated poll corrects it.
541 detail::log_frame_issue(this, "rx", "unauthenticated_status_ignored", frame, packet.len);
542 return;
543 }
544
545 // Check if this frame targets one of our registered devices (e.g., a physical remote
546 // commanding a shutter we also control). If so, schedule a status poll after 2 seconds
547 // to pick up the resulting position change. The timeout name includes the device ID so
548 // repeated remote activity resets the timer rather than stacking redundant polls.
549 // The 2-second delay gives the device time to complete the exchange and start moving.
550 const std::string dst_id = node_id_to_string(frame.dst);
551 if (this->get_device(dst_id) != nullptr && memcmp(frame.src, this->node_id_, NODE_ID_SIZE) != 0) {
552 ESP_LOGD(detail::TAG, "rx remote_activity src=%s dst=%s cmd=%s(0x%02X), scheduling status poll",
553 node_id_to_string(frame.src).c_str(), dst_id.c_str(), command_name(frame.cmd), frame.cmd);
554 this->begin_status_poll_tracking_(dst_id, 0);
556 return;
557 }
558
559 // Check if the frame source is a linked remote using 2W protocol (e.g., a 2W controller
560 // whose commands target a device at an address we don't have registered). 1W remotes are
561 // already handled above via the CTRL0_PROTOCOL_1W check.
562 const std::string src_id = node_id_to_string(frame.src);
563 if (this->registry_.linked_devices(src_id) != nullptr) {
564 ESP_LOGD(detail::TAG, "rx remote_activity (linked) remote=%s cmd=%s(0x%02X), scheduling status poll",
565 src_id.c_str(), command_name(frame.cmd), frame.cmd);
566 this->schedule_linked_remote_polls_(src_id);
567 return;
568 }
569
570 detail::log_frame_issue(this, "rx", "unhandled_cmd", frame, packet.len);
571
572 // If the command is not in our known set AND the frame was addressed to our hub, it may be a
573 // protocol extension we should support — ask the user to report it. Frames merely overheard
574 // between other devices (not addressed to us) are still logged above at debug level, but do
575 // not warrant a warning: we are not a party to that exchange, so there is nothing to add.
576 const bool addressed_to_us = memcmp(frame.dst, this->node_id_, NODE_ID_SIZE) == 0;
577 if (addressed_to_us && std::strcmp(command_name(frame.cmd), "UNKNOWN_CMD") == 0) {
578 const std::string src_id = node_id_to_string(frame.src);
579 ESP_LOGW(detail::TAG,
580 "Received unknown command 0x%02X from %s. "
581 "If you see this repeatedly, please file a GitHub issue with this command ID, "
582 "your device model, and the log context so protocol support can be extended.",
583 frame.cmd, src_id.c_str());
584 }
585}
586
587} // namespace home_io_control
588} // namespace esphome
void maybe_fire_sender_event_(const OneWayFrameInfo &info, bool linked, const std::string &src_id)
Fire the sender HA event for a decoded 1W frame, if the sender is exposed.
uint32_t last_1w_activity_ms_
millis() of the most recent 1W frame of any kind, including ones dropped as duplicates — a repeat sti...
Definition hub_core.h:1129
void begin_status_poll_tracking_(const std::string &device_id, uint32_t initial_delay_ms)
Begin bounded follow-up polling for a device after a command or overheard remote activity.
virtual IoDevice * get_device(const std::string &device_id)
Retrieve a device by ID; returns nullptr if not found.
Definition hub_core.cpp:313
void record_oneway_pairing_gesture_(const IoFrame &frame, uint32_t now)
If frame matches a 1W remote's pairing gesture (decisions::is_one_way_pairing_gesture()),...
std::vector< std::string > resolve_1w_target_devices_(const OneWayFrameInfo &info, const std::string &src_id) const
Resolve the set of devices a 1W frame should affect: devices linked to the sending remote by node ID,...
void schedule_status_poll_(const std::string &device_id, uint32_t delay_ms)
Schedule a delayed status poll for a registered device using the Component timeout API.
void update_device_status_(const IoFrame &frame, bool trust_position=true)
Extract supported position or metadata info from a response frame and merge it into the device record...
RecentOneWayPairingSighting recent_oneway_pairing_sighting_
Most recent 1W pairing-gesture frame seen on the hub's normal passive RX path (e.g.
Definition hub_core.h:1092
void schedule_device_polls_(const std::vector< std::string > &device_ids, uint32_t delay_ms)
Schedule status polls for a fixed list of devices (shared by the id-linked and class-linked 1W paths,...
void record_1w_activity_(uint32_t now)
Record that a 1W frame just went out on the radio — ours or someone else's — updating last_1w_activit...
bool transmit_frame_(const IoFrame &frame, uint32_t freq, uint16_t preamble)
Transmit a raw IoFrame on the current frequency with given preamble length.
Definition hub_core.cpp:267
void schedule_linked_remote_polls_(const std::string &remote_id, uint32_t delay_ms=REMOTE_ACTIVITY_STATUS_POLL_DELAY_MS)
Schedule status polls for all devices associated with a linked remote.
OnewayKeyAdoption oneway_key_adoption_
Opt-in, receive-only 1W controller-key adoption listener (oneway_key_adoption.cpp).
Definition hub_core.h:1105
void notify_device_update_(const std::string &id)
Fire all registered device update callbacks for the given device ID.
Definition hub_core.cpp:285
decisions::OneWayDedupState last_1w_logged_
Identity of the last processed 1W frame, for burst suppression; see decisions::is_duplicate_1w_frame(...
Definition hub_core.h:1125
KeyExtractionResponder key_extraction_
Device-role responder for the "Recover System Key" feature (key_extraction_responder....
Definition hub_core.h:1111
std::vector< std::string > exposed_senders_
1W sender node IDs (remotes or sensors) allowed to fire the sender HA event (add_exposed_sender).
Definition hub_core.h:1077
void process_received_packet_(const RadioRxPacket &packet)
Parse a received frame, merge supported device state or metadata, and notify callbacks.
bool authenticate_request_(const IoFrame &request, uint32_t freq)
Handle an inbound authenticated command from a device (status updates, etc.).
Definition hub_core.cpp:281
uint32_t first_1w_activity_ms_
millis() of the first 1W frame in the current burst.
Definition hub_core.h:1134
bool apply_optimistic_linked_state_(const OneWayFrameInfo &info, const std::vector< std::string > &device_ids)
Apply optimistic target state to every device in device_ids, when the decoded frame carries a resolva...
Per-hub poll scheduling and failure-backoff policy.
Pure transition helpers for hub-owned exchange and pairing frame decisions.
Internal helpers shared by the hub implementation .cpp files.
bool is_one_way_pairing_gesture(bool oneway, const uint8_t dst[NODE_ID_SIZE], uint8_t cmd)
True if a frame's shape matches a 1W remote's pairing gesture (issue #27/#65): CTRL0 1W bit set,...
bool is_duplicate_1w_frame(const OneWayDedupState &last, const OneWayDedupState &incoming, uint32_t window_ms)
Decide whether an incoming 1W frame repeats the previous one inside the burst window.
bool is_exchange_internal_command(uint8_t cmd)
Returns true for commands that are internal to an exchange handshake and carry no useful information ...
bool oneway_burst_started_fresh(uint32_t last_1w_activity_ms, uint32_t now, uint32_t quiet_ms)
Whether a 1W frame arriving at now starts a new burst rather than extending the current one — true if...
std::map< std::string, std::string > build_sender_event_data(const OneWayFrameInfo &info, bool linked)
Build the Home Assistant event data map for a decoded 1W sender frame.
constexpr const char * TAG
Shared log tag for hub-level messages.
constexpr uint8_t PRIVATE_RESPONSE_LAST_COMMAND_OFFSET
Offset of the last-command record within each status-bearing payload.
std::string describe_learned_device_type(DeviceType type)
Build the YAML line to add once a device's type is learned at runtime.
void apply_last_command_record(IoDevice &dev, const LastCommandRecord &record)
Store a decoded record on the device, if it is valid.
void log_1w_remote_frame(const OneWayFrameInfo &info, const std::vector< std::string > *linked_devices=nullptr)
Log an already-decoded 1W remote frame at DEBUG level.
void log_component_capture(const RadioDriver *radio, const char *stage, const uint8_t *buf, uint8_t len, const IoFrame *frame=nullptr)
Log a frame at the "io_capture" tag with structured fields.
std::string describe_status_update_originator(const IoFrame &frame)
Describe a 0x71 status update's Command Originator as "name(0xXX)".
bool is_exposed_sender(const std::vector< std::string > &exposed_senders, const std::string &sender_id)
Whether a 1W sender is on the exposed_senders allowlist for the sender HA event.
constexpr const char * ONEWAY_SENDER_EVENT
Home Assistant event fired when a decoded 1W frame carries a command intent from an exposed sender (a...
void update_link_health(IoDevice &dev, RadioDriver *radio)
Update per-device link-health stats from the radio's last capture.
constexpr uint8_t STATUS_UPDATE_LAST_COMMAND_OFFSET
void normalize_stopped_state(IoDevice &dev)
Normalize stopped state: some devices briefly report stopped before target/current converge.
constexpr uint32_t ONEWAY_DEDUP_WINDOW_MS
Suppress a repeated 1W log/poll for the same remote and the same intent within this window.
void log_status_update(const std::string &id, const IoDevice &dev, const char *suffix="")
Log a concise status‑update line used by inbound handlers.
void log_frame_issue(IOHomeControlComponent *component, const char *direction, const char *reason, const IoFrame &frame, uint8_t len)
Log a frame‑level issue (unregistered endpoints, unsupported commands).
void clear_command_result(IoDevice &dev)
Clear a previously recorded CMD_ERROR_RESP result, if any.
LastCommandRecord decode_last_command_record(const IoFrame &frame, uint8_t base)
Decode the last-command record at base from a status-bearing payload.
void record_command_result(IoDevice &dev, const std::string &id, uint8_t result, uint8_t request_cmd=0, bool include_request_cmd=false)
Store a decoded CMD_ERROR_RESP result on the device and log it.
const char * device_operation_profile_name(DeviceType type)
Human‑readable operation profile name for a device type.
uint32_t settle_delay_ms(uint32_t interval_ms, uint32_t hint_delay_ms, bool cap_for_stop)
Resolve the follow-up settle-poll delay while a device may still be moving.
static constexpr uint32_t ONEWAY_QUIET_PERIOD_MS
Hold queued background polls back for this long after any 1W frame, so a poll the hub itself schedule...
static constexpr uint8_t NODE_ID_SIZE
Device/node addresses are 3 bytes (e.g., "123ABC").
Definition proto_sizes.h:20
static constexpr uint8_t CMD_ERROR_RESP
Error response to any command.
static constexpr uint8_t CMD_GET_NAME_RESP
Device name response.
@ UNKNOWN
Unknown/unspecified device.
static constexpr uint8_t CMD_STATUS_UPDATE
Device-initiated status update (needs auth).
bool default_inverted_for_type(DeviceType type)
Determine whether a device type has inverted position mapping by default.
std::optional< float > oneway_intent_to_target(uint8_t main0, uint8_t main1)
Resolve a 1W main-byte pair to an optimistic IO target position, if unambiguous.
static constexpr uint32_t FREQ_CH1
The protocol uses 3 frequency channels in the 868 MHz ISM band.
static constexpr uint32_t FREQ_CH3
Channel 3: 869.85 MHz (2W only).
static constexpr uint8_t CTRL0_PROTOCOL_1W
Bit 5: 1=OneWay protocol, 0=TwoWay protocol.
Definition proto_frame.h:43
const char * command_name(uint8_t cmd)
Get a human-readable name for any IO-Homecontrol command ID.
const char * device_type_name(DeviceType type)
Convert a DeviceType to a lowercase string identifier.
float decode_tilt_report(uint16_t tilt_raw)
Decode tilt angle from raw 16‑bit value.
OneWayFrameInfo decode_1w_frame(const IoFrame &frame)
Decode a parsed 1W frame into a structured OneWayFrameInfo.
static constexpr uint32_t REMOTE_ACTIVITY_STATUS_POLL_DELAY_MS
Delay before polling after overheard remote traffic.
uint8_t frame_length(const IoFrame &f)
Get total frame length from ctrl0.
DeviceType decode_packed_device_type(uint8_t type_msb, uint8_t type_subtype)
Decode a protocol-packed device type from two metadata bytes.
bool parse(const uint8_t *buf, uint8_t buf_len, IoFrame &f)
Parse a wire buffer into a parsed IoFrame (validates length and CTRL0).
static constexpr uint8_t CMD_PRIVATE_RESP
Response to 0x00 and 0x03 (contains position data).
const char * device_capability_class_name(DeviceType type)
Get a human‑readable name for a capability class.
static constexpr uint32_t FREQ_CH2
Channel 2: 868.95 MHz (1W and 2W, TX channel).
bool effective_is_stopped(const IoDevice &dev)
Whether a consumer should treat the device as at rest, prediction first.
std::string node_id_to_string(const uint8_t id[NODE_ID_SIZE])
Format a 3‑byte node ID as a 6‑character uppercase hex string.
std::string decode_device_name_payload(const uint8_t *data, uint8_t len)
Decode a device-name payload from IO-homecontrol's Latin-1 wire format into UTF-8.
uint8_t decode_packed_device_subtype(uint8_t type_subtype)
Decode a protocol-packed device subtype from the second metadata byte.
@ BROADCAST_TYPE
Broadcast to specific device type with non-standard suffix.
static constexpr uint8_t STATUS_TILT_SELECTOR
Extended status payload marker for tilt-capable devices.
static constexpr uint16_t SHORT_PREAMBLE
8 bytes for response/continuation frames
static constexpr uint8_t CMD_GET_INFO2_RESP
Device type/model response.
static constexpr uint8_t POS_STOP
Position values in the IO protocol.
void decode_position_report(uint16_t target_raw, uint16_t current_raw, bool is_stopped, float &target, float &position)
Decode target/current position values from a status frame.
bool device_supports_tilt(DeviceType type)
Does this device type support tilt (slat angle) control?
bool create_status_update_resp(IoFrame &f, const uint8_t *own, const uint8_t *dst)
Build a status-update acknowledgment (0x72).
static constexpr uint8_t STATUS_STOPPED
Status byte flags in CMD_PRIVATE_RESP and CMD_STATUS_UPDATE.
Command builders for the IO‑Homecontrol protocol.
Runtime state of a paired IO‑Homecontrol device.
char name[DEVICE_NAME_BUFFER_SIZE]
Cached UTF-8 device name decoded from Latin-1 wire payloads.
uint8_t subtype
Device subtype (manufacturer‑specific).
DeviceType type
Device type (shutter, awning, etc.).
Parsed IO‑Homecontrol frame (CTRL0/1 + addresses + command + data).
Definition proto_frame.h:88
uint8_t data[FRAME_MAX_DATA_SIZE]
Command parameters (0–23 bytes). Never includes mac.
Definition proto_frame.h:94
uint8_t ctrl0
Control byte 0: flags + length.
Definition proto_frame.h:89
uint8_t src[NODE_ID_SIZE]
Source node ID (3 bytes).
Definition proto_frame.h:92
uint8_t dst[NODE_ID_SIZE]
Destination node ID (3 bytes).
Definition proto_frame.h:91
uint8_t data_len
Actual length of data.
Definition proto_frame.h:95
Decoded representation of a 1W remote frame.
bool has_intent
True if originator/ACEI/intent fields were decoded.
DeviceType target_type
Target device class from broadcast address.
uint8_t main0
Raw first main byte (has_intent only); feeds oneway_intent_to_target().
uint8_t main1
Raw second main byte (has_intent only); feeds oneway_intent_to_target().
AddressClass address_class
Classification of the broadcast address.
Raw packet received from the radio.
uint8_t len
Length of packet in bytes.
uint32_t freq_hz
Frequency the packet was received on (Hz).
uint8_t data[RADIO_PACKET_BUFFER_SIZE]
Raw packet data buffer.
Key fields of the last processed 1W frame, used to collapse a remote's repeat burst.