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

Runtime state of a paired IO‑Homecontrol device. More...

#include <proto_frame.h>

Collaboration diagram for esphome::home_io_control::IoDevice:

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] {}
 Device name (from device, Latin‑1 encoded).
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 single_follow_up_poll_pending {false}
 True when one legacy settle poll should still be scheduled.
uint32_t last_status {0}
 millis() timestamp of last received status.
uint32_t status_poll_interval_ms {0}
 Configured follow-up poll interval while a state change is expected.
uint32_t next_update {0}
 millis() timestamp when we should poll for status next.
uint32_t poll_deadline {0}
 Hard stop for bounded follow-up polling after a command or remote activity.
uint8_t status_poll_failures {0}
 Consecutive background status-poll failures without a valid reply.
uint8_t auth_poll_failures {0}
 Consecutive background poll failures that reached 0x3C auth challenge.

Detailed Description

Runtime state of a paired IO‑Homecontrol device.

Definition at line 371 of file proto_frame.h.

Member Data Documentation

◆ auth_poll_failures

uint8_t esphome::home_io_control::IoDevice::auth_poll_failures {0}

Consecutive background poll failures that reached 0x3C auth challenge.

Definition at line 387 of file proto_frame.h.

◆ inverted

bool esphome::home_io_control::IoDevice::inverted {false}

True if open/close positions are swapped (e.g., horizontal awning).

Definition at line 380 of file proto_frame.h.

◆ is_stopped

bool esphome::home_io_control::IoDevice::is_stopped {true}

True if device is not moving.

Definition at line 379 of file proto_frame.h.

◆ last_status

uint32_t esphome::home_io_control::IoDevice::last_status {0}

millis() timestamp of last received status.

Definition at line 382 of file proto_frame.h.

◆ name

char esphome::home_io_control::IoDevice::name[DEVICE_NAME_BUFFER_SIZE] {}

Device name (from device, Latin‑1 encoded).

Definition at line 375 of file proto_frame.h.

◆ next_update

uint32_t esphome::home_io_control::IoDevice::next_update {0}

millis() timestamp when we should poll for status next.

Definition at line 384 of file proto_frame.h.

◆ node_id

uint8_t esphome::home_io_control::IoDevice::node_id[NODE_ID_SIZE] {}

Device's 3‑byte radio address.

Definition at line 372 of file proto_frame.h.

◆ poll_deadline

uint32_t esphome::home_io_control::IoDevice::poll_deadline {0}

Hard stop for bounded follow-up polling after a command or remote activity.

Definition at line 385 of file proto_frame.h.

◆ position

float esphome::home_io_control::IoDevice::position {UNKNOWN_POSITION}

Current position: 0=open, 100=closed, or UNKNOWN_POSITION.

Definition at line 376 of file proto_frame.h.

◆ single_follow_up_poll_pending

bool esphome::home_io_control::IoDevice::single_follow_up_poll_pending {false}

True when one legacy settle poll should still be scheduled.

Definition at line 381 of file proto_frame.h.

◆ status_poll_failures

uint8_t esphome::home_io_control::IoDevice::status_poll_failures {0}

Consecutive background status-poll failures without a valid reply.

Definition at line 386 of file proto_frame.h.

◆ status_poll_interval_ms

uint32_t esphome::home_io_control::IoDevice::status_poll_interval_ms {0}

Configured follow-up poll interval while a state change is expected.

Definition at line 383 of file proto_frame.h.

◆ subtype

uint8_t esphome::home_io_control::IoDevice::subtype {0}

Device subtype (manufacturer‑specific).

Definition at line 374 of file proto_frame.h.

◆ target

float esphome::home_io_control::IoDevice::target {UNKNOWN_POSITION}

Target position the device is moving toward.

Definition at line 378 of file proto_frame.h.

◆ tilt

float esphome::home_io_control::IoDevice::tilt {UNKNOWN_POSITION}

Current tilt: 0=closed, 100=open, or UNKNOWN_POSITION.

Definition at line 377 of file proto_frame.h.

◆ type

DeviceType esphome::home_io_control::IoDevice::type {DeviceType::UNKNOWN}

Device type (shutter, awning, etc.).

Definition at line 373 of file proto_frame.h.


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