Move manual configuration of MQTT siren to the integration key (#72278)
Add siren
This commit is contained in:
parent
623abb1147
commit
c4893f96f6
3 changed files with 38 additions and 4 deletions
|
@ -200,6 +200,7 @@ PLATFORM_CONFIG_SCHEMA_BASE = vol.Schema(
|
||||||
vol.Optional(Platform.HUMIDIFIER.value): cv.ensure_list,
|
vol.Optional(Platform.HUMIDIFIER.value): cv.ensure_list,
|
||||||
vol.Optional(Platform.LIGHT.value): cv.ensure_list,
|
vol.Optional(Platform.LIGHT.value): cv.ensure_list,
|
||||||
vol.Optional(Platform.LOCK.value): cv.ensure_list,
|
vol.Optional(Platform.LOCK.value): cv.ensure_list,
|
||||||
|
vol.Optional(Platform.SIREN.value): cv.ensure_list,
|
||||||
vol.Optional(Platform.SWITCH.value): cv.ensure_list,
|
vol.Optional(Platform.SWITCH.value): cv.ensure_list,
|
||||||
vol.Optional(Platform.VACUUM.value): cv.ensure_list,
|
vol.Optional(Platform.VACUUM.value): cv.ensure_list,
|
||||||
vol.Optional(Platform.NUMBER.value): cv.ensure_list,
|
vol.Optional(Platform.NUMBER.value): cv.ensure_list,
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
"""Support for MQTT sirens."""
|
"""Support for MQTT sirens."""
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
import copy
|
import copy
|
||||||
import functools
|
import functools
|
||||||
import json
|
import json
|
||||||
|
@ -51,8 +52,10 @@ from .debug_info import log_messages
|
||||||
from .mixins import (
|
from .mixins import (
|
||||||
MQTT_ENTITY_COMMON_SCHEMA,
|
MQTT_ENTITY_COMMON_SCHEMA,
|
||||||
MqttEntity,
|
MqttEntity,
|
||||||
|
async_get_platform_config_from_yaml,
|
||||||
async_setup_entry_helper,
|
async_setup_entry_helper,
|
||||||
async_setup_platform_helper,
|
async_setup_platform_helper,
|
||||||
|
warn_for_legacy_schema,
|
||||||
)
|
)
|
||||||
|
|
||||||
DEFAULT_NAME = "MQTT Siren"
|
DEFAULT_NAME = "MQTT Siren"
|
||||||
|
@ -71,7 +74,7 @@ CONF_SUPPORT_VOLUME_SET = "support_volume_set"
|
||||||
|
|
||||||
STATE = "state"
|
STATE = "state"
|
||||||
|
|
||||||
PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend(
|
PLATFORM_SCHEMA_MODERN = mqtt.MQTT_RW_SCHEMA.extend(
|
||||||
{
|
{
|
||||||
vol.Optional(CONF_AVAILABLE_TONES): cv.ensure_list,
|
vol.Optional(CONF_AVAILABLE_TONES): cv.ensure_list,
|
||||||
vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
|
vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
|
||||||
|
@ -88,7 +91,13 @@ PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend(
|
||||||
},
|
},
|
||||||
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)
|
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)
|
||||||
|
|
||||||
DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA.extend({}, extra=vol.REMOVE_EXTRA))
|
# Configuring MQTT Sirens under the siren platform key is deprecated in HA Core 2022.6
|
||||||
|
PLATFORM_SCHEMA = vol.All(
|
||||||
|
cv.PLATFORM_SCHEMA.extend(PLATFORM_SCHEMA_MODERN.schema),
|
||||||
|
warn_for_legacy_schema(siren.DOMAIN),
|
||||||
|
)
|
||||||
|
|
||||||
|
DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))
|
||||||
|
|
||||||
MQTT_SIREN_ATTRIBUTES_BLOCKED = frozenset(
|
MQTT_SIREN_ATTRIBUTES_BLOCKED = frozenset(
|
||||||
{
|
{
|
||||||
|
@ -116,7 +125,8 @@ async def async_setup_platform(
|
||||||
async_add_entities: AddEntitiesCallback,
|
async_add_entities: AddEntitiesCallback,
|
||||||
discovery_info: DiscoveryInfoType | None = None,
|
discovery_info: DiscoveryInfoType | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Set up MQTT siren through configuration.yaml."""
|
"""Set up MQTT sirens configured under the fan platform key (deprecated)."""
|
||||||
|
# Deprecated in HA Core 2022.6
|
||||||
await async_setup_platform_helper(
|
await async_setup_platform_helper(
|
||||||
hass, siren.DOMAIN, config, async_add_entities, _async_setup_entity
|
hass, siren.DOMAIN, config, async_add_entities, _async_setup_entity
|
||||||
)
|
)
|
||||||
|
@ -127,7 +137,17 @@ async def async_setup_entry(
|
||||||
config_entry: ConfigEntry,
|
config_entry: ConfigEntry,
|
||||||
async_add_entities: AddEntitiesCallback,
|
async_add_entities: AddEntitiesCallback,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Set up MQTT siren dynamically through MQTT discovery."""
|
"""Set up MQTT siren through configuration.yaml and dynamically through MQTT discovery."""
|
||||||
|
# load and initialize platform config from configuration.yaml
|
||||||
|
await asyncio.gather(
|
||||||
|
*(
|
||||||
|
_async_setup_entity(hass, async_add_entities, config, config_entry)
|
||||||
|
for config in await async_get_platform_config_from_yaml(
|
||||||
|
hass, siren.DOMAIN, PLATFORM_SCHEMA_MODERN
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
# setup for discovery
|
||||||
setup = functools.partial(
|
setup = functools.partial(
|
||||||
_async_setup_entity, hass, async_add_entities, config_entry=config_entry
|
_async_setup_entity, hass, async_add_entities, config_entry=config_entry
|
||||||
)
|
)
|
||||||
|
|
|
@ -42,6 +42,7 @@ from .test_common import (
|
||||||
help_test_setting_attribute_via_mqtt_json_message,
|
help_test_setting_attribute_via_mqtt_json_message,
|
||||||
help_test_setting_attribute_with_template,
|
help_test_setting_attribute_with_template,
|
||||||
help_test_setting_blocked_attribute_via_mqtt_json_message,
|
help_test_setting_blocked_attribute_via_mqtt_json_message,
|
||||||
|
help_test_setup_manual_entity_from_yaml,
|
||||||
help_test_unique_id,
|
help_test_unique_id,
|
||||||
help_test_update_with_json_attrs_bad_JSON,
|
help_test_update_with_json_attrs_bad_JSON,
|
||||||
help_test_update_with_json_attrs_not_dict,
|
help_test_update_with_json_attrs_not_dict,
|
||||||
|
@ -895,3 +896,15 @@ async def test_encoding_subscribable_topics(
|
||||||
attribute,
|
attribute,
|
||||||
attribute_value,
|
attribute_value,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_setup_manual_entity_from_yaml(hass, caplog, tmp_path):
|
||||||
|
"""Test setup manual configured MQTT entity."""
|
||||||
|
platform = siren.DOMAIN
|
||||||
|
config = copy.deepcopy(DEFAULT_CONFIG[platform])
|
||||||
|
config["name"] = "test"
|
||||||
|
del config["platform"]
|
||||||
|
await help_test_setup_manual_entity_from_yaml(
|
||||||
|
hass, caplog, tmp_path, platform, config
|
||||||
|
)
|
||||||
|
assert hass.states.get(f"{platform}.test") is not None
|
||||||
|
|
Loading…
Add table
Reference in a new issue