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.
DeviceModel	model {DeviceModel::NONE}
	YAML io_model:; NONE when not declared.
DeviceCapabilityClass	entity_class
	Class of the declaring entity; decides the features of a kind the type table does not know.
std::optional< bool >	invert_override
	YAML invert_position: when declared; the kind's default otherwise.
bool	dimmable {false}
	YAML dimmable: true of a light.
bool	optimistic_state {true}
	Whether apply_optimistic_target/apply_optimistic_stop may fire.
TravelSpeed	travel_speed {TravelSpeed::FAST}
	Speed profile of position moves.
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 28 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 42 of file device_registry.h.

dimmable

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

YAML dimmable: true of a light.

Definition at line 37 of file device_registry.h.

entity_class

DeviceCapabilityClass esphome::home_io_control::DeviceConfig::entity_class

Initial value:

{
      DeviceCapabilityClass::UNKNOWN}

Class of the declaring entity; decides the features of a kind the type table does not know.

Definition at line 32 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 43 of file device_registry.h.

invert_override

std::optional<bool> esphome::home_io_control::DeviceConfig::invert_override

Initial value:

                          =
std::nullopt

YAML invert_position: when declared; the kind's default otherwise.

Definition at line 35 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 40 of file device_registry.h.

model

DeviceModel esphome::home_io_control::DeviceConfig::model {DeviceModel::NONE}

YAML io_model:; NONE when not declared.

Definition at line 31 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 38 of file device_registry.h.

subtype

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

Device subtype byte.

Definition at line 30 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 44 of file device_registry.h.

travel_speed

TravelSpeed esphome::home_io_control::DeviceConfig::travel_speed {TravelSpeed::FAST}

Speed profile of position moves.

Definition at line 39 of file device_registry.h.

type

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

Device type from YAML declaration.

Definition at line 29 of file device_registry.h.

---

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

• components/home_io_control/device_registry.h