- Generated by
1.18.0
|
Home IO Control
ESPHome add-on for IO-Homecontrol devices
|
Runtime state of a paired IO‑Homecontrol device. More...
#include <proto_device_model.h>
Public Attributes | |
| uint8_t | node_id [NODE_ID_SIZE] {} |
| Device's 3‑byte radio address. | |
| DeviceType | type {DeviceType::UNKNOWN} |
| Device type (shutter, awning, etc.). | |
| uint8_t | subtype {0} |
| Device subtype (manufacturer‑specific). | |
| char | name [DEVICE_NAME_BUFFER_SIZE] {} |
| Cached UTF-8 device name decoded from Latin-1 wire payloads. | |
| float | position {UNKNOWN_POSITION} |
| Current position: 0=open, 100=closed, or UNKNOWN_POSITION. | |
| float | tilt {UNKNOWN_POSITION} |
| Current tilt: 0=closed, 100=open, or UNKNOWN_POSITION. | |
| float | target {UNKNOWN_POSITION} |
| Target position the device is moving toward. | |
| bool | is_stopped {true} |
| True if device is not moving. | |
| bool | inverted {false} |
| True if open/close positions are swapped (e.g., horizontal awning). | |
| bool | silent {false} |
| True to send position moves with the reference hub's "silent
operation" extended block, which makes the motor travel more slowly. | |
| bool | optimistic_state {true} |
| True if target may be set ahead of a confirming poll/response. | |
| bool | low_power {false} |
| YAML-declared: this target is a low-power / duty-cycled receiver, so directed frames set CTRL1_LOW_POWER and use the long wake-up preamble. | |
| bool | dimmable {false} |
| True for a LIGHT-class device configured dimmable: true in YAML. | |
| uint8_t | last_result_code {0} |
| Last CMD_ERROR_RESP result byte (0 = none recorded). | |
| uint32_t | last_result_at_ms {0} |
| millis() timestamp of last_result_code, 0 when none recorded. | |
| uint8_t | last_commander [NODE_ID_SIZE] {} |
| Node ID of the controller that last commanded this device, as reported verbatim by the device in its own status payload. | |
| uint8_t | last_command_originator {0} |
| That command's Command Originator byte (ORIGINATOR_* in proto_constants.h). | |
| bool | has_last_command {false} |
| True once a status reply carried a well-formed last-command record. | |
| bool | limited_by_rain {false} |
| Derived from observed status replies, never from a prediction (decisions::is_rain_limited(); ADR 0030 keeps predictions apart): the last move was ordered by the rain sensor, or a position command was clamped while rain protection was recently active. | |
| uint32_t | last_rain_evidence_ms {0} |
| millis() of the last status reply that named the rain sensor as the last commander; 0 = never. | |
| uint32_t | last_status {0} |
| millis() timestamp of last received status. | |
| int16_t | last_rssi_dbm {RSSI_UNKNOWN_DBM} |
| Most recent raw RSSI sample (dBm), or RSSI_UNKNOWN_DBM. | |
| int16_t | rssi_ema_scaled {RSSI_UNKNOWN_DBM} |
| Smoothed RSSI as fixed point in 1/RSSI_EMA_SCALE dBm — read through device_rssi_ema_dbm(), updated by detail::update_link_health() in hub_internal.h. | |
| uint32_t | last_seen_ms {0} |
| millis() of the last frame received from this device (any command), 0 = never. | |
| uint32_t | last_moving_evidence_ms |
| millis() of the last sign this device is travelling (see note_moving_evidence(), clear_moving_evidence()), 0 = never. | |
| uint16_t | exchange_timeout_count {0} |
| Cumulative count of outbound exchanges to this device with no valid response (see detail::record_exchange_timeout() in hub_internal.h). | |
| uint16_t | exchange_attempt_count {0} |
| Cumulative attempts (ExchangeEngine::DebugInfo::tries, 1-based per exchange) across those timed-out exchanges only — attempts within an ultimately successful exchange are not counted (deliberate scope limit). | |
| uint16_t | exchange_unconfirmed_count {0} |
| Cumulative count of exchanges this device authenticated and then never closed: it answered with a 0x3C challenge, we answered that, and no final reply arrived. | |
| bool | confirms_execute {false} |
| True once this device has answered a CMD_EXECUTE with a reply that closed the exchange (a status, or an error). | |
| OptimisticState | optimistic {} |
| Hub-side predictions; see OptimisticState. Never observation. | |
| RainSensorState | rain_sensor {RainSensorState::UNKNOWN} |
| Rain state from the opt-in minimum-limitation poll. | |
| BatteryState | battery {BatteryState::NOT_REPORTED} |
| Coarse battery level from byte 1 of the device's own status: a reply to a status poll or an authenticated CMD_STATUS_UPDATE. | |
| float | temperature_range_min_c |
| Lower end of the temperature encoding range of a heater that carries a temperature in its main parameter (YAML min_temperature:). | |
| float | temperature_range_max_c |
| Upper end of that range (YAML max_temperature:). | |
| HeatingReadings | heating {} |
| What the hub has read from a heater over the private register protocol (room temperature, setpoint, mode, regulator state). | |
| bool | battery_entities {false} |
| YAML-declared (battery: true): the battery entities exist, so the status log line names the level even when the device reports none. | |
| bool | has_system_key {false} |
| YAML-declared (system_key:): this device keeps a key of its own. | |
| uint8_t | system_key [AES_KEY_SIZE] {} |
| The device's own key; meaningful only when has_system_key. | |
| bool | registered_by_pairing {false} |
| Added by a pairing in this boot, not declared in YAML. | |
Runtime state of a paired IO‑Homecontrol device.
Definition at line 413 of file proto_device_model.h.
| BatteryState esphome::home_io_control::IoDevice::battery {BatteryState::NOT_REPORTED} |
Coarse battery level from byte 1 of the device's own status: a reply to a status poll or an authenticated CMD_STATUS_UPDATE.
Never from an execute ack (its layout follows the request) or an overheard frame (ADR 0022).
Definition at line 497 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::battery_entities {false} |
YAML-declared (battery: true): the battery entities exist, so the status log line names the level even when the device reports none.
Definition at line 509 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::confirms_execute {false} |
True once this device has answered a CMD_EXECUTE with a reply that closed the exchange (a status, or an error).
Learned at runtime and never stored: it separates a device whose missing reply is an anomaly from one that never sends one (see decisions::retry_after_unconfirmed_accept_is_safe()).
Definition at line 488 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::dimmable {false} |
True for a LIGHT-class device configured dimmable: true in YAML.
Set from platform_light.cpp's YAML config via DeviceRegistry::set_dimmable(), purely for accurate profile-name logging. Light subtype 58 (0x01BA) is defined as on/off only (VELUX KLF 200 API v3.18, App. 2); the discovery subtype is not consulted for this flag yet.
Definition at line 433 of file proto_device_model.h.
| uint16_t esphome::home_io_control::IoDevice::exchange_attempt_count {0} |
Cumulative attempts (ExchangeEngine::DebugInfo::tries, 1-based per exchange) across those timed-out exchanges only — attempts within an ultimately successful exchange are not counted (deliberate scope limit).
Definition at line 476 of file proto_device_model.h.
| uint16_t esphome::home_io_control::IoDevice::exchange_timeout_count {0} |
Cumulative count of outbound exchanges to this device with no valid response (see detail::record_exchange_timeout() in hub_internal.h).
Definition at line 474 of file proto_device_model.h.
| uint16_t esphome::home_io_control::IoDevice::exchange_unconfirmed_count {0} |
Cumulative count of exchanges this device authenticated and then never closed: it answered with a 0x3C challenge, we answered that, and no final reply arrived.
Counted separately from exchange_timeout_count because the two have different causes and different fixes — silence from the start means the device never heard us, while silence after a challenge means the reply was lost on the way back (or our challenge answer never landed). For a CMD_EXECUTE this outcome is treated as success and raises no failure count, so without this counter it is invisible in the diagnostics.
Definition at line 479 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::has_last_command {false} |
True once a status reply carried a well-formed last-command record.
Definition at line 451 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::has_system_key {false} |
YAML-declared (system_key:): this device keeps a key of its own.
Every exchange with it uses system_key below instead of the hub's key.
Definition at line 511 of file proto_device_model.h.
| HeatingReadings esphome::home_io_control::IoDevice::heating {} |
What the hub has read from a heater over the private register protocol (room temperature, setpoint, mode, regulator state).
Set only from decoded replies; stays "never read" for every other device type.
Definition at line 506 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::inverted {false} |
True if open/close positions are swapped (e.g., horizontal awning).
Definition at line 422 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::is_stopped {true} |
True if device is not moving.
Definition at line 421 of file proto_device_model.h.
| uint8_t esphome::home_io_control::IoDevice::last_command_originator {0} |
That command's Command Originator byte (ORIGINATOR_* in proto_constants.h).
Only meaningful when has_last_command.
Definition at line 449 of file proto_device_model.h.
| uint8_t esphome::home_io_control::IoDevice::last_commander[NODE_ID_SIZE] {} |
Node ID of the controller that last commanded this device, as reported verbatim by the device in its own status payload.
All zeroes until a status reply carrying the record has been decoded (see decode_last_command_record() in proto_codecs.h).
Definition at line 445 of file proto_device_model.h.
| uint32_t esphome::home_io_control::IoDevice::last_moving_evidence_ms |
millis() of the last sign this device is travelling (see note_moving_evidence(), clear_moving_evidence()), 0 = never.
Hub-side belief, not observation.
Definition at line 471 of file proto_device_model.h.
| uint32_t esphome::home_io_control::IoDevice::last_rain_evidence_ms {0} |
millis() of the last status reply that named the rain sensor as the last commander; 0 = never.
Memory for the clamp rule, aged out by RAIN_EVIDENCE_HOLD_MS.
Definition at line 458 of file proto_device_model.h.
| uint32_t esphome::home_io_control::IoDevice::last_result_at_ms {0} |
millis() timestamp of last_result_code, 0 when none recorded.
Definition at line 444 of file proto_device_model.h.
| uint8_t esphome::home_io_control::IoDevice::last_result_code {0} |
Last CMD_ERROR_RESP result byte (0 = none recorded).
See command_result_name()/is_limitation_result() in proto_constants.h. Cleared by the next successful status/command reply for this device. Note: 0 is also the real RESULT_UNKNOWN_STATUS_REPLY wire value, so that specific explicit reply is indistinguishable here from "nothing recorded yet" — a known, accepted tradeoff.
Definition at line 439 of file proto_device_model.h.
| int16_t esphome::home_io_control::IoDevice::last_rssi_dbm {RSSI_UNKNOWN_DBM} |
Most recent raw RSSI sample (dBm), or RSSI_UNKNOWN_DBM.
Definition at line 462 of file proto_device_model.h.
| uint32_t esphome::home_io_control::IoDevice::last_seen_ms {0} |
millis() of the last frame received from this device (any command), 0 = never.
Definition at line 470 of file proto_device_model.h.
| uint32_t esphome::home_io_control::IoDevice::last_status {0} |
millis() timestamp of last received status.
Definition at line 461 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::limited_by_rain {false} |
Derived from observed status replies, never from a prediction (decisions::is_rain_limited(); ADR 0030 keeps predictions apart): the last move was ordered by the rain sensor, or a position command was clamped while rain protection was recently active.
Separate from last_result_code, which only an explicit CMD_ERROR_RESP sets.
Definition at line 452 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::low_power {false} |
YAML-declared: this target is a low-power / duty-cycled receiver, so directed frames set CTRL1_LOW_POWER and use the long wake-up preamble.
A protocol-reported class exists (discovery Multi Information Byte) but is surfaced through the pairing/scan snippet, never applied at runtime.
Definition at line 429 of file proto_device_model.h.
| char esphome::home_io_control::IoDevice::name[DEVICE_NAME_BUFFER_SIZE] {} |
Cached UTF-8 device name decoded from Latin-1 wire payloads.
Definition at line 417 of file proto_device_model.h.
| uint8_t esphome::home_io_control::IoDevice::node_id[NODE_ID_SIZE] {} |
Device's 3‑byte radio address.
Definition at line 414 of file proto_device_model.h.
| OptimisticState esphome::home_io_control::IoDevice::optimistic {} |
Hub-side predictions; see OptimisticState. Never observation.
Definition at line 492 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::optimistic_state {true} |
True if target may be set ahead of a confirming poll/response.
Definition at line 428 of file proto_device_model.h.
| float esphome::home_io_control::IoDevice::position {UNKNOWN_POSITION} |
Current position: 0=open, 100=closed, or UNKNOWN_POSITION.
Definition at line 418 of file proto_device_model.h.
| RainSensorState esphome::home_io_control::IoDevice::rain_sensor {RainSensorState::UNKNOWN} |
Rain state from the opt-in minimum-limitation poll.
Set only from a limitation reply inside an exchange the hub started; independent of limited_by_rain, which is derived from status replies.
Definition at line 493 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::registered_by_pairing {false} |
Added by a pairing in this boot, not declared in YAML.
The record is lost at reboot, so reports still print its YAML block, and a later pairing may replace it (DeviceRegistry::get_declared()).
Definition at line 515 of file proto_device_model.h.
| int16_t esphome::home_io_control::IoDevice::rssi_ema_scaled {RSSI_UNKNOWN_DBM} |
Smoothed RSSI as fixed point in 1/RSSI_EMA_SCALE dBm — read through device_rssi_ema_dbm(), updated by detail::update_link_health() in hub_internal.h.
Fixed point (rather than whole dBm) keeps sub-dBm EMA contributions from vanishing to integer truncation, so the average converges on a stable signal instead of stalling up to RSSI_EMA_SCALE−1 dBm away. RSSI_UNKNOWN_DBM before the first sample.
Definition at line 463 of file proto_device_model.h.
| bool esphome::home_io_control::IoDevice::silent {false} |
True to send position moves with the reference hub's "silent operation" extended block, which makes the motor travel more slowly.
Like inverted/dimmable this is a YAML-declared preference, not a protocol-reported fact — nothing on the wire tells us whether a device is in that mode.
Definition at line 423 of file proto_device_model.h.
| uint8_t esphome::home_io_control::IoDevice::subtype {0} |
Device subtype (manufacturer‑specific).
Definition at line 416 of file proto_device_model.h.
| uint8_t esphome::home_io_control::IoDevice::system_key[AES_KEY_SIZE] {} |
The device's own key; meaningful only when has_system_key.
Key material: never logged outside a bannered report block.
Definition at line 513 of file proto_device_model.h.
| float esphome::home_io_control::IoDevice::target {UNKNOWN_POSITION} |
Target position the device is moving toward.
Definition at line 420 of file proto_device_model.h.
| float esphome::home_io_control::IoDevice::temperature_range_max_c |
Upper end of that range (YAML max_temperature:).
Definition at line 504 of file proto_device_model.h.
| float esphome::home_io_control::IoDevice::temperature_range_min_c |
Lower end of the temperature encoding range of a heater that carries a temperature in its main parameter (YAML min_temperature:).
Definition at line 501 of file proto_device_model.h.
| float esphome::home_io_control::IoDevice::tilt {UNKNOWN_POSITION} |
Current tilt: 0=closed, 100=open, or UNKNOWN_POSITION.
Definition at line 419 of file proto_device_model.h.
| DeviceType esphome::home_io_control::IoDevice::type {DeviceType::UNKNOWN} |
Device type (shutter, awning, etc.).
Definition at line 415 of file proto_device_model.h.
1.18.0