5 Commits

Author SHA1 Message Date
502a33dbac Add options flow fallback for ports 2026-02-13 19:33:55 +01:00
8b20cf4744 Improve subentry type detection 2026-02-13 19:29:11 +01:00
6de191b10b Handle missing subentry support 2026-02-13 19:18:01 +01:00
2175e5919e Fix subentry type compatibility 2026-02-13 19:08:13 +01:00
83518c88ab Centralize DPT auto-selection 2026-02-13 14:13:31 +01:00
7 changed files with 292 additions and 27 deletions

View File

@@ -1,5 +1,20 @@
# Changelog # Changelog
## 0.0.9 - 2026-02-13
- Add options flow fallback to add/remove ports when subentries are unavailable.
## 0.0.8 - 2026-02-13
- Improve subentry type detection for HA versions exposing different class names.
## 0.0.7 - 2026-02-13
- Avoid crashing config entries when subentries are unsupported.
## 0.0.6 - 2026-02-13
- Fix config flow subentry type compatibility with older Home Assistant versions.
## 0.0.5 - 2026-02-13
- Centralize DPT auto-selection for KNX event registration per address.
## 0.0.4 - 2026-02-13 ## 0.0.4 - 2026-02-13
- Add per-group-address invert toggles for incoming and outgoing KNX payloads. - Add per-group-address invert toggles for incoming and outgoing KNX payloads.

View File

@@ -21,6 +21,8 @@ Current minimal scope:
## Configure ## Configure
1. During setup, select the existing Home Assistant KNX integration entry. 1. During setup, select the existing Home Assistant KNX integration entry.
2. Add Ports from the integration's configuration page. 2. Add Ports from the integration's configuration page.
If the "Add Port" UI is missing, open the integration options and manage ports
there (fallback for HA versions without subentry support).
### Binary Sensor Port ### Binary Sensor Port
- `entity_id`: the HA binary_sensor to mirror. - `entity_id`: the HA binary_sensor to mirror.
@@ -47,6 +49,17 @@ Each group address has `invert incoming` and `invert outgoing` toggles to flip K
## Notes ## Notes
- For DPT 1.008 (Up/Down), the bridge treats `0 = Up/Open` and `1 = Down/Close`. - For DPT 1.008 (Up/Down), the bridge treats `0 = Up/Open` and `1 = Down/Close`.
- For DPT 5.001, values are interpreted as 0-100 percent where 0 = closed and 100 = open. - For DPT 5.001, values are interpreted as 0-100 percent where 0 = closed and 100 = open.
- DPTs are auto-selected per address:
- Binary sensor `state_address`: DPT 1
- Switch `command_address`: DPT 1
- Switch `state_address`: DPT 1
- Cover `move_long_address`: DPT 1.008
- Cover `move_short_address`: DPT 1.007
- Cover `stop_address`: DPT 1
- Cover `position_address`: DPT 5.001
- Cover `position_state_address`: DPT 5.001
- Cover `angle_address`: DPT 5.001
- Cover `angle_state_address`: DPT 5.001
## Roadmap ## Roadmap
- Optional standalone KNX connection (without requiring the HA KNX integration). - Optional standalone KNX connection (without requiring the HA KNX integration).
@@ -54,6 +67,6 @@ Each group address has `invert incoming` and `invert outgoing` toggles to flip K
- Advanced DPT mapping options and inversion settings. - Advanced DPT mapping options and inversion settings.
## Versioning and Releases ## Versioning and Releases
- Current version: 0.0.4 - Current version: 0.0.9
- `CHANGELOG.md` lists versions with the newest entries at the top. - `CHANGELOG.md` lists versions with the newest entries at the top.
- Release creation is manual and only done when explicitly requested. - Release creation is manual and only done when explicitly requested.

View File

