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

Capability bits carried by a DeviceTypeInfo row and resolved onto a device record. More...

Variables

static constexpr DeviceFeatures MAIN_PARAMETER_ONLY = 1U << 0U
 EXECUTE carries no functional parameter at all (VELUX KLF 200 API specification, Appendix 2: "main parameter only").
static constexpr DeviceFeatures LEVELS = 1U << 1U
 Intermediate main-parameter values: a percent position, a brightness or a heat level.
static constexpr DeviceFeatures TILT = 1U << 2U
 Slat angle (functional parameter 3) through the extended status and the tilt EXECUTE.
static constexpr DeviceFeatures FAVORITE = 1U << 3U
 Named position 0xD800, the favourite ("my") position.
static constexpr DeviceFeatures VENT = 1U << 4U
 Named position 0xD803, the window opener's secured ventilation position (VELUX KLF 200 API specification, section 14.2).
static constexpr DeviceFeatures PARTIAL = 1U << 5U
 Named position 0xD809, sent by the Partial Position button: a garage opener runs its stored partial position (issue #163).
static constexpr DeviceFeatures PEDESTRIAN = 1U << 6U
 Named position 0xD807, sent by the Pedestrian Position button.
static constexpr DeviceFeatures EXTENDED_POSITION_FRAME = 1U << 7U
 Position and force-open EXECUTEs use the 8-byte form with functional parameter 1 set (the form validated on roller shutters, awnings, the Izymo dimmer and the pergola); without it they use the 6-byte main-parameter form.
static constexpr DeviceFeatures WINDOW_COMPANIONS = 1U << 8U
 Heater window sensor and open-window-detection switch.
static constexpr DeviceFeatures INVERTED = 1U << 9U
 Direction inverted by default (horizontal awnings: IO 0 is closed).
static constexpr DeviceFeatures WATER_HEATER = 1U << 10U
 Read and commanded as a domestic hot water heater: family-0x00 registers (proto_dhw.h) for its readings and mode, the status main parameter for its target temperature.
static constexpr DeviceFeatures NIGHT_LIGHT = 1U << 11U
 A night light built into a heater with private registers: on/off in register 0x0144, brightness in 0x0142 (proto_heating.h).

Detailed Description

Capability bits carried by a DeviceTypeInfo row and resolved onto a device record.

hub_validators.py mirrors the whole word bit for bit (FEATURE_*, DEVICE_FEATURES) and device_features_sync_test.cpp checks it. Bit 15 is never a capability: the Python mirror uses it for the row's experimental marker.

Variable Documentation

◆ EXTENDED_POSITION_FRAME

DeviceFeatures esphome::home_io_control::device_feature::EXTENDED_POSITION_FRAME = 1U << 7U
staticconstexpr

Position and force-open EXECUTEs use the 8-byte form with functional parameter 1 set (the form validated on roller shutters, awnings, the Izymo dimmer and the pergola); without it they use the 6-byte main-parameter form.

On covers functional parameter 1 is the travel speed (VELUX KLF 200 API specification, Appendix 2), so silent: (the slow profile in that parameter) needs this bit; that proxy holds only for covers, which are the only kinds with silent:.

Definition at line 53 of file proto_device_features.h.

◆ FAVORITE

DeviceFeatures esphome::home_io_control::device_feature::FAVORITE = 1U << 3U
staticconstexpr

Named position 0xD800, the favourite ("my") position.

Absent where a device has refused the alias (garage openers, issue #163).

Definition at line 38 of file proto_device_features.h.

◆ INVERTED

DeviceFeatures esphome::home_io_control::device_feature::INVERTED = 1U << 9U
staticconstexpr

Direction inverted by default (horizontal awnings: IO 0 is closed).

Definition at line 57 of file proto_device_features.h.

◆ LEVELS

DeviceFeatures esphome::home_io_control::device_feature::LEVELS = 1U << 1U
staticconstexpr

Intermediate main-parameter values: a percent position, a brightness or a heat level.

Definition at line 33 of file proto_device_features.h.

◆ MAIN_PARAMETER_ONLY

DeviceFeatures esphome::home_io_control::device_feature::MAIN_PARAMETER_ONLY = 1U << 0U
staticconstexpr

EXECUTE carries no functional parameter at all (VELUX KLF 200 API specification, Appendix 2: "main parameter only").

Read by main_parameter_only_variant() and the table invariants; the frame shape itself is EXTENDED_POSITION_FRAME's job.

Definition at line 31 of file proto_device_features.h.

◆ NIGHT_LIGHT

DeviceFeatures esphome::home_io_control::device_feature::NIGHT_LIGHT = 1U << 11U
staticconstexpr

A night light built into a heater with private registers: on/off in register 0x0144, brightness in 0x0142 (proto_heating.h).

Gates the heater's night_light: light entity.

Definition at line 64 of file proto_device_features.h.

◆ PARTIAL

DeviceFeatures esphome::home_io_control::device_feature::PARTIAL = 1U << 5U
staticconstexpr

Named position 0xD809, sent by the Partial Position button: a garage opener runs its stored partial position (issue #163).

Definition at line 44 of file proto_device_features.h.

◆ PEDESTRIAN

DeviceFeatures esphome::home_io_control::device_feature::PEDESTRIAN = 1U << 6U
staticconstexpr

Named position 0xD807, sent by the Pedestrian Position button.

Todo
Confirm on a real gate opener that 0xD807 opens it to a pedestrian position (experimental).

Definition at line 47 of file proto_device_features.h.

◆ TILT

DeviceFeatures esphome::home_io_control::device_feature::TILT = 1U << 2U
staticconstexpr

Slat angle (functional parameter 3) through the extended status and the tilt EXECUTE.

Definition at line 35 of file proto_device_features.h.

◆ VENT

DeviceFeatures esphome::home_io_control::device_feature::VENT = 1U << 4U
staticconstexpr

Named position 0xD803, the window opener's secured ventilation position (VELUX KLF 200 API specification, section 14.2).

Definition at line 41 of file proto_device_features.h.

◆ WATER_HEATER

DeviceFeatures esphome::home_io_control::device_feature::WATER_HEATER = 1U << 10U
staticconstexpr

Read and commanded as a domestic hot water heater: family-0x00 registers (proto_dhw.h) for its readings and mode, the status main parameter for its target temperature.

Gates the water heater poll, its register reads and writes, and the water_heater: platform.

Definition at line 61 of file proto_device_features.h.

◆ WINDOW_COMPANIONS

DeviceFeatures esphome::home_io_control::device_feature::WINDOW_COMPANIONS = 1U << 8U
staticconstexpr

Heater window sensor and open-window-detection switch.

Definition at line 55 of file proto_device_features.h.