Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-23 03:33:35 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add transition parameter to lightstrip's set_effect (#416)

Browse Source
This commit is contained in:
Teemu R 2023-02-18 18:03:54 +01:00 committed by GitHub
parent 92636fe82d
commit 12c98eb58d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
kasa/smartlightstrip.py
View File

@ -89,18 +89,30 @@ class SmartLightStrip(SmartBulb):
@requires_update
async def set_effect(
self, effect: str, *, brightness: Optional[int] = None
self,
effect: str,
*,
brightness: Optional[int] = None,
transition: Optional[int] = None,
) -> None:
"""Set an effect on the device.
If brightness or transition is defined, its value will be used instead of the effect-specific default.
See :meth:`effect_list` for available effects, or use :meth:`set_custom_effect` for custom effects.
:param str effect: The effect to set
:param int brightness: The wanted brightness
:param int transition: The wanted transition time
"""
if effect not in EFFECT_MAPPING_V1:
raise SmartDeviceException(f"The effect {effect} is not a built in effect.")
effect_dict = EFFECT_MAPPING_V1[effect]
if brightness is not None:
effect_dict["brightness"] = brightness
if transition is not None:
effect_dict["transition"] = transition
await self.set_custom_effect(effect_dict)
@requires_update

21
kasa/tests/test_lightstrip.py
View File

@ -37,7 +37,8 @@ async def test_effects_lightstrip_set_effect_brightness(
):
query_helper = mocker.patch("kasa.SmartLightStrip._query_helper")
if brightness == 100: # test that default brightness works
# test that default brightness works (100 for candy cane)
if brightness == 100:
await dev.set_effect("Candy Cane")
else:
await dev.set_effect("Candy Cane", brightness=brightness)
@ -47,6 +48,24 @@ async def test_effects_lightstrip_set_effect_brightness(
assert payload["brightness"] == brightness
@lightstrip
@pytest.mark.parametrize("transition", [500, 1000])
async def test_effects_lightstrip_set_effect_transition(
dev: SmartLightStrip, transition, mocker
):
query_helper = mocker.patch("kasa.SmartLightStrip._query_helper")
# test that default (500 for candy cane) transition works
if transition == 500:
await dev.set_effect("Candy Cane")
else:
await dev.set_effect("Candy Cane", transition=transition)
args, kwargs = query_helper.call_args_list[0]
payload = args[2]
assert payload["transition"] == transition
@lightstrip
async def test_effects_lightstrip_has_effects(dev: SmartLightStrip):
assert dev.has_effects is True