Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deprecate old config options for MQTT json light (#111676) 

* add deprecaction

* Deprecate old config options for mqtt json light

* Do not deprecate brightness flag

* Enable brightness support by default

* Keep `false` as default for brightness flag

* Add warnings and register issue

* log warning and register on use of color_mode flag

* Remove redundant cv.deprecated logging + follow up comments
pull/112311/head
Jan Bouwhuis 2024-03-05 08:49:05 +01:00 committed by GitHub
parent 4f9d8d3048
commit 0c2cf881ac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 287 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
homeassistant/components/mqtt/light/schema_json.py
View File

@ -1,6 +1,7 @@
"""Support for MQTT JSON lights."""
from __future__ import annotations
from collections.abc import Callable
from contextlib import suppress
import logging
from typing import TYPE_CHECKING, Any, cast
@ -20,6 +21,7 @@ from homeassistant.components.light import (
ATTR_TRANSITION,
ATTR_WHITE,
ATTR_XY_COLOR,
DOMAIN as LIGHT_DOMAIN,
ENTITY_ID_FORMAT,
FLASH_LONG,
FLASH_SHORT,
@ -43,13 +45,15 @@ from homeassistant.const import (
CONF_XY,
STATE_ON,
)
from homeassistant.core import callback
from homeassistant.core import async_get_hass, callback
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
from homeassistant.helpers.json import json_dumps
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.typing import ConfigType
import homeassistant.util.color as color_util
from homeassistant.util.json import json_loads_object
from homeassistant.util.yaml import dump as yaml_dump
from .. import subscription
from ..config import DEFAULT_QOS, DEFAULT_RETAIN, MQTT_RW_SCHEMA
@ -59,6 +63,7 @@ from ..const import (
CONF_QOS,
CONF_RETAIN,
CONF_STATE_TOPIC,
DOMAIN as MQTT_DOMAIN,
)
from ..debug_info import log_messages
from ..mixins import MQTT_ENTITY_COMMON_SCHEMA, MqttEntity, write_state_on_attr_change
@ -100,12 +105,87 @@ CONF_MAX_MIREDS = "max_mireds"
CONF_MIN_MIREDS = "min_mireds"
def valid_color_configuration(config: ConfigType) -> ConfigType:
def valid_color_configuration(
setup_from_yaml: bool,
) -> Callable[[dict[str, Any]], dict[str, Any]]:
"""Test color_mode is not combined with deprecated config."""
deprecated = {CONF_COLOR_TEMP, CONF_HS, CONF_RGB, CONF_XY}
if config[CONF_COLOR_MODE] and any(config.get(key) for key in deprecated):
raise vol.Invalid(f"color_mode must not be combined with any of {deprecated}")
return config
def _valid_color_configuration(config: ConfigType) -> ConfigType:
deprecated = {CONF_COLOR_TEMP, CONF_HS, CONF_RGB, CONF_XY}
deprecated_flags_used = any(config.get(key) for key in deprecated)
if config.get(CONF_SUPPORTED_COLOR_MODES):
if deprecated_flags_used:
raise vol.Invalid(
"supported_color_modes must not "
f"be combined with any of {deprecated}"
)
elif deprecated_flags_used:
deprecated_flags = ", ".join(key for key in deprecated if key in config)
_LOGGER.warning(
"Deprecated flags [%s] used in MQTT JSON light config "
"for handling color mode, please use `supported_color_modes` instead. "
"Got: %s. This will stop working in Home Assistant Core 2025.3",
deprecated_flags,
config,
)
if not setup_from_yaml:
return config
issue_id = hex(hash(frozenset(config)))
yaml_config_str = yaml_dump(config)
learn_more_url = (
"https://www.home-assistant.io/integrations/"
f"{LIGHT_DOMAIN}.mqtt/#json-schema"
)
hass = async_get_hass()
async_create_issue(
hass,
MQTT_DOMAIN,
issue_id,
issue_domain=LIGHT_DOMAIN,
is_fixable=False,
severity=IssueSeverity.WARNING,
learn_more_url=learn_more_url,
translation_placeholders={
"deprecated_flags": deprecated_flags,
"config": yaml_config_str,
},
translation_key="deprecated_color_handling",
)
if CONF_COLOR_MODE in config:
_LOGGER.warning(
"Deprecated flag `color_mode` used in MQTT JSON light config "
", the `color_mode` flag is not used anymore and should be removed. "
"Got: %s. This will stop working in Home Assistant Core 2025.3",
config,
)
if not setup_from_yaml:
return config
issue_id = hex(hash(frozenset(config)))
yaml_config_str = yaml_dump(config)
learn_more_url = (
"https://www.home-assistant.io/integrations/"
f"{LIGHT_DOMAIN}.mqtt/#json-schema"
)
hass = async_get_hass()
async_create_issue(
hass,
MQTT_DOMAIN,
issue_id,
breaks_in_ha_version="2025.3.0",
issue_domain=LIGHT_DOMAIN,
is_fixable=False,
severity=IssueSeverity.WARNING,
learn_more_url=learn_more_url,
translation_placeholders={
"config": yaml_config_str,
},
translation_key="deprecated_color_mode_flag",
)
return config
return _valid_color_configuration
_PLATFORM_SCHEMA_BASE = (
@ -115,9 +195,11 @@ _PLATFORM_SCHEMA_BASE = (
vol.Optional(
CONF_BRIGHTNESS_SCALE, default=DEFAULT_BRIGHTNESS_SCALE
): vol.All(vol.Coerce(int), vol.Range(min=1)),
vol.Inclusive(
CONF_COLOR_MODE, "color_mode", default=DEFAULT_COLOR_MODE
): cv.boolean,
# CONF_COLOR_MODE was deprecated with HA Core 2024.4 and will be
# removed with HA Core 2025.3
vol.Optional(CONF_COLOR_MODE): cv.boolean,
# CONF_COLOR_TEMP was deprecated with HA Core 2024.4 and will be
# removed with HA Core 2025.3
vol.Optional(CONF_COLOR_TEMP, default=DEFAULT_COLOR_TEMP): cv.boolean,
vol.Optional(CONF_EFFECT, default=DEFAULT_EFFECT): cv.boolean,
vol.Optional(CONF_EFFECT_LIST): vol.All(cv.ensure_list, [cv.string]),
@ -127,6 +209,8 @@ _PLATFORM_SCHEMA_BASE = (
vol.Optional(
CONF_FLASH_TIME_SHORT, default=DEFAULT_FLASH_TIME_SHORT
): cv.positive_int,
# CONF_HS was deprecated with HA Core 2024.4 and will be
# removed with HA Core 2025.3
vol.Optional(CONF_HS, default=DEFAULT_HS): cv.boolean,
vol.Optional(CONF_MAX_MIREDS): cv.positive_int,
vol.Optional(CONF_MIN_MIREDS): cv.positive_int,
@ -135,9 +219,11 @@ _PLATFORM_SCHEMA_BASE = (
vol.Coerce(int), vol.In([0, 1, 2])
),
vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
# CONF_RGB was deprecated with HA Core 2024.4 and will be
# removed with HA Core 2025.3
vol.Optional(CONF_RGB, default=DEFAULT_RGB): cv.boolean,
vol.Optional(CONF_STATE_TOPIC): valid_subscribe_topic,
vol.Inclusive(CONF_SUPPORTED_COLOR_MODES, "color_mode"): vol.All(
vol.Optional(CONF_SUPPORTED_COLOR_MODES): vol.All(
cv.ensure_list,
[vol.In(VALID_COLOR_MODES)],
vol.Unique(),
@ -146,6 +232,8 @@ _PLATFORM_SCHEMA_BASE = (
vol.Optional(CONF_WHITE_SCALE, default=DEFAULT_WHITE_SCALE): vol.All(
vol.Coerce(int), vol.Range(min=1)
),
# CONF_XY was deprecated with HA Core 2024.4 and will be
# removed with HA Core 2025.3
vol.Optional(CONF_XY, default=DEFAULT_XY): cv.boolean,
},
)
@ -154,13 +242,13 @@ _PLATFORM_SCHEMA_BASE = (
)
DISCOVERY_SCHEMA_JSON = vol.All(
valid_color_configuration(False),
_PLATFORM_SCHEMA_BASE.extend({}, extra=vol.REMOVE_EXTRA),
valid_color_configuration,
)
PLATFORM_SCHEMA_MODERN_JSON = vol.All(
valid_color_configuration(True),
_PLATFORM_SCHEMA_BASE,
valid_color_configuration,
)
@ -176,6 +264,8 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
_topic: dict[str, str | None]
_optimistic: bool
_deprecated_color_handling: bool = False
@staticmethod
def config_schema() -> vol.Schema:
"""Return the config schema."""
@ -205,7 +295,14 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
self._attr_supported_features |= (
config[CONF_EFFECT] and LightEntityFeature.EFFECT
)
if not self._config[CONF_COLOR_MODE]:
if supported_color_modes := self._config.get(CONF_SUPPORTED_COLOR_MODES):
self._attr_supported_color_modes = supported_color_modes
if self.supported_color_modes and len(self.supported_color_modes) == 1:
self._attr_color_mode = next(iter(self.supported_color_modes))
else:
self._attr_color_mode = ColorMode.UNKNOWN
else:
self._deprecated_color_handling = True
color_modes = {ColorMode.ONOFF}
if config[CONF_BRIGHTNESS]:
color_modes.add(ColorMode.BRIGHTNESS)
@ -216,15 +313,9 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
self._attr_supported_color_modes = filter_supported_color_modes(color_modes)
if self.supported_color_modes and len(self.supported_color_modes) == 1:
self._fixed_color_mode = next(iter(self.supported_color_modes))
else:
self._attr_supported_color_modes = self._config[CONF_SUPPORTED_COLOR_MODES]
if self.supported_color_modes and len(self.supported_color_modes) == 1:
self._attr_color_mode = next(iter(self.supported_color_modes))
else:
self._attr_color_mode = ColorMode.UNKNOWN
def _update_color(self, values: dict[str, Any]) -> None:
if not self._config[CONF_COLOR_MODE]:
if self._deprecated_color_handling:
# Deprecated color handling
try:
red = int(values["color"]["r"])
@ -353,7 +444,7 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
self._attr_is_on = None
if (
not self._config[CONF_COLOR_MODE]
self._deprecated_color_handling
and color_supported(self.supported_color_modes)
and "color" in values
):
@ -363,7 +454,7 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
else:
self._update_color(values)
if self._config[CONF_COLOR_MODE] and "color_mode" in values:
if not self._deprecated_color_handling and "color_mode" in values:
self._update_color(values)
if brightness_supported(self.supported_color_modes):
@ -390,9 +481,9 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
)
if (
self.supported_color_modes
self._deprecated_color_handling
and self.supported_color_modes
and ColorMode.COLOR_TEMP in self.supported_color_modes
and not self._config[CONF_COLOR_MODE]
):
# Deprecated color handling
try:
@ -461,7 +552,7 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
@property
def color_mode(self) -> ColorMode | str | None:
"""Return current color mode."""
if self._config[CONF_COLOR_MODE]:
if not self._deprecated_color_handling:
return self._attr_color_mode
if self._fixed_color_mode:
# Legacy light with support for a single color mode
@ -484,19 +575,20 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
message["flash"] = self._flash_times[CONF_FLASH_TIME_SHORT]
def _scale_rgbxx(self, rgbxx: tuple[int, ...], kwargs: Any) -> tuple[int, ...]:
# If there's a brightness topic set, we don't want to scale the
# RGBxx values given using the brightness.
# If brightness is supported, we don't want to scale the
# RGBxx values given using the brightness and
# we pop the brightness, to omit it from the payload
brightness: int
if self._config[CONF_BRIGHTNESS]:
brightness = 255
else:
brightness = kwargs.get(ATTR_BRIGHTNESS, 255)
brightness = kwargs.pop(ATTR_BRIGHTNESS, 255)
return tuple(round(i / 255 * brightness) for i in rgbxx)
def _supports_color_mode(self, color_mode: ColorMode | str) -> bool:
"""Return True if the light natively supports a color mode."""
return (
self._config[CONF_COLOR_MODE]
not self._deprecated_color_handling
and self.supported_color_modes is not None
and color_mode in self.supported_color_modes
)
@ -522,12 +614,13 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
hs_color = kwargs[ATTR_HS_COLOR]
message["color"] = {}
if self._config[CONF_RGB]:
# If there's a brightness topic set, we don't want to scale the
# If brightness is supported, we don't want to scale the
# RGB values given using the brightness.
if self._config[CONF_BRIGHTNESS]:
brightness = 255
else:
brightness = kwargs.get(ATTR_BRIGHTNESS, 255)
# We pop the brightness, to omit it from the payload
brightness = kwargs.pop(ATTR_BRIGHTNESS, 255)
rgb = color_util.color_hsv_to_RGB(
hs_color[0], hs_color[1], brightness / 255 * 100
)
@ -595,7 +688,9 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
self._set_flash_and_transition(message, **kwargs)
if ATTR_BRIGHTNESS in kwargs and self._config[CONF_BRIGHTNESS]:
if ATTR_BRIGHTNESS in kwargs and brightness_supported(
self.supported_color_modes
):
device_brightness = color_util.brightness_to_value(
(1, self._config[CONF_BRIGHTNESS_SCALE]),
kwargs[ATTR_BRIGHTNESS],

8
homeassistant/components/mqtt/strings.json
View File

@ -4,6 +4,14 @@
"title": "MQTT vacuum entities with deprecated `schema` config settings found in your configuration.yaml",
"description": "The `schema` setting for MQTT vacuum entities is deprecated and should be removed. Please adjust your configuration.yaml and restart Home Assistant to fix this issue."
},
"deprecated_color_handling": {
"title": "Deprecated color handling used for MQTT light",
"description": "An MQTT light config (with `json` schema) found in `configuration.yaml` uses deprecated color handling flags.\n\nConfiguration found:\n```yaml\n{config}\n```\nDeprecated flags: **{deprecated_flags}**.\n\nUse the `supported_color_modes` option instead and [reload](/developer-tools/yaml) the manually configured MQTT items or restart Home Assistant to fix this issue."
},
"deprecated_color_mode_flag": {
"title": "Deprecated color_mode option flag used for MQTT light",
"description": "An MQTT light config (with `json` schema) found in `configuration.yaml` uses a deprecated `color_mode` flag.\n\nConfiguration found:\n```yaml\n{config}\n```\n\nRemove the option from your config and [reload](/developer-tools/yaml) the manually configured MQTT items or restart Home Assistant to fix this issue."
},
"invalid_platform_config": {
"title": "Invalid config found for mqtt {domain} item",
"description": "Home Assistant detected an invalid config for a manually configured item.\n\nPlatform domain: **{domain}**\nConfiguration file: **{config_file}**\nNear line: **{line}**\nConfiguration found:\n```yaml\n{config}\n```\nError: **{error}**.\n\nMake sure the configuration is valid and [reload](/developer-tools/yaml) the manually configured MQTT items or restart Home Assistant to fix this issue."

154
tests/components/mqtt/test_light_json.py
View File

@ -98,6 +98,7 @@ from homeassistant.const import (
Platform,
)
from homeassistant.core import HomeAssistant, State
from homeassistant.helpers.json import json_dumps
from homeassistant.util.json import JsonValueType, json_loads
from .test_common import (
@ -149,7 +150,6 @@ COLOR_MODES_CONFIG = {
mqtt.DOMAIN: {
light.DOMAIN: {
"brightness": True,
"color_mode": True,
"effect": True,
"command_topic": "test_light_rgb/set",
"name": "test",
@ -217,7 +217,157 @@ async def test_fail_setup_if_color_mode_deprecated(
) -> None:
"""Test if setup fails if color mode is combined with deprecated config keys."""
assert await mqtt_mock_entry()
assert "color_mode must not be combined with any of" in caplog.text
assert "supported_color_modes must not be combined with any of" in caplog.text
@pytest.mark.parametrize(
("hass_config", "color_modes"),
[
(
help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"color_temp": True},)),
("color_temp",),
),
(help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"hs": True},)), ("hs",)),
(help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"rgb": True},)), ("rgb",)),
(help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"xy": True},)), ("xy",)),
(
help_custom_config(
light.DOMAIN, DEFAULT_CONFIG, ({"color_temp": True, "rgb": True},)
),
("color_temp, rgb", "rgb, color_temp"),
),
],
ids=["color_temp", "hs", "rgb", "xy", "color_temp, rgb"],
)
async def test_warning_if_color_mode_flags_are_used(
hass: HomeAssistant,
mqtt_mock_entry: MqttMockHAClientGenerator,
caplog: pytest.LogCaptureFixture,
color_modes: tuple[str,],
) -> None:
"""Test warnings deprecated config keys without supported color modes defined."""
with patch(
"homeassistant.components.mqtt.light.schema_json.async_create_issue"
) as mock_async_create_issue:
assert await mqtt_mock_entry()
assert any(
(
f"Deprecated flags [{color_modes_case}] used in MQTT JSON light config "
"for handling color mode, please use `supported_color_modes` instead."
in caplog.text
)
for color_modes_case in color_modes
)
mock_async_create_issue.assert_called_once()
@pytest.mark.parametrize(
("config", "color_modes"),
[
(
help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"color_temp": True},)),
("color_temp",),
),
(help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"hs": True},)), ("hs",)),
(help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"rgb": True},)), ("rgb",)),
(help_custom_config(light.DOMAIN, DEFAULT_CONFIG, ({"xy": True},)), ("xy",)),
(
help_custom_config(
light.DOMAIN, DEFAULT_CONFIG, ({"color_temp": True, "rgb": True},)
),
("color_temp, rgb", "rgb, color_temp"),
),
],
ids=["color_temp", "hs", "rgb", "xy", "color_temp, rgb"],
)
async def test_warning_on_discovery_if_color_mode_flags_are_used(
hass: HomeAssistant,
mqtt_mock_entry: MqttMockHAClientGenerator,
caplog: pytest.LogCaptureFixture,
config: dict[str, Any],
color_modes: tuple[str,],
) -> None:
"""Test warnings deprecated config keys with discovery."""
with patch(
"homeassistant.components.mqtt.light.schema_json.async_create_issue"
) as mock_async_create_issue:
assert await mqtt_mock_entry()
config_payload = json_dumps(config[mqtt.DOMAIN][light.DOMAIN][0])
async_fire_mqtt_message(
hass,
"homeassistant/light/bla/config",
config_payload,
)
await hass.async_block_till_done()
assert any(
(
f"Deprecated flags [{color_modes_case}] used in MQTT JSON light config "
"for handling color mode, please "
"use `supported_color_modes` instead" in caplog.text
)
for color_modes_case in color_modes
)
mock_async_create_issue.assert_not_called()
@pytest.mark.parametrize(
"hass_config",
[
help_custom_config(
light.DOMAIN,
DEFAULT_CONFIG,
({"color_mode": True, "supported_color_modes": ["color_temp"]},),
),
],
ids=["color_temp"],
)
async def test_warning_if_color_mode_option_flag_is_used(
hass: HomeAssistant,
mqtt_mock_entry: MqttMockHAClientGenerator,
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test warning deprecated color_mode option flag is used."""
with patch(
"homeassistant.components.mqtt.light.schema_json.async_create_issue"
) as mock_async_create_issue:
assert await mqtt_mock_entry()
assert "Deprecated flag `color_mode` used in MQTT JSON light config" in caplog.text
mock_async_create_issue.assert_called_once()
@pytest.mark.parametrize(
"config",
[
help_custom_config(
light.DOMAIN,
DEFAULT_CONFIG,
({"color_mode": True, "supported_color_modes": ["color_temp"]},),
),
],
ids=["color_temp"],
)
async def test_warning_on_discovery_if_color_mode_option_flag_is_used(
hass: HomeAssistant,
mqtt_mock_entry: MqttMockHAClientGenerator,
caplog: pytest.LogCaptureFixture,
config: dict[str, Any],
) -> None:
"""Test warning deprecated color_mode option flag is used."""
with patch(
"homeassistant.components.mqtt.light.schema_json.async_create_issue"
) as mock_async_create_issue:
assert await mqtt_mock_entry()
config_payload = json_dumps(config[mqtt.DOMAIN][light.DOMAIN][0])
async_fire_mqtt_message(
hass,
"homeassistant/light/bla/config",
config_payload,
)
await hass.async_block_till_done()
assert "Deprecated flag `color_mode` used in MQTT JSON light config" in caplog.text
mock_async_create_issue.assert_not_called()
@pytest.mark.parametrize(