Use homekit service callbacks for lights to resolve out of sync states (#32348)
* Switch homekit lights to use service callbacks Service callbacks allow us to get the on/off, brightness, etc all in one call so we remove all the complexity that was previously needed to handle the out of sync states We now get the on event and brightness event at the same time which allows us to prevent lights from flashing up to 100% before the requested brightness. * Fix STATE_OFF -> STATE_ON,brightness:0
This commit is contained in:
1 parent
e27d5cd9fb
commit
e4e0c37a8c
2 files changed
+343
-128
No files matched your search
@@ -25,7 +25,7 @@ from homeassistant.const import (
|
||||
)
|
||||
|
||||
from . import TYPES
|
||||
from .accessories import HomeAccessory, debounce
|
||||
from .accessories import HomeAccessory
|
||||
from .const import (
|
||||
CHAR_BRIGHTNESS,
|
||||
CHAR_COLOR_TEMPERATURE,
|
||||
@@ -52,15 +52,6 @@ class Light(HomeAccessory):
|
||||
def __init__(self, *args):
|
||||
"""Initialize a new Light accessory object."""
|
||||
super().__init__(*args, category=CATEGORY_LIGHTBULB)
|
||||
self._flag = {
|
||||
CHAR_ON: False,
|
||||
CHAR_BRIGHTNESS: False,
|
||||
CHAR_HUE: False,
|
||||
CHAR_SATURATION: False,
|
||||
CHAR_COLOR_TEMPERATURE: False,
|
||||
RGB_COLOR: False,
|
||||
}
|
||||
self._state = 0
|
||||
|
||||
self.chars = []
|
||||
self._features = self.hass.states.get(self.entity_id).attributes.get(
|
||||
@@ -82,17 +73,14 @@ class Light(HomeAccessory):
|
||||
self.chars.append(CHAR_COLOR_TEMPERATURE)
|
||||
|
||||
serv_light = self.add_preload_service(SERV_LIGHTBULB, self.chars)
|
||||
self.char_on = serv_light.configure_char(
|
||||
CHAR_ON, value=self._state, setter_callback=self.set_state
|
||||
)
|
||||
|
||||
self.char_on = serv_light.configure_char(CHAR_ON, value=0)
|
||||
|
||||
if CHAR_BRIGHTNESS in self.chars:
|
||||
# Initial value is set to 100 because 0 is a special value (off). 100 is
|
||||
# an arbitrary non-zero value. It is updated immediately by update_state
|
||||
# to set to the correct initial value.
|
||||
self.char_brightness = serv_light.configure_char(
|
||||
CHAR_BRIGHTNESS, value=100, setter_callback=self.set_brightness
|
||||
)
|
||||
self.char_brightness = serv_light.configure_char(CHAR_BRIGHTNESS, value=100)
|
||||
|
||||
if CHAR_COLOR_TEMPERATURE in self.chars:
|
||||
min_mireds = self.hass.states.get(self.entity_id).attributes.get(
|
||||
@@ -105,133 +93,98 @@ class Light(HomeAccessory):
|
||||
CHAR_COLOR_TEMPERATURE,
|
||||
value=min_mireds,
|
||||
properties={PROP_MIN_VALUE: min_mireds, PROP_MAX_VALUE: max_mireds},
|
||||
setter_callback=self.set_color_temperature,
|
||||
)
|
||||
|
||||
if CHAR_HUE in self.chars:
|
||||
self.char_hue = serv_light.configure_char(
|
||||
CHAR_HUE, value=0, setter_callback=self.set_hue
|
||||
)
|
||||
self.char_hue = serv_light.configure_char(CHAR_HUE, value=0)
|
||||
|
||||
if CHAR_SATURATION in self.chars:
|
||||
self.char_saturation = serv_light.configure_char(
|
||||
CHAR_SATURATION, value=75, setter_callback=self.set_saturation
|
||||
)
|
||||
self.char_saturation = serv_light.configure_char(CHAR_SATURATION, value=75)
|
||||
|
||||
def set_state(self, value):
|
||||
"""Set state if call came from HomeKit."""
|
||||
if self._state == value:
|
||||
return
|
||||
serv_light.setter_callback = self._set_chars
|
||||
|
||||
_LOGGER.debug("%s: Set state to %d", self.entity_id, value)
|
||||
self._flag[CHAR_ON] = True
|
||||
def _set_chars(self, char_values):
|
||||
_LOGGER.debug("_set_chars: %s", char_values)
|
||||
events = []
|
||||
service = SERVICE_TURN_ON
|
||||
params = {ATTR_ENTITY_ID: self.entity_id}
|
||||
service = SERVICE_TURN_ON if value == 1 else SERVICE_TURN_OFF
|
||||
self.call_service(DOMAIN, service, params)
|
||||
if CHAR_ON in char_values:
|
||||
if not char_values[CHAR_ON]:
|
||||
service = SERVICE_TURN_OFF
|
||||
events.append(f"Set state to {char_values[CHAR_ON]}")
|
||||
|
||||
@debounce
|
||||
def set_brightness(self, value):
|
||||
"""Set brightness if call came from HomeKit."""
|
||||
_LOGGER.debug("%s: Set brightness to %d", self.entity_id, value)
|
||||
self._flag[CHAR_BRIGHTNESS] = True
|
||||
if value == 0:
|
||||
self.set_state(0) # Turn off light
|
||||
return
|
||||
params = {ATTR_ENTITY_ID: self.entity_id, ATTR_BRIGHTNESS_PCT: value}
|
||||
self.call_service(DOMAIN, SERVICE_TURN_ON, params, f"brightness at {value}%")
|
||||
if CHAR_BRIGHTNESS in char_values:
|
||||
if char_values[CHAR_BRIGHTNESS] == 0:
|
||||
events[-1] = f"Set state to 0"
|
||||
service = SERVICE_TURN_OFF
|
||||
else:
|
||||
params[ATTR_BRIGHTNESS_PCT] = char_values[CHAR_BRIGHTNESS]
|
||||
events.append(f"brightness at {char_values[CHAR_BRIGHTNESS]}%")
|
||||
|
||||
def set_color_temperature(self, value):
|
||||
"""Set color temperature if call came from HomeKit."""
|
||||
_LOGGER.debug("%s: Set color temp to %s", self.entity_id, value)
|
||||
self._flag[CHAR_COLOR_TEMPERATURE] = True
|
||||
params = {ATTR_ENTITY_ID: self.entity_id, ATTR_COLOR_TEMP: value}
|
||||
self.call_service(
|
||||
DOMAIN, SERVICE_TURN_ON, params, f"color temperature at {value}"
|
||||
)
|
||||
if CHAR_COLOR_TEMPERATURE in char_values:
|
||||
params[ATTR_COLOR_TEMP] = char_values[CHAR_COLOR_TEMPERATURE]
|
||||
events.append(f"color temperature at {char_values[CHAR_COLOR_TEMPERATURE]}")
|
||||
|
||||
def set_saturation(self, value):
|
||||
"""Set saturation if call came from HomeKit."""
|
||||
_LOGGER.debug("%s: Set saturation to %d", self.entity_id, value)
|
||||
self._flag[CHAR_SATURATION] = True
|
||||
self._saturation = value
|
||||
self.set_color()
|
||||
|
||||
def set_hue(self, value):
|
||||
"""Set hue if call came from HomeKit."""
|
||||
_LOGGER.debug("%s: Set hue to %d", self.entity_id, value)
|
||||
self._flag[CHAR_HUE] = True
|
||||
self._hue = value
|
||||
self.set_color()
|
||||
|
||||
def set_color(self):
|
||||
"""Set color if call came from HomeKit."""
|
||||
if (
|
||||
self._features & SUPPORT_COLOR
|
||||
and self._flag[CHAR_HUE]
|
||||
and self._flag[CHAR_SATURATION]
|
||||
and CHAR_HUE in char_values
|
||||
and CHAR_SATURATION in char_values
|
||||
):
|
||||
color = (self._hue, self._saturation)
|
||||
color = (char_values[CHAR_HUE], char_values[CHAR_SATURATION])
|
||||
_LOGGER.debug("%s: Set hs_color to %s", self.entity_id, color)
|
||||
self._flag.update(
|
||||
{CHAR_HUE: False, CHAR_SATURATION: False, RGB_COLOR: True}
|
||||
)
|
||||
params = {ATTR_ENTITY_ID: self.entity_id, ATTR_HS_COLOR: color}
|
||||
self.call_service(DOMAIN, SERVICE_TURN_ON, params, f"set color at {color}")
|
||||
params[ATTR_HS_COLOR] = color
|
||||
events.append(f"set color at {color}")
|
||||
|
||||
self.call_service(DOMAIN, service, params, ", ".join(events))
|
||||
|
||||
def update_state(self, new_state):
|
||||
"""Update light after state change."""
|
||||
# Handle State
|
||||
state = new_state.state
|
||||
if state in (STATE_ON, STATE_OFF):
|
||||
self._state = 1 if state == STATE_ON else 0
|
||||
if not self._flag[CHAR_ON] and self.char_on.value != self._state:
|
||||
self.char_on.set_value(self._state)
|
||||
self._flag[CHAR_ON] = False
|
||||
if state == STATE_ON and self.char_on.value != 1:
|
||||
self.char_on.set_value(1)
|
||||
elif state == STATE_OFF and self.char_on.value != 0:
|
||||
self.char_on.set_value(0)
|
||||
|
||||
# Handle Brightness
|
||||
if CHAR_BRIGHTNESS in self.chars:
|
||||
brightness = new_state.attributes.get(ATTR_BRIGHTNESS)
|
||||
if not self._flag[CHAR_BRIGHTNESS] and isinstance(brightness, int):
|
||||
if isinstance(brightness, int):
|
||||
brightness = round(brightness / 255 * 100, 0)
|
||||
# The homeassistant component might report its brightness as 0 but is
|
||||
# not off. But 0 is a special value in homekit. When you turn on a
|
||||
# homekit accessory it will try to restore the last brightness state
|
||||
# which will be the last value saved by char_brightness.set_value.
|
||||
# But if it is set to 0, HomeKit will update the brightness to 100 as
|
||||
# it thinks 0 is off.
|
||||
#
|
||||
# Therefore, if the the brightness is 0 and the device is still on,
|
||||
# the brightness is mapped to 1 otherwise the update is ignored in
|
||||
# order to avoid this incorrect behavior.
|
||||
if brightness == 0 and state == STATE_ON:
|
||||
brightness = 1
|
||||
if self.char_brightness.value != brightness:
|
||||
# The homeassistant component might report its brightness as 0 but is
|
||||
# not off. But 0 is a special value in homekit. When you turn on a
|
||||
# homekit accessory it will try to restore the last brightness state
|
||||
# which will be the last value saved by char_brightness.set_value.
|
||||
# But if it is set to 0, HomeKit will update the brightness to 100 as
|
||||
# it thinks 0 is off.
|
||||
#
|
||||
# Therefore, if the the brightness is 0 and the device is still on,
|
||||
# the brightness is mapped to 1 otherwise the update is ignored in
|
||||
# order to avoid this incorrect behavior.
|
||||
if brightness == 0:
|
||||
if state == STATE_ON:
|
||||
self.char_brightness.set_value(1)
|
||||
else:
|
||||
self.char_brightness.set_value(brightness)
|
||||
self._flag[CHAR_BRIGHTNESS] = False
|
||||
self.char_brightness.set_value(brightness)
|
||||
|
||||
# Handle color temperature
|
||||
if CHAR_COLOR_TEMPERATURE in self.chars:
|
||||
color_temperature = new_state.attributes.get(ATTR_COLOR_TEMP)
|
||||
if (
|
||||
not self._flag[CHAR_COLOR_TEMPERATURE]
|
||||
and isinstance(color_temperature, int)
|
||||
isinstance(color_temperature, int)
|
||||
and self.char_color_temperature.value != color_temperature
|
||||
):
|
||||
self.char_color_temperature.set_value(color_temperature)
|
||||
self._flag[CHAR_COLOR_TEMPERATURE] = False
|
||||
|
||||
# Handle Color
|
||||
if CHAR_SATURATION in self.chars and CHAR_HUE in self.chars:
|
||||
hue, saturation = new_state.attributes.get(ATTR_HS_COLOR, (None, None))
|
||||
if (
|
||||
not self._flag[RGB_COLOR]
|
||||
and (hue != self._hue or saturation != self._saturation)
|
||||
and isinstance(hue, (int, float))
|
||||
isinstance(hue, (int, float))
|
||||
and isinstance(saturation, (int, float))
|
||||
and (
|
||||
hue != self.char_hue.value
|
||||
or saturation != self.char_saturation.value
|
||||
)
|
||||
):
|
||||
self.char_hue.set_value(hue)
|
||||
self.char_saturation.set_value(saturation)
|
||||
self._hue, self._saturation = (hue, saturation)
|
||||
self._flag[RGB_COLOR] = False
|
||||
Reference in new issue
Block a user