Support multiple MQTT availability topics (#37418)
* Support multiple MQTT availability topics * Make availability list and availability_topic exclusive * Make availability list and availability_topic exclusive * Add missing abbreviation
This commit is contained in:
1 parent
9ade1de3d5
commit
4b3ad0a1cd
4 files changed
+260
-18
No files matched your search
@@ -88,6 +88,8 @@ CONF_TLS_INSECURE = "tls_insecure"
|
||||
CONF_TLS_VERSION = "tls_version"
|
||||
|
||||
CONF_COMMAND_TOPIC = "command_topic"
|
||||
CONF_TOPIC = "topic"
|
||||
CONF_AVAILABILITY = "availability"
|
||||
CONF_AVAILABILITY_TOPIC = "availability_topic"
|
||||
CONF_PAYLOAD_AVAILABLE = "payload_available"
|
||||
CONF_PAYLOAD_NOT_AVAILABLE = "payload_not_available"
|
||||
@@ -203,9 +205,9 @@ CONFIG_SCHEMA = vol.Schema(
|
||||
|
||||
SCHEMA_BASE = {vol.Optional(CONF_QOS, default=DEFAULT_QOS): _VALID_QOS_SCHEMA}
|
||||
|
||||
MQTT_AVAILABILITY_SCHEMA = vol.Schema(
|
||||
MQTT_AVAILABILITY_SINGLE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_AVAILABILITY_TOPIC): valid_subscribe_topic,
|
||||
vol.Exclusive(CONF_AVAILABILITY_TOPIC, "availability"): valid_subscribe_topic,
|
||||
vol.Optional(
|
||||
CONF_PAYLOAD_AVAILABLE, default=DEFAULT_PAYLOAD_AVAILABLE
|
||||
): cv.string,
|
||||
@@ -215,6 +217,30 @@ MQTT_AVAILABILITY_SCHEMA = vol.Schema(
|
||||
}
|
||||
)
|
||||
|
||||
MQTT_AVAILABILITY_LIST_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Exclusive(CONF_AVAILABILITY, "availability"): vol.All(
|
||||
cv.ensure_list,
|
||||
[
|
||||
{
|
||||
vol.Optional(CONF_TOPIC): valid_subscribe_topic,
|
||||
vol.Optional(
|
||||
CONF_PAYLOAD_AVAILABLE, default=DEFAULT_PAYLOAD_AVAILABLE
|
||||
): cv.string,
|
||||
vol.Optional(
|
||||
CONF_PAYLOAD_NOT_AVAILABLE,
|
||||
default=DEFAULT_PAYLOAD_NOT_AVAILABLE,
|
||||
): cv.string,
|
||||
}
|
||||
],
|
||||
),
|
||||
}
|
||||
)
|
||||
|
||||
MQTT_AVAILABILITY_SCHEMA = MQTT_AVAILABILITY_SINGLE_SCHEMA.extend(
|
||||
MQTT_AVAILABILITY_LIST_SCHEMA.schema
|
||||
)
|
||||
|
||||
MQTT_ENTITY_DEVICE_INFO_SCHEMA = vol.All(
|
||||
cv.deprecated(CONF_DEPRECATED_VIA_HUB, CONF_VIA_DEVICE),
|
||||
vol.Schema(
|
||||
@@ -989,8 +1015,7 @@ class MqttAvailability(Entity):
|
||||
"""Initialize the availability mixin."""
|
||||
self._availability_sub_state = None
|
||||
self._available = False
|
||||
|
||||
self._avail_config = config
|
||||
self._availability_setup_from_config(config)
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Subscribe MQTT events."""
|
||||
@@ -1004,9 +1029,27 @@ class MqttAvailability(Entity):
|
||||
|
||||
async def availability_discovery_update(self, config: dict):
|
||||
"""Handle updated discovery message."""
|
||||
self._avail_config = config
|
||||
self._availability_setup_from_config(config)
|
||||
await self._availability_subscribe_topics()
|
||||
|
||||
def _availability_setup_from_config(self, config):
|
||||
"""(Re)Setup."""
|
||||
self._avail_topics = {}
|
||||
if CONF_AVAILABILITY_TOPIC in config:
|
||||
self._avail_topics[config[CONF_AVAILABILITY_TOPIC]] = {
|
||||
CONF_PAYLOAD_AVAILABLE: config[CONF_PAYLOAD_AVAILABLE],
|
||||
CONF_PAYLOAD_NOT_AVAILABLE: config[CONF_PAYLOAD_NOT_AVAILABLE],
|
||||
}
|
||||
|
||||
if CONF_AVAILABILITY in config:
|
||||
for avail in config[CONF_AVAILABILITY]:
|
||||
self._avail_topics[avail[CONF_TOPIC]] = {
|
||||
CONF_PAYLOAD_AVAILABLE: avail[CONF_PAYLOAD_AVAILABLE],
|
||||
CONF_PAYLOAD_NOT_AVAILABLE: avail[CONF_PAYLOAD_NOT_AVAILABLE],
|
||||
}
|
||||
|
||||
self._avail_config = config
|
||||
|
||||
async def _availability_subscribe_topics(self):
|
||||
"""(Re)Subscribe to topics."""
|
||||
|
||||
@@ -1014,23 +1057,24 @@ class MqttAvailability(Entity):
|
||||
@log_messages(self.hass, self.entity_id)
|
||||
def availability_message_received(msg: Message) -> None:
|
||||
"""Handle a new received MQTT availability message."""
|
||||
if msg.payload == self._avail_config[CONF_PAYLOAD_AVAILABLE]:
|
||||
topic = msg.topic
|
||||
if msg.payload == self._avail_topics[topic][CONF_PAYLOAD_AVAILABLE]:
|
||||
self._available = True
|
||||
elif msg.payload == self._avail_config[CONF_PAYLOAD_NOT_AVAILABLE]:
|
||||
elif msg.payload == self._avail_topics[topic][CONF_PAYLOAD_NOT_AVAILABLE]:
|
||||
self._available = False
|
||||
|
||||
self.async_write_ha_state()
|
||||
|
||||
topics = {}
|
||||
for topic in self._avail_topics:
|
||||
topics[f"availability_{topic}"] = {
|
||||
"topic": topic,
|
||||
"msg_callback": availability_message_received,
|
||||
"qos": self._avail_config[CONF_QOS],
|
||||
}
|
||||
|
||||
self._availability_sub_state = await async_subscribe_topics(
|
||||
self.hass,
|
||||
self._availability_sub_state,
|
||||
{
|
||||
"availability_topic": {
|
||||
"topic": self._avail_config.get(CONF_AVAILABILITY_TOPIC),
|
||||
"msg_callback": availability_message_received,
|
||||
"qos": self._avail_config[CONF_QOS],
|
||||
}
|
||||
},
|
||||
self.hass, self._availability_sub_state, topics,
|
||||
)
|
||||
|
||||
@callback
|
||||
@@ -1048,10 +1092,9 @@ class MqttAvailability(Entity):
|
||||
@property
|
||||
def available(self) -> bool:
|
||||
"""Return if the device is available."""
|
||||
availability_topic = self._avail_config.get(CONF_AVAILABILITY_TOPIC)
|
||||
if not self.hass.data[DATA_MQTT].connected:
|
||||
return False
|
||||
return availability_topic is None or self._available
|
||||
return not self._avail_topics or self._available
|
||||
|
||||
|
||||
async def cleanup_device_registry(hass, device_id):
|
||||
|
||||
@@ -7,6 +7,7 @@ ABBREVIATIONS = {
|
||||
"aux_cmd_t": "aux_command_topic",
|
||||
"aux_stat_tpl": "aux_state_template",
|
||||
"aux_stat_t": "aux_state_topic",
|
||||
"avty": "availability",
|
||||
"avty_t": "availability_topic",
|
||||
"away_mode_cmd_t": "away_mode_command_topic",
|
||||
"away_mode_stat_tpl": "away_mode_state_template",
|
||||
|
||||
Reference in new issue
Block a user