@@ -12,11 +12,13 @@ from homeassistant.helpers import event as event_helper
from .const import ( from .const import (
CONF_ANGLE_ADDRESS, CONF_ANGLE_ADDRESS,
CONF_ANGLE_STATE_ADDRESS, CONF_ANGLE_STATE_ADDRESS,
ADDRESS_VALUE_TYPE,
CONF_COMMAND_ADDRESS, CONF_COMMAND_ADDRESS,
CONF_INVERT_INCOMING, CONF_INVERT_INCOMING,
CONF_INVERT_OUTGOING, CONF_INVERT_OUTGOING,
CONF_MOVE_LONG_ADDRESS, CONF_MOVE_LONG_ADDRESS,
CONF_MOVE_SHORT_ADDRESS, CONF_MOVE_SHORT_ADDRESS,
CONF_PORTS,
CONF_POSITION_ADDRESS, CONF_POSITION_ADDRESS,
CONF_POSITION_STATE_ADDRESS, CONF_POSITION_STATE_ADDRESS,
CONF_STATE_ADDRESS, CONF_STATE_ADDRESS,
@@ -116,10 +118,8 @@ class BridgeManager:
switch_ports: list[SwitchPort] = [] switch_ports: list[SwitchPort] = []
cover_ports: list[CoverPort] = [] cover_ports: list[CoverPort] = []
subentries = getattr(self.entry, "subentries", []) for port_type, data in _iter_port_configs(self.entry):
for subentry in subentries: if port_type == "binary_sensor":
data = subentry.data
if subentry.type == "binary_sensor":
binary_ports.append( binary_ports.append(
BinarySensorPort( BinarySensorPort(
entity_id=data["entity_id"], entity_id=data["entity_id"],
@@ -132,7 +132,7 @@ class BridgeManager:
), ),
) )
) )
elif subentry.type == "switch": elif port_type == "switch":
switch_ports.append( switch_ports.append(
SwitchPort( SwitchPort(
entity_id=data["entity_id"], entity_id=data["entity_id"],
@@ -154,7 +154,7 @@ class BridgeManager:
), ),
) )
) )
elif subentry.type == "cover": elif port_type == "cover":
cover_ports.append( cover_ports.append(
CoverPort( CoverPort(
entity_id=data["entity_id"], entity_id=data["entity_id"],
@@ -227,7 +227,7 @@ class BridgeManager:
continue continue
self._remember_address_options( self._remember_address_options(
port.state_address, port.state_address,
None, _get_value_type(CONF_STATE_ADDRESS),
port.state_invert_incoming, port.state_invert_incoming,
port.state_invert_outgoing, port.state_invert_outgoing,
) )
@@ -242,7 +242,7 @@ class BridgeManager:
continue continue
self._remember_address_options( self._remember_address_options(
port.state_address, port.state_address,
None, _get_value_type(CONF_STATE_ADDRESS),
port.state_invert_incoming, port.state_invert_incoming,
port.state_invert_outgoing, port.state_invert_outgoing,
) )
@@ -258,14 +258,14 @@ class BridgeManager:
if port.position_state_address: if port.position_state_address:
self._remember_address_options( self._remember_address_options(
port.position_state_address, port.position_state_address,
"percent", _get_value_type(CONF_POSITION_STATE_ADDRESS),
port.position_state_invert_incoming, port.position_state_invert_incoming,
port.position_state_invert_outgoing, port.position_state_invert_outgoing,
) )
if port.angle_state_address: if port.angle_state_address:
self._remember_address_options( self._remember_address_options(
port.angle_state_address, port.angle_state_address,
"percent", _get_value_type(CONF_ANGLE_STATE_ADDRESS),
port.angle_state_invert_incoming, port.angle_state_invert_incoming,
port.angle_state_invert_outgoing, port.angle_state_invert_outgoing,
) )
@@ -289,7 +289,7 @@ class BridgeManager:
for port in cover_ports: for port in cover_ports:
self._register_knx_address( self._register_knx_address(
port.move_long_address, port.move_long_address,
None, CONF_MOVE_LONG_ADDRESS,
port.move_long_invert_incoming, port.move_long_invert_incoming,
port.move_long_invert_outgoing, port.move_long_invert_outgoing,
port, port,
@@ -297,7 +297,7 @@ class BridgeManager:
) )
self._register_knx_address( self._register_knx_address(
port.move_short_address, port.move_short_address,
None, CONF_MOVE_SHORT_ADDRESS,
port.move_short_invert_incoming, port.move_short_invert_incoming,
port.move_short_invert_outgoing, port.move_short_invert_outgoing,
port, port,
@@ -305,7 +305,7 @@ class BridgeManager:
) )
self._register_knx_address( self._register_knx_address(
port.stop_address, port.stop_address,
None, CONF_STOP_ADDRESS,
port.stop_invert_incoming, port.stop_invert_incoming,
port.stop_invert_outgoing, port.stop_invert_outgoing,
port, port,
@@ -313,7 +313,7 @@ class BridgeManager:
) )
self._register_knx_address( self._register_knx_address(
port.position_address, port.position_address,
"percent", CONF_POSITION_ADDRESS,
port.position_invert_incoming, port.position_invert_incoming,
port.position_invert_outgoing, port.position_invert_outgoing,
port, port,
@@ -321,7 +321,7 @@ class BridgeManager:
) )
self._register_knx_address( self._register_knx_address(
port.angle_address, port.angle_address,
"percent", CONF_ANGLE_ADDRESS,
port.angle_invert_incoming, port.angle_invert_incoming,
port.angle_invert_outgoing, port.angle_invert_outgoing,
port, port,
@@ -338,7 +338,7 @@ class BridgeManager:
def _register_knx_address( def _register_knx_address(
self, self,
address: str | None, address: str | None,
value_type: str | None, address_key: str,
invert_incoming: bool, invert_incoming: bool,
invert_outgoing: bool, invert_outgoing: bool,
port: CoverPort, port: CoverPort,
@@ -350,6 +350,7 @@ class BridgeManager:
self._address_handlers[address] = lambda event: self._handle_cover_action( self._address_handlers[address] = lambda event: self._handle_cover_action(
port, action, event port, action, event
) )
value_type = _get_value_type(address_key)
self._remember_address_options( self._remember_address_options(
address, value_type, invert_incoming, invert_outgoing address, value_type, invert_incoming, invert_outgoing
) )
@@ -368,7 +369,10 @@ class BridgeManager:
port, event port, event
) )
self._remember_address_options( self._remember_address_options(
address, None, invert_incoming, invert_outgoing address,
_get_value_type(CONF_COMMAND_ADDRESS),
invert_incoming,
invert_outgoing,
) )
self._registered_addresses.append((address, None)) self._registered_addresses.append((address, None))
@@ -623,3 +627,21 @@ def _invert_in_key(address_key: str) -> str:
def _invert_out_key(address_key: str) -> str: def _invert_out_key(address_key: str) -> str:
return f"{address_key}_{CONF_INVERT_OUTGOING}" return f"{address_key}_{CONF_INVERT_OUTGOING}"
def _get_value_type(address_key: str) -> str | None:
return ADDRESS_VALUE_TYPE.get(address_key)
def _iter_port_configs(entry: ConfigEntry) -> list[tuple[str, dict[str, Any]]]:
ports: list[tuple[str, dict[str, Any]]] = []
subentries = getattr(entry, "subentries", [])
for subentry in subentries:
ports.append((subentry.type, subentry.data))
option_ports = entry.options.get(CONF_PORTS, [])
for port in option_ports:
port_type = port.get("type")
data = port.get("data", {})
if port_type and isinstance(data, dict):
ports.append((port_type, data))
return ports

View File

@@ -1,6 +1,7 @@
from __future__ import annotations from __future__ import annotations
import logging import logging
import uuid
import voluptuous as vol import voluptuous as vol
@@ -18,6 +19,8 @@ from .const import (
CONF_KNX_ENTRY_ID, CONF_KNX_ENTRY_ID,
CONF_MOVE_LONG_ADDRESS, CONF_MOVE_LONG_ADDRESS,
CONF_MOVE_SHORT_ADDRESS, CONF_MOVE_SHORT_ADDRESS,
CONF_PORTS,
CONF_PORT_ID,
CONF_POSITION_ADDRESS, CONF_POSITION_ADDRESS,
CONF_POSITION_STATE_ADDRESS, CONF_POSITION_STATE_ADDRESS,
CONF_STATE_ADDRESS, CONF_STATE_ADDRESS,
@@ -65,14 +68,20 @@ class HAKnxBridgeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
@staticmethod @staticmethod
@callback @callback
def async_get_supported_subentry_types(config_entry): def async_get_supported_subentry_types(config_entry):
subentry_type = _get_subentry_type()
if subentry_type is None:
_LOGGER.warning(
"Config subentries are not supported in this Home Assistant version"
)
return {}
return { return {
"binary_sensor": config_entries.SubentryType( "binary_sensor": subentry_type(
name="Binary Sensor Port", flow_class=BinarySensorPortSubentryFlow name="Binary Sensor Port", flow_class=BinarySensorPortSubentryFlow
), ),
"switch": config_entries.SubentryType( "switch": subentry_type(
name="Switch Port", flow_class=SwitchPortSubentryFlow name="Switch Port", flow_class=SwitchPortSubentryFlow
), ),
"cover": config_entries.SubentryType( "cover": subentry_type(
name="Cover Port", flow_class=CoverPortSubentryFlow name="Cover Port", flow_class=CoverPortSubentryFlow
), ),
} }
@@ -83,11 +92,114 @@ class HAKnxBridgeOptionsFlow(config_entries.OptionsFlow):
self._config_entry = config_entry self._config_entry = config_entry
async def async_step_init(self, user_input: dict | None = None): async def async_step_init(self, user_input: dict | None = None):
if user_input is not None: return self.async_show_menu(
return self.async_create_entry(title="", data=user_input) step_id="init",
menu_options=[
"add_binary_sensor",
"add_switch",
"add_cover",
"remove_port",
],
)
schema = vol.Schema({}) async def async_step_add_binary_sensor(self, user_input: dict | None = None):
return self.async_show_form(step_id="init", data_schema=schema) if user_input is not None:
user_input, errors = _validate_knx_addresses(
user_input,
[
CONF_STATE_ADDRESS,
],
)
if errors:
return self.async_show_form(
step_id="add_binary_sensor",
data_schema=_binary_sensor_schema(),
errors=errors,
)
return await self._async_store_port("binary_sensor", user_input)
return self.async_show_form(
step_id="add_binary_sensor", data_schema=_binary_sensor_schema()
)
async def async_step_add_switch(self, user_input: dict | None = None):
if user_input is not None:
user_input, errors = _validate_knx_addresses(
user_input, [CONF_COMMAND_ADDRESS, CONF_STATE_ADDRESS]
)
if errors:
return self.async_show_form(
step_id="add_switch",
data_schema=_switch_schema(),
errors=errors,
)
return await self._async_store_port("switch", user_input)
return self.async_show_form(
step_id="add_switch", data_schema=_switch_schema()
)
async def async_step_add_cover(self, user_input: dict | None = None):
if user_input is not None:
user_input, errors = _validate_knx_addresses(
user_input,
[
CONF_MOVE_LONG_ADDRESS,
CONF_MOVE_SHORT_ADDRESS,
CONF_STOP_ADDRESS,
CONF_POSITION_ADDRESS,
CONF_POSITION_STATE_ADDRESS,
CONF_ANGLE_ADDRESS,
CONF_ANGLE_STATE_ADDRESS,
],
)
if errors:
return self.async_show_form(
step_id="add_cover", data_schema=_cover_schema(), errors=errors
)
return await self._async_store_port("cover", user_input)
return self.async_show_form(step_id="add_cover", data_schema=_cover_schema())
async def async_step_remove_port(self, user_input: dict | None = None):
ports = list(self._config_entry.options.get(CONF_PORTS, []))
if not ports:
return self.async_abort(reason="no_ports_to_remove")
if user_input is not None:
port_id = user_input[CONF_PORT_ID]
ports = [port for port in ports if port.get("id") != port_id]
return self.async_create_entry(title="", data={CONF_PORTS: ports})
options = [
{
"value": port.get("id"),
"label": port.get("title", port.get("id")),
}
for port in ports
if port.get("id")
]
schema = vol.Schema(
{
vol.Required(CONF_PORT_ID): selector.SelectSelector(
selector.SelectSelectorConfig(options=options, mode="dropdown")
)
}
)
return self.async_show_form(step_id="remove_port", data_schema=schema)
async def _async_store_port(self, port_type: str, user_input: dict):
ports = list(self._config_entry.options.get(CONF_PORTS, []))
title = _entity_title(self.hass, user_input[CONF_ENTITY_ID])
ports.append(
{
"id": uuid.uuid4().hex,
"type": port_type,
"title": title,
"data": user_input,
}
)
return self.async_create_entry(title="", data={CONF_PORTS: ports})
class BinarySensorPortSubentryFlow(config_entries.ConfigSubentryFlow): class BinarySensorPortSubentryFlow(config_entries.ConfigSubentryFlow):
@@ -346,3 +458,22 @@ def _invert_in_key(address_key: str) -> str:
def _invert_out_key(address_key: str) -> str: def _invert_out_key(address_key: str) -> str:
return f"{address_key}_{CONF_INVERT_OUTGOING}" return f"{address_key}_{CONF_INVERT_OUTGOING}"
def _get_subentry_type():
candidates = [
"SubentryType",
"ConfigEntrySubentryType",
"ConfigSubentryType",
"SubEntryType",
]
for name in candidates:
subentry_type = getattr(config_entries, name, None)
if subentry_type is not None:
return subentry_type
_LOGGER.debug(
"Subentry type class not found on homeassistant.config_entries. "
"Available attrs: %s",
", ".join(sorted(dir(config_entries))),
)
return None

View File

@@ -6,6 +6,8 @@ CONF_STATE_ADDRESS = "state_address"
CONF_COMMAND_ADDRESS = "command_address" CONF_COMMAND_ADDRESS = "command_address"
CONF_INVERT_INCOMING = "invert_incoming" CONF_INVERT_INCOMING = "invert_incoming"
CONF_INVERT_OUTGOING = "invert_outgoing" CONF_INVERT_OUTGOING = "invert_outgoing"
CONF_PORTS = "ports"
CONF_PORT_ID = "port_id"
CONF_MOVE_LONG_ADDRESS = "move_long_address" CONF_MOVE_LONG_ADDRESS = "move_long_address"
CONF_MOVE_SHORT_ADDRESS = "move_short_address" CONF_MOVE_SHORT_ADDRESS = "move_short_address"
@@ -14,3 +16,22 @@ CONF_POSITION_ADDRESS = "position_address"
CONF_POSITION_STATE_ADDRESS = "position_state_address" CONF_POSITION_STATE_ADDRESS = "position_state_address"
CONF_ANGLE_ADDRESS = "angle_address" CONF_ANGLE_ADDRESS = "angle_address"
CONF_ANGLE_STATE_ADDRESS = "angle_state_address" CONF_ANGLE_STATE_ADDRESS = "angle_state_address"
ADDRESS_DPT_MAP: dict[str, str] = {
CONF_STATE_ADDRESS: "1",
CONF_COMMAND_ADDRESS: "1",
CONF_MOVE_LONG_ADDRESS: "1.008",
CONF_MOVE_SHORT_ADDRESS: "1.007",
CONF_STOP_ADDRESS: "1",
CONF_POSITION_ADDRESS: "5.001",
CONF_POSITION_STATE_ADDRESS: "5.001",
CONF_ANGLE_ADDRESS: "5.001",
CONF_ANGLE_STATE_ADDRESS: "5.001",
}
ADDRESS_VALUE_TYPE: dict[str, str] = {
CONF_POSITION_ADDRESS: "percent",
CONF_POSITION_STATE_ADDRESS: "percent",
CONF_ANGLE_ADDRESS: "percent",
CONF_ANGLE_STATE_ADDRESS: "percent",
}

View File

@@ -1,7 +1,7 @@
{ {
"domain": "ha_knx_bridge", "domain": "ha_knx_bridge",
"name": "HA KNX Bridge", "name": "HA KNX Bridge",
"version": "0.0.4", "version": "0.0.9",
"config_flow": true, "config_flow": true,
"documentation": "https://github.com/bahmcloud/HA-KNX-Bridge", "documentation": "https://github.com/bahmcloud/HA-KNX-Bridge",
"issue_tracker": "https://github.com/bahmcloud/HA-KNX-Bridge/issues", "issue_tracker": "https://github.com/bahmcloud/HA-KNX-Bridge/issues",

View File

@@ -17,10 +17,73 @@
} }
}, },
"options": { "options": {
"abort": {
"no_ports_to_remove": "There are no ports to remove yet."
},
"step": { "step": {
"init": { "init": {
"title": "HA KNX Bridge Options", "title": "HA KNX Bridge Options",
"description": "No options available yet." "description": "Manage ports when subentries are unavailable.",
"menu_options": {
"add_binary_sensor": "Add binary sensor port",
"add_switch": "Add switch port",
"add_cover": "Add cover port",
"remove_port": "Remove port"
}
},
"add_binary_sensor": {
"title": "Add Binary Sensor Port",
"data": {
"entity_id": "Binary sensor entity",
"state_address": "State group address (DPT 1)",
"state_address_invert_incoming": "Invert incoming",
"state_address_invert_outgoing": "Invert outgoing"
}
},
"add_switch": {
"title": "Add Switch Port",
"data": {
"entity_id": "Switch entity",
"command_address": "Command group address (DPT 1)",
"command_address_invert_incoming": "Invert incoming",
"command_address_invert_outgoing": "Invert outgoing",
"state_address": "State group address (DPT 1)",
"state_address_invert_incoming": "Invert incoming",
"state_address_invert_outgoing": "Invert outgoing"
}
},
"add_cover": {
"title": "Add Cover Port",
"data": {
"entity_id": "Cover entity",
"move_long_address": "Move long (DPT 1.008 Up/Down)",
"move_long_address_invert_incoming": "Invert incoming",
"move_long_address_invert_outgoing": "Invert outgoing",
"move_short_address": "Move short (DPT 1.007 Step)",
"move_short_address_invert_incoming": "Invert incoming",
"move_short_address_invert_outgoing": "Invert outgoing",
"stop_address": "Stop (DPT 1)",
"stop_address_invert_incoming": "Invert incoming",
"stop_address_invert_outgoing": "Invert outgoing",
"position_address": "Set position (DPT 5.001)",
"position_address_invert_incoming": "Invert incoming",
"position_address_invert_outgoing": "Invert outgoing",
"position_state_address": "State position (DPT 5.001)",
"position_state_address_invert_incoming": "Invert incoming",
"position_state_address_invert_outgoing": "Invert outgoing",
"angle_address": "Set tilt (DPT 5.001)",
"angle_address_invert_incoming": "Invert incoming",
"angle_address_invert_outgoing": "Invert outgoing",
"angle_state_address": "State tilt (DPT 5.001)",
"angle_state_address_invert_incoming": "Invert incoming",
"angle_state_address_invert_outgoing": "Invert outgoing"
}
},
"remove_port": {
"title": "Remove Port",
"data": {
"port_id": "Port to remove"
}
} }
} }
}, },