/
light.py
406 lines (360 loc) · 13.8 KB
/
light.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
"""Support for TPLink lights."""
from __future__ import annotations
from collections.abc import Sequence
import logging
from typing import Any, Final, cast
from kasa import SmartBulb, SmartLightStrip
import voluptuous as vol
from homeassistant.components.light import (
ATTR_BRIGHTNESS,
ATTR_COLOR_TEMP_KELVIN,
ATTR_EFFECT,
ATTR_HS_COLOR,
ATTR_TRANSITION,
ColorMode,
LightEntity,
LightEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import entity_platform
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import legacy_device_id
from .const import DOMAIN
from .coordinator import TPLinkDataUpdateCoordinator
from .entity import CoordinatedTPLinkEntity, async_refresh_after
from .models import TPLinkData
_LOGGER = logging.getLogger(__name__)
SERVICE_RANDOM_EFFECT = "random_effect"
SERVICE_SEQUENCE_EFFECT = "sequence_effect"
HUE = vol.Range(min=0, max=360)
SAT = vol.Range(min=0, max=100)
VAL = vol.Range(min=0, max=100)
TRANSITION = vol.Range(min=0, max=6000)
HSV_SEQUENCE = vol.ExactSequence((HUE, SAT, VAL))
BASE_EFFECT_DICT: Final = {
vol.Optional("brightness", default=100): vol.All(
vol.Coerce(int), vol.Range(min=0, max=100)
),
vol.Optional("duration", default=0): vol.All(
vol.Coerce(int), vol.Range(min=0, max=5000)
),
vol.Optional("transition", default=0): vol.All(vol.Coerce(int), TRANSITION),
vol.Optional("segments", default=[0]): vol.All(
cv.ensure_list_csv,
vol.Length(min=1, max=80),
[vol.All(vol.Coerce(int), vol.Range(min=0, max=80))],
),
}
SEQUENCE_EFFECT_DICT: Final = {
**BASE_EFFECT_DICT,
vol.Required("sequence"): vol.All(
cv.ensure_list,
vol.Length(min=1, max=16),
[vol.All(vol.Coerce(tuple), HSV_SEQUENCE)],
),
vol.Optional("repeat_times", default=0): vol.All(
vol.Coerce(int), vol.Range(min=0, max=10)
),
vol.Optional("spread", default=1): vol.All(
vol.Coerce(int), vol.Range(min=1, max=16)
),
vol.Optional("direction", default=4): vol.All(
vol.Coerce(int), vol.Range(min=1, max=4)
),
}
RANDOM_EFFECT_DICT: Final = {
**BASE_EFFECT_DICT,
vol.Optional("fadeoff", default=0): vol.All(
vol.Coerce(int), vol.Range(min=0, max=3000)
),
vol.Optional("hue_range"): vol.All(
cv.ensure_list_csv, [vol.Coerce(int)], vol.ExactSequence((HUE, HUE))
),
vol.Optional("saturation_range"): vol.All(
cv.ensure_list_csv, [vol.Coerce(int)], vol.ExactSequence((SAT, SAT))
),
vol.Optional("brightness_range"): vol.All(
cv.ensure_list_csv, [vol.Coerce(int)], vol.ExactSequence((VAL, VAL))
),
vol.Optional("transition_range"): vol.All(
cv.ensure_list_csv,
[vol.Coerce(int)],
vol.ExactSequence((TRANSITION, TRANSITION)),
),
vol.Required("init_states"): vol.All(
cv.ensure_list_csv, [vol.Coerce(int)], HSV_SEQUENCE
),
vol.Optional("random_seed", default=100): vol.All(
vol.Coerce(int), vol.Range(min=1, max=600)
),
vol.Optional("backgrounds"): vol.All(
cv.ensure_list,
vol.Length(min=1, max=16),
[vol.All(vol.Coerce(tuple), HSV_SEQUENCE)],
),
}
@callback
def _async_build_base_effect(
brightness: int,
duration: int,
transition: int,
segments: list[int],
) -> dict[str, Any]:
return {
"custom": 1,
"id": "yMwcNpLxijmoKamskHCvvravpbnIqAIN",
"brightness": brightness,
"name": "Custom",
"segments": segments,
"expansion_strategy": 1,
"enable": 1,
"duration": duration,
"transition": transition,
}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up switches."""
data: TPLinkData = hass.data[DOMAIN][config_entry.entry_id]
parent_coordinator = data.parent_coordinator
device = parent_coordinator.device
if device.is_light_strip:
async_add_entities(
[TPLinkSmartLightStrip(cast(SmartLightStrip, device), parent_coordinator)]
)
platform = entity_platform.async_get_current_platform()
platform.async_register_entity_service(
SERVICE_RANDOM_EFFECT,
RANDOM_EFFECT_DICT,
"async_set_random_effect",
)
platform.async_register_entity_service(
SERVICE_SEQUENCE_EFFECT,
SEQUENCE_EFFECT_DICT,
"async_set_sequence_effect",
)
elif device.is_bulb or device.is_dimmer:
async_add_entities(
[TPLinkSmartBulb(cast(SmartBulb, device), parent_coordinator)]
)
class TPLinkSmartBulb(CoordinatedTPLinkEntity, LightEntity):
"""Representation of a TPLink Smart Bulb."""
_attr_supported_features = LightEntityFeature.TRANSITION
_attr_name = None
device: SmartBulb
def __init__(
self,
device: SmartBulb,
coordinator: TPLinkDataUpdateCoordinator,
) -> None:
"""Initialize the switch."""
super().__init__(device, coordinator)
# For backwards compat with pyHS100
if device.is_dimmer:
# Dimmers used to use the switch format since
# pyHS100 treated them as SmartPlug but the old code
# created them as lights
# https://github.com/home-assistant/core/blob/2021.9.7/homeassistant/components/tplink/common.py#L86
self._attr_unique_id = legacy_device_id(device)
else:
self._attr_unique_id = device.mac.replace(":", "").upper()
@callback
def _async_extract_brightness_transition(
self, **kwargs: Any
) -> tuple[int | None, int | None]:
if (transition := kwargs.get(ATTR_TRANSITION)) is not None:
transition = int(transition * 1_000)
if (brightness := kwargs.get(ATTR_BRIGHTNESS)) is not None:
brightness = round((brightness * 100.0) / 255.0)
if self.device.is_dimmer and transition is None:
# This is a stopgap solution for inconsistent set_brightness handling
# in the upstream library, see #57265.
# This should be removed when the upstream has fixed the issue.
# The device logic is to change the settings without turning it on
# except when transition is defined, so we leverage that here for now.
transition = 1
return brightness, transition
async def _async_set_hsv(
self, hs_color: tuple[int, int], brightness: int | None, transition: int | None
) -> None:
# TP-Link requires integers.
hue, sat = tuple(int(val) for val in hs_color)
await self.device.set_hsv(hue, sat, brightness, transition=transition)
async def _async_turn_on_with_brightness(
self, brightness: int | None, transition: int | None
) -> None:
# Fallback to adjusting brightness or turning the bulb on
if brightness is not None:
await self.device.set_brightness(brightness, transition=transition)
return
await self.device.turn_on(transition=transition)
@async_refresh_after
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn the light on."""
brightness, transition = self._async_extract_brightness_transition(**kwargs)
if ATTR_COLOR_TEMP_KELVIN in kwargs:
await self.device.set_color_temp(
int(kwargs[ATTR_COLOR_TEMP_KELVIN]),
brightness=brightness,
transition=transition,
)
if ATTR_HS_COLOR in kwargs:
await self._async_set_hsv(kwargs[ATTR_HS_COLOR], brightness, transition)
else:
await self._async_turn_on_with_brightness(brightness, transition)
@async_refresh_after
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn the light off."""
if (transition := kwargs.get(ATTR_TRANSITION)) is not None:
transition = int(transition * 1_000)
await self.device.turn_off(transition=transition)
@property
def min_color_temp_kelvin(self) -> int:
"""Return minimum supported color temperature."""
return cast(int, self.device.valid_temperature_range.min)
@property
def max_color_temp_kelvin(self) -> int:
"""Return maximum supported color temperature."""
return cast(int, self.device.valid_temperature_range.max)
@property
def color_temp_kelvin(self) -> int:
"""Return the color temperature of this light."""
return cast(int, self.device.color_temp)
@property
def brightness(self) -> int | None:
"""Return the brightness of this light between 0..255."""
return round((cast(int, self.device.brightness) * 255.0) / 100.0)
@property
def hs_color(self) -> tuple[int, int] | None:
"""Return the color."""
hue, saturation, _ = self.device.hsv
return hue, saturation
@property
def supported_color_modes(self) -> set[ColorMode]:
"""Return list of available color modes."""
modes: set[ColorMode] = set()
if self.device.is_variable_color_temp:
modes.add(ColorMode.COLOR_TEMP)
if self.device.is_color:
modes.add(ColorMode.HS)
if self.device.is_dimmable:
modes.add(ColorMode.BRIGHTNESS)
if not modes:
modes.add(ColorMode.ONOFF)
return modes
@property
def color_mode(self) -> ColorMode:
"""Return the active color mode."""
if self.device.is_color:
if self.device.is_variable_color_temp and self.device.color_temp:
return ColorMode.COLOR_TEMP
return ColorMode.HS
if self.device.is_variable_color_temp:
return ColorMode.COLOR_TEMP
return ColorMode.BRIGHTNESS
class TPLinkSmartLightStrip(TPLinkSmartBulb):
"""Representation of a TPLink Smart Light Strip."""
device: SmartLightStrip
@property
def supported_features(self) -> LightEntityFeature:
"""Flag supported features."""
return super().supported_features | LightEntityFeature.EFFECT
@property
def effect_list(self) -> list[str] | None:
"""Return the list of available effects."""
if effect_list := self.device.effect_list:
return cast(list[str], effect_list)
return None
@property
def effect(self) -> str | None:
"""Return the current effect."""
if (effect := self.device.effect) and effect["enable"]:
return cast(str, effect["name"])
return None
@async_refresh_after
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn the light on."""
brightness, transition = self._async_extract_brightness_transition(**kwargs)
if ATTR_EFFECT in kwargs:
await self.device.set_effect(
kwargs[ATTR_EFFECT], brightness=brightness, transition=transition
)
elif ATTR_COLOR_TEMP_KELVIN in kwargs:
if self.effect:
# If there is an effect in progress
# we have to set an HSV value to clear the effect
# before we can set a color temp
await self.device.set_hsv(0, 0, brightness)
await self.device.set_color_temp(
int(kwargs[ATTR_COLOR_TEMP_KELVIN]),
brightness=brightness,
transition=transition,
)
elif ATTR_HS_COLOR in kwargs:
await self._async_set_hsv(kwargs[ATTR_HS_COLOR], brightness, transition)
else:
await self._async_turn_on_with_brightness(brightness, transition)
async def async_set_random_effect(
self,
brightness: int,
duration: int,
transition: int,
segments: list[int],
fadeoff: int,
init_states: tuple[int, int, int],
random_seed: int,
backgrounds: Sequence[tuple[int, int, int]] | None = None,
hue_range: tuple[int, int] | None = None,
saturation_range: tuple[int, int] | None = None,
brightness_range: tuple[int, int] | None = None,
transition_range: tuple[int, int] | None = None,
) -> None:
"""Set a random effect."""
effect: dict[str, Any] = {
**_async_build_base_effect(brightness, duration, transition, segments),
"type": "random",
"init_states": [init_states],
"random_seed": random_seed,
}
if backgrounds:
effect["backgrounds"] = backgrounds
if fadeoff:
effect["fadeoff"] = fadeoff
if hue_range:
effect["hue_range"] = hue_range
if saturation_range:
effect["saturation_range"] = saturation_range
if brightness_range:
effect["brightness_range"] = brightness_range
effect["brightness"] = min(
brightness_range[1], max(brightness, brightness_range[0])
)
if transition_range:
effect["transition_range"] = transition_range
effect["transition"] = 0
await self.device.set_custom_effect(effect)
async def async_set_sequence_effect(
self,
brightness: int,
duration: int,
transition: int,
segments: list[int],
sequence: Sequence[tuple[int, int, int]],
repeat_times: int,
spread: int,
direction: int,
) -> None:
"""Set a sequence effect."""
effect: dict[str, Any] = {
**_async_build_base_effect(brightness, duration, transition, segments),
"type": "sequence",
"sequence": sequence,
"repeat_times": repeat_times,
"spread": spread,
"direction": direction,
}
await self.device.set_custom_effect(effect)