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

YAML-declared device metadata for registration; defaults match an undeclared device. More...

#include <device_registry.h>

Collaboration diagram for esphome::home_io_control::DeviceConfig:

Public Attributes

DeviceType type {DeviceType::UNKNOWN}
 Device type from YAML declaration.
uint8_t subtype {0}
 Device subtype byte.
bool inverted {false}
 Position-inversion flag.
bool optimistic_state {true}
 Whether apply_optimistic_target/apply_optimistic_stop may fire.
bool silent {false}
 Send position moves in "silent operation" (slower) mode.
bool low_power {false}
 Target is a low-power / duty-cycled receiver: directed frames set CTRL1_LOW_POWER and use the long wake-up preamble.
bool battery_entities {false}
 battery: true declared: the battery entities exist for this device.
bool has_system_key {false}
 system_key: declared: the device keeps a key of its own.
uint8_t system_key [AES_KEY_SIZE] {}
 That key; meaningful only when has_system_key. Never logged.

Detailed Description

YAML-declared device metadata for registration; defaults match an undeclared device.

A new per-device attribute is a new field with a default here, not a new add() overload.

Definition at line 27 of file device_registry.h.

Member Data Documentation

◆ battery_entities

bool esphome::home_io_control::DeviceConfig::battery_entities {false}

battery: true declared: the battery entities exist for this device.

Definition at line 35 of file device_registry.h.

◆ has_system_key

bool esphome::home_io_control::DeviceConfig::has_system_key {false}

system_key: declared: the device keeps a key of its own.

Definition at line 36 of file device_registry.h.

◆ inverted

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

Position-inversion flag.

Definition at line 30 of file device_registry.h.

◆ low_power

bool esphome::home_io_control::DeviceConfig::low_power {false}

Target is a low-power / duty-cycled receiver: directed frames set CTRL1_LOW_POWER and use the long wake-up preamble.

Definition at line 33 of file device_registry.h.

◆ optimistic_state

bool esphome::home_io_control::DeviceConfig::optimistic_state {true}

Whether apply_optimistic_target/apply_optimistic_stop may fire.

Definition at line 31 of file device_registry.h.

◆ silent

bool esphome::home_io_control::DeviceConfig::silent {false}

Send position moves in "silent operation" (slower) mode.

Definition at line 32 of file device_registry.h.

◆ subtype

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

Device subtype byte.

Definition at line 29 of file device_registry.h.

◆ system_key

uint8_t esphome::home_io_control::DeviceConfig::system_key[AES_KEY_SIZE] {}

That key; meaningful only when has_system_key. Never logged.

Definition at line 37 of file device_registry.h.

◆ type

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

Device type from YAML declaration.

Definition at line 28 of file device_registry.h.


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