Skip to content

Deduplicate code in MQTT basic light pt2: Add restore_state helper #50766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emontnemery merged 2 commits into from
May 17, 2021
Merged

Deduplicate code in MQTT basic light pt2: Add restore_state helper #50766

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e0d8e5
Refactor MQTT basic light pt2: Add restore_state helper
emontnemery May 17, 2021
bc3a473
Update homeassistant/components/mqtt/light/schema_basic.py
emontnemery May 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 22 additions & 52 deletions homeassistant/components/mqtt/light/schema_basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,11 @@ class MqttLight(MqttEntity, LightEntity, RestoreEntity):

def __init__(self, hass, config, config_entry, discovery_data):
"""Initialize MQTT light."""
self._state = False
self._brightness = None
self._hs = None
self._color_temp = None
self._effect = None
self._hs_color = None
self._state = False
self._white_value = None

self._topic = None
Expand Down Expand Up @@ -265,6 +265,11 @@ def add_topic(topic, msg_callback):
"qos": self._config[CONF_QOS],
}

def restore_state(attribute, condition):
"""Restore a state attribute."""
if condition and last_state and last_state.attributes.get(attribute):
setattr(self, f"_{attribute}", last_state.attributes[attribute])

@callback
@log_messages(self.hass, self.entity_id)
def state_received(msg):
Expand Down Expand Up @@ -308,12 +313,7 @@ def brightness_received(msg):
self.async_write_ha_state()

add_topic(CONF_BRIGHTNESS_STATE_TOPIC, brightness_received)
if (
self._optimistic_brightness
and last_state
and last_state.attributes.get(ATTR_BRIGHTNESS)
):
self._brightness = last_state.attributes.get(ATTR_BRIGHTNESS)
restore_state(ATTR_BRIGHTNESS, self._optimistic_brightness)

@callback
@log_messages(self.hass, self.entity_id)
Expand All @@ -325,19 +325,14 @@ def rgb_received(msg):
return

rgb = [int(val) for val in payload.split(",")]
self._hs = color_util.color_RGB_to_hs(*rgb)
self._hs_color = color_util.color_RGB_to_hs(*rgb)
if self._topic[CONF_BRIGHTNESS_STATE_TOPIC] is None:
percent_bright = float(color_util.color_RGB_to_hsv(*rgb)[2]) / 100.0
self._brightness = percent_bright * 255
self.async_write_ha_state()

add_topic(CONF_RGB_STATE_TOPIC, rgb_received)
if (
self._optimistic_rgb
and last_state
and last_state.attributes.get(ATTR_HS_COLOR)
):
self._hs = last_state.attributes.get(ATTR_HS_COLOR)
restore_state(ATTR_HS_COLOR, self._optimistic_rgb)

@callback
@log_messages(self.hass, self.entity_id)
Expand All @@ -354,12 +349,7 @@ def color_temp_received(msg):
self.async_write_ha_state()

add_topic(CONF_COLOR_TEMP_STATE_TOPIC, color_temp_received)
if (
self._optimistic_color_temp
and last_state
and last_state.attributes.get(ATTR_COLOR_TEMP)
):
self._color_temp = last_state.attributes.get(ATTR_COLOR_TEMP)
restore_state(ATTR_COLOR_TEMP, self._optimistic_color_temp)

@callback
@log_messages(self.hass, self.entity_id)
Expand All @@ -376,12 +366,7 @@ def effect_received(msg):
self.async_write_ha_state()

add_topic(CONF_EFFECT_STATE_TOPIC, effect_received)
if (
self._optimistic_effect
and last_state
and last_state.attributes.get(ATTR_EFFECT)
):
self._effect = last_state.attributes.get(ATTR_EFFECT)
restore_state(ATTR_EFFECT, self._optimistic_effect)

@callback
@log_messages(self.hass, self.entity_id)
Expand All @@ -394,18 +379,13 @@ def hs_received(msg):

try:
hs_color = [float(val) for val in payload.split(",", 2)]
self._hs = hs_color
self._hs_color = hs_color
self.async_write_ha_state()
except ValueError:
_LOGGER.debug("Failed to parse hs state update: '%s'", payload)

add_topic(CONF_HS_STATE_TOPIC, hs_received)
if (
self._optimistic_hs
and last_state
and last_state.attributes.get(ATTR_HS_COLOR)
):
self._hs = last_state.attributes.get(ATTR_HS_COLOR)
restore_state(ATTR_HS_COLOR, self._optimistic_hs)

@callback
@log_messages(self.hass, self.entity_id)
Expand All @@ -424,12 +404,7 @@ def white_value_received(msg):
self.async_write_ha_state()

add_topic(CONF_WHITE_VALUE_STATE_TOPIC, white_value_received)
if (
self._optimistic_white_value
and last_state
and last_state.attributes.get(ATTR_WHITE_VALUE)
):
self._white_value = last_state.attributes.get(ATTR_WHITE_VALUE)
restore_state(ATTR_WHITE_VALUE, self._optimistic_white_value)

@callback
@log_messages(self.hass, self.entity_id)
Expand All @@ -441,16 +416,11 @@ def xy_received(msg):
return

xy_color = [float(val) for val in payload.split(",")]
self._hs = color_util.color_xy_to_hs(*xy_color)
self._hs_color = color_util.color_xy_to_hs(*xy_color)
self.async_write_ha_state()

add_topic(CONF_XY_STATE_TOPIC, xy_received)
if (
self._optimistic_xy
and last_state
and last_state.attributes.get(ATTR_HS_COLOR)
):
self._hs = last_state.attributes.get(ATTR_HS_COLOR)
restore_state(ATTR_HS_COLOR, self._optimistic_xy)

self._sub_state = await subscription.async_subscribe_topics(
self.hass, self._sub_state, topics
Expand All @@ -469,7 +439,7 @@ def hs_color(self):
"""Return the hs color value."""
if self._white_value:
return None
return self._hs
return self._hs_color

@property
def color_temp(self):
Expand Down Expand Up @@ -607,7 +577,7 @@ async def async_turn_on(self, **kwargs): # noqa: C901
)

if self._optimistic_rgb:
self._hs = kwargs[ATTR_HS_COLOR]
self._hs_color = kwargs[ATTR_HS_COLOR]
should_update = True

if ATTR_HS_COLOR in kwargs and self._topic[CONF_HS_COMMAND_TOPIC] is not None:
Expand All @@ -622,7 +592,7 @@ async def async_turn_on(self, **kwargs): # noqa: C901
)

if self._optimistic_hs:
self._hs = kwargs[ATTR_HS_COLOR]
self._hs_color = kwargs[ATTR_HS_COLOR]
should_update = True

if ATTR_HS_COLOR in kwargs and self._topic[CONF_XY_COMMAND_TOPIC] is not None:
Expand All @@ -637,7 +607,7 @@ async def async_turn_on(self, **kwargs): # noqa: C901
)

if self._optimistic_xy:
self._hs = kwargs[ATTR_HS_COLOR]
self._hs_color = kwargs[ATTR_HS_COLOR]
should_update = True

if (
Expand Down Expand Up @@ -667,7 +637,7 @@ async def async_turn_on(self, **kwargs): # noqa: C901
and ATTR_HS_COLOR not in kwargs
and self._topic[CONF_RGB_COMMAND_TOPIC] is not None
):
hs_color = self._hs if self._hs is not None else (0, 0)
hs_color = self._hs_color if self._hs_color is not None else (0, 0)
rgb = color_util.color_hsv_to_RGB(
hs_color[0], hs_color[1], kwargs[ATTR_BRIGHTNESS] / 255 * 100
)
Expand Down