542 lines
18 KiB
Python
542 lines
18 KiB
Python
"""Test zha light."""
|
|
from datetime import timedelta
|
|
from unittest.mock import MagicMock, call, sentinel
|
|
|
|
from asynctest import CoroutineMock, patch
|
|
import pytest
|
|
import zigpy.profiles.zha as zha
|
|
import zigpy.types
|
|
import zigpy.zcl.clusters.general as general
|
|
import zigpy.zcl.clusters.lighting as lighting
|
|
import zigpy.zcl.foundation as zcl_f
|
|
|
|
from homeassistant.components.light import DOMAIN, FLASH_LONG, FLASH_SHORT
|
|
from homeassistant.components.zha.light import FLASH_EFFECTS
|
|
from homeassistant.const import STATE_OFF, STATE_ON, STATE_UNAVAILABLE
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from .common import (
|
|
async_enable_traffic,
|
|
async_find_group_entity_id,
|
|
async_test_rejoin,
|
|
find_entity_id,
|
|
get_zha_gateway,
|
|
send_attributes_report,
|
|
)
|
|
|
|
from tests.common import async_fire_time_changed
|
|
|
|
ON = 1
|
|
OFF = 0
|
|
IEEE_GROUPABLE_DEVICE = "01:2d:6f:00:0a:90:69:e8"
|
|
IEEE_GROUPABLE_DEVICE2 = "02:2d:6f:00:0a:90:69:e8"
|
|
IEEE_GROUPABLE_DEVICE3 = "03:2d:6f:00:0a:90:69:e8"
|
|
|
|
LIGHT_ON_OFF = {
|
|
1: {
|
|
"device_type": zigpy.profiles.zha.DeviceType.ON_OFF_LIGHT,
|
|
"in_clusters": [
|
|
general.Basic.cluster_id,
|
|
general.Identify.cluster_id,
|
|
general.OnOff.cluster_id,
|
|
],
|
|
"out_clusters": [general.Ota.cluster_id],
|
|
}
|
|
}
|
|
|
|
LIGHT_LEVEL = {
|
|
1: {
|
|
"device_type": zigpy.profiles.zha.DeviceType.DIMMABLE_LIGHT,
|
|
"in_clusters": [
|
|
general.Basic.cluster_id,
|
|
general.LevelControl.cluster_id,
|
|
general.OnOff.cluster_id,
|
|
],
|
|
"out_clusters": [general.Ota.cluster_id],
|
|
}
|
|
}
|
|
|
|
LIGHT_COLOR = {
|
|
1: {
|
|
"device_type": zigpy.profiles.zha.DeviceType.COLOR_DIMMABLE_LIGHT,
|
|
"in_clusters": [
|
|
general.Basic.cluster_id,
|
|
general.Identify.cluster_id,
|
|
general.LevelControl.cluster_id,
|
|
general.OnOff.cluster_id,
|
|
lighting.Color.cluster_id,
|
|
],
|
|
"out_clusters": [general.Ota.cluster_id],
|
|
}
|
|
}
|
|
|
|
|
|
@pytest.fixture
|
|
async def coordinator(hass, zigpy_device_mock, zha_device_joined):
|
|
"""Test zha light platform."""
|
|
|
|
zigpy_device = zigpy_device_mock(
|
|
{
|
|
1: {
|
|
"in_clusters": [],
|
|
"out_clusters": [],
|
|
"device_type": zha.DeviceType.COLOR_DIMMABLE_LIGHT,
|
|
}
|
|
},
|
|
ieee="00:15:8d:00:02:32:4f:32",
|
|
nwk=0x0000,
|
|
)
|
|
zha_device = await zha_device_joined(zigpy_device)
|
|
zha_device.set_available(True)
|
|
return zha_device
|
|
|
|
|
|
@pytest.fixture
|
|
async def device_light_1(hass, zigpy_device_mock, zha_device_joined):
|
|
"""Test zha light platform."""
|
|
|
|
zigpy_device = zigpy_device_mock(
|
|
{
|
|
1: {
|
|
"in_clusters": [
|
|
general.OnOff.cluster_id,
|
|
general.LevelControl.cluster_id,
|
|
lighting.Color.cluster_id,
|
|
general.Groups.cluster_id,
|
|
general.Identify.cluster_id,
|
|
],
|
|
"out_clusters": [],
|
|
"device_type": zha.DeviceType.COLOR_DIMMABLE_LIGHT,
|
|
}
|
|
},
|
|
ieee=IEEE_GROUPABLE_DEVICE,
|
|
)
|
|
zha_device = await zha_device_joined(zigpy_device)
|
|
zha_device.set_available(True)
|
|
return zha_device
|
|
|
|
|
|
@pytest.fixture
|
|
async def device_light_2(hass, zigpy_device_mock, zha_device_joined):
|
|
"""Test zha light platform."""
|
|
|
|
zigpy_device = zigpy_device_mock(
|
|
{
|
|
1: {
|
|
"in_clusters": [
|
|
general.OnOff.cluster_id,
|
|
general.LevelControl.cluster_id,
|
|
lighting.Color.cluster_id,
|
|
general.Groups.cluster_id,
|
|
general.Identify.cluster_id,
|
|
],
|
|
"out_clusters": [],
|
|
"device_type": zha.DeviceType.COLOR_DIMMABLE_LIGHT,
|
|
}
|
|
},
|
|
ieee=IEEE_GROUPABLE_DEVICE2,
|
|
)
|
|
zha_device = await zha_device_joined(zigpy_device)
|
|
zha_device.set_available(True)
|
|
return zha_device
|
|
|
|
|
|
@pytest.fixture
|
|
async def device_light_3(hass, zigpy_device_mock, zha_device_joined):
|
|
"""Test zha light platform."""
|
|
|
|
zigpy_device = zigpy_device_mock(
|
|
{
|
|
1: {
|
|
"in_clusters": [
|
|
general.OnOff.cluster_id,
|
|
general.LevelControl.cluster_id,
|
|
lighting.Color.cluster_id,
|
|
general.Groups.cluster_id,
|
|
general.Identify.cluster_id,
|
|
],
|
|
"out_clusters": [],
|
|
"device_type": zha.DeviceType.COLOR_DIMMABLE_LIGHT,
|
|
}
|
|
},
|
|
ieee=IEEE_GROUPABLE_DEVICE3,
|
|
)
|
|
zha_device = await zha_device_joined(zigpy_device)
|
|
zha_device.set_available(True)
|
|
return zha_device
|
|
|
|
|
|
@patch("zigpy.zcl.clusters.general.OnOff.read_attributes", new=MagicMock())
|
|
async def test_light_refresh(hass, zigpy_device_mock, zha_device_joined_restored):
|
|
"""Test zha light platform refresh."""
|
|
|
|
# create zigpy devices
|
|
zigpy_device = zigpy_device_mock(LIGHT_ON_OFF)
|
|
zha_device = await zha_device_joined_restored(zigpy_device)
|
|
on_off_cluster = zigpy_device.endpoints[1].on_off
|
|
entity_id = await find_entity_id(DOMAIN, zha_device, hass)
|
|
|
|
# allow traffic to flow through the gateway and device
|
|
await async_enable_traffic(hass, [zha_device])
|
|
on_off_cluster.read_attributes.reset_mock()
|
|
|
|
# not enough time passed
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(minutes=20))
|
|
await hass.async_block_till_done()
|
|
assert on_off_cluster.read_attributes.call_count == 0
|
|
assert on_off_cluster.read_attributes.await_count == 0
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
# 1 interval - 1 call
|
|
on_off_cluster.read_attributes.return_value = [{"on_off": 1}, {}]
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(minutes=80))
|
|
await hass.async_block_till_done()
|
|
assert on_off_cluster.read_attributes.call_count == 1
|
|
assert on_off_cluster.read_attributes.await_count == 1
|
|
assert hass.states.get(entity_id).state == STATE_ON
|
|
|
|
# 2 intervals - 2 calls
|
|
on_off_cluster.read_attributes.return_value = [{"on_off": 0}, {}]
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(minutes=80))
|
|
await hass.async_block_till_done()
|
|
assert on_off_cluster.read_attributes.call_count == 2
|
|
assert on_off_cluster.read_attributes.await_count == 2
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
|
|
@patch(
|
|
"zigpy.zcl.clusters.lighting.Color.request",
|
|
new=CoroutineMock(return_value=[sentinel.data, zcl_f.Status.SUCCESS]),
|
|
)
|
|
@patch(
|
|
"zigpy.zcl.clusters.general.Identify.request",
|
|
new=CoroutineMock(return_value=[sentinel.data, zcl_f.Status.SUCCESS]),
|
|
)
|
|
@patch(
|
|
"zigpy.zcl.clusters.general.LevelControl.request",
|
|
new=CoroutineMock(return_value=[sentinel.data, zcl_f.Status.SUCCESS]),
|
|
)
|
|
@patch(
|
|
"zigpy.zcl.clusters.general.OnOff.request",
|
|
new=CoroutineMock(return_value=[sentinel.data, zcl_f.Status.SUCCESS]),
|
|
)
|
|
@pytest.mark.parametrize(
|
|
"device, reporting",
|
|
[(LIGHT_ON_OFF, (1, 0, 0)), (LIGHT_LEVEL, (1, 1, 0)), (LIGHT_COLOR, (1, 1, 3))],
|
|
)
|
|
async def test_light(
|
|
hass, zigpy_device_mock, zha_device_joined_restored, device, reporting
|
|
):
|
|
"""Test zha light platform."""
|
|
|
|
# create zigpy devices
|
|
zigpy_device = zigpy_device_mock(device)
|
|
zha_device = await zha_device_joined_restored(zigpy_device)
|
|
entity_id = await find_entity_id(DOMAIN, zha_device, hass)
|
|
|
|
assert entity_id is not None
|
|
|
|
cluster_on_off = zigpy_device.endpoints[1].on_off
|
|
cluster_level = getattr(zigpy_device.endpoints[1], "level", None)
|
|
cluster_color = getattr(zigpy_device.endpoints[1], "light_color", None)
|
|
cluster_identify = getattr(zigpy_device.endpoints[1], "identify", None)
|
|
|
|
# test that the lights were created and that they are unavailable
|
|
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
|
|
|
# allow traffic to flow through the gateway and device
|
|
await async_enable_traffic(hass, [zha_device])
|
|
|
|
# test that the lights were created and are off
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
# test turning the lights on and off from the light
|
|
await async_test_on_off_from_light(hass, cluster_on_off, entity_id)
|
|
|
|
# test turning the lights on and off from the HA
|
|
await async_test_on_off_from_hass(hass, cluster_on_off, entity_id)
|
|
|
|
# test short flashing the lights from the HA
|
|
if cluster_identify:
|
|
await async_test_flash_from_hass(hass, cluster_identify, entity_id, FLASH_SHORT)
|
|
|
|
# test turning the lights on and off from the HA
|
|
if cluster_level:
|
|
await async_test_level_on_off_from_hass(
|
|
hass, cluster_on_off, cluster_level, entity_id
|
|
)
|
|
|
|
# test getting a brightness change from the network
|
|
await async_test_on_from_light(hass, cluster_on_off, entity_id)
|
|
await async_test_dimmer_from_light(
|
|
hass, cluster_level, entity_id, 150, STATE_ON
|
|
)
|
|
|
|
# test rejoin
|
|
await async_test_off_from_hass(hass, cluster_on_off, entity_id)
|
|
clusters = [cluster_on_off]
|
|
if cluster_level:
|
|
clusters.append(cluster_level)
|
|
if cluster_color:
|
|
clusters.append(cluster_color)
|
|
await async_test_rejoin(hass, zigpy_device, clusters, reporting)
|
|
|
|
# test long flashing the lights from the HA
|
|
if cluster_identify:
|
|
await async_test_flash_from_hass(hass, cluster_identify, entity_id, FLASH_LONG)
|
|
|
|
|
|
async def async_test_on_off_from_light(hass, cluster, entity_id):
|
|
"""Test on off functionality from the light."""
|
|
# turn on at light
|
|
await send_attributes_report(hass, cluster, {1: 0, 0: 1, 2: 3})
|
|
assert hass.states.get(entity_id).state == STATE_ON
|
|
|
|
# turn off at light
|
|
await send_attributes_report(hass, cluster, {1: 1, 0: 0, 2: 3})
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
|
|
async def async_test_on_from_light(hass, cluster, entity_id):
|
|
"""Test on off functionality from the light."""
|
|
# turn on at light
|
|
await send_attributes_report(hass, cluster, {1: -1, 0: 1, 2: 2})
|
|
assert hass.states.get(entity_id).state == STATE_ON
|
|
|
|
|
|
async def async_test_on_off_from_hass(hass, cluster, entity_id):
|
|
"""Test on off functionality from hass."""
|
|
# turn on via UI
|
|
cluster.request.reset_mock()
|
|
await hass.services.async_call(
|
|
DOMAIN, "turn_on", {"entity_id": entity_id}, blocking=True
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.await_count == 1
|
|
assert cluster.request.call_args == call(
|
|
False, ON, (), expect_reply=True, manufacturer=None, tsn=None
|
|
)
|
|
|
|
await async_test_off_from_hass(hass, cluster, entity_id)
|
|
|
|
|
|
async def async_test_off_from_hass(hass, cluster, entity_id):
|
|
"""Test turning off the light from Home Assistant."""
|
|
|
|
# turn off via UI
|
|
cluster.request.reset_mock()
|
|
await hass.services.async_call(
|
|
DOMAIN, "turn_off", {"entity_id": entity_id}, blocking=True
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.await_count == 1
|
|
assert cluster.request.call_args == call(
|
|
False, OFF, (), expect_reply=True, manufacturer=None, tsn=None
|
|
)
|
|
|
|
|
|
async def async_test_level_on_off_from_hass(
|
|
hass, on_off_cluster, level_cluster, entity_id
|
|
):
|
|
"""Test on off functionality from hass."""
|
|
|
|
on_off_cluster.request.reset_mock()
|
|
level_cluster.request.reset_mock()
|
|
# turn on via UI
|
|
await hass.services.async_call(
|
|
DOMAIN, "turn_on", {"entity_id": entity_id}, blocking=True
|
|
)
|
|
assert on_off_cluster.request.call_count == 1
|
|
assert on_off_cluster.request.await_count == 1
|
|
assert level_cluster.request.call_count == 0
|
|
assert level_cluster.request.await_count == 0
|
|
assert on_off_cluster.request.call_args == call(
|
|
False, ON, (), expect_reply=True, manufacturer=None, tsn=None
|
|
)
|
|
on_off_cluster.request.reset_mock()
|
|
level_cluster.request.reset_mock()
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN, "turn_on", {"entity_id": entity_id, "transition": 10}, blocking=True
|
|
)
|
|
assert on_off_cluster.request.call_count == 1
|
|
assert on_off_cluster.request.await_count == 1
|
|
assert level_cluster.request.call_count == 1
|
|
assert level_cluster.request.await_count == 1
|
|
assert on_off_cluster.request.call_args == call(
|
|
False, ON, (), expect_reply=True, manufacturer=None, tsn=None
|
|
)
|
|
assert level_cluster.request.call_args == call(
|
|
False,
|
|
4,
|
|
(zigpy.types.uint8_t, zigpy.types.uint16_t),
|
|
254,
|
|
100.0,
|
|
expect_reply=True,
|
|
manufacturer=None,
|
|
tsn=None,
|
|
)
|
|
on_off_cluster.request.reset_mock()
|
|
level_cluster.request.reset_mock()
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN, "turn_on", {"entity_id": entity_id, "brightness": 10}, blocking=True
|
|
)
|
|
assert on_off_cluster.request.call_count == 1
|
|
assert on_off_cluster.request.await_count == 1
|
|
assert level_cluster.request.call_count == 1
|
|
assert level_cluster.request.await_count == 1
|
|
assert on_off_cluster.request.call_args == call(
|
|
False, ON, (), expect_reply=True, manufacturer=None, tsn=None
|
|
)
|
|
assert level_cluster.request.call_args == call(
|
|
False,
|
|
4,
|
|
(zigpy.types.uint8_t, zigpy.types.uint16_t),
|
|
10,
|
|
0,
|
|
expect_reply=True,
|
|
manufacturer=None,
|
|
tsn=None,
|
|
)
|
|
on_off_cluster.request.reset_mock()
|
|
level_cluster.request.reset_mock()
|
|
|
|
await async_test_off_from_hass(hass, on_off_cluster, entity_id)
|
|
|
|
|
|
async def async_test_dimmer_from_light(hass, cluster, entity_id, level, expected_state):
|
|
"""Test dimmer functionality from the light."""
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {1: level + 10, 0: level, 2: level - 10 or 22}
|
|
)
|
|
assert hass.states.get(entity_id).state == expected_state
|
|
# hass uses None for brightness of 0 in state attributes
|
|
if level == 0:
|
|
level = None
|
|
assert hass.states.get(entity_id).attributes.get("brightness") == level
|
|
|
|
|
|
async def async_test_flash_from_hass(hass, cluster, entity_id, flash):
|
|
"""Test flash functionality from hass."""
|
|
# turn on via UI
|
|
cluster.request.reset_mock()
|
|
await hass.services.async_call(
|
|
DOMAIN, "turn_on", {"entity_id": entity_id, "flash": flash}, blocking=True
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.await_count == 1
|
|
assert cluster.request.call_args == call(
|
|
False,
|
|
64,
|
|
(zigpy.types.uint8_t, zigpy.types.uint8_t),
|
|
FLASH_EFFECTS[flash],
|
|
0,
|
|
expect_reply=True,
|
|
manufacturer=None,
|
|
tsn=None,
|
|
)
|
|
|
|
|
|
async def async_test_zha_group_light_entity(
|
|
hass, device_light_1, device_light_2, device_light_3, coordinator
|
|
):
|
|
"""Test the light entity for a ZHA group."""
|
|
zha_gateway = get_zha_gateway(hass)
|
|
assert zha_gateway is not None
|
|
zha_gateway.coordinator_zha_device = coordinator
|
|
coordinator._zha_gateway = zha_gateway
|
|
device_light_1._zha_gateway = zha_gateway
|
|
device_light_2._zha_gateway = zha_gateway
|
|
member_ieee_addresses = [device_light_1.ieee, device_light_2.ieee]
|
|
|
|
# test creating a group with 2 members
|
|
zha_group = await zha_gateway.async_create_zigpy_group(
|
|
"Test Group", member_ieee_addresses
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert zha_group is not None
|
|
assert len(zha_group.members) == 2
|
|
for member in zha_group.members:
|
|
assert member.ieee in member_ieee_addresses
|
|
|
|
entity_id = async_find_group_entity_id(hass, DOMAIN, zha_group)
|
|
assert hass.states.get(entity_id) is not None
|
|
|
|
group_cluster_on_off = zha_group.endpoint[general.OnOff.cluster_id]
|
|
group_cluster_level = zha_group.endpoint[general.LevelControl.cluster_id]
|
|
group_cluster_identify = zha_group.endpoint[general.Identify.cluster_id]
|
|
|
|
dev1_cluster_on_off = device_light_1.endpoints[1].on_off
|
|
dev2_cluster_on_off = device_light_2.endpoints[1].on_off
|
|
dev3_cluster_on_off = device_light_3.endpoints[1].on_off
|
|
|
|
# test that the lights were created and that they are unavailable
|
|
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
|
|
|
# allow traffic to flow through the gateway and device
|
|
await async_enable_traffic(hass, zha_group.members)
|
|
|
|
# test that the lights were created and are off
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
# test turning the lights on and off from the light
|
|
await async_test_on_off_from_light(hass, group_cluster_on_off, entity_id)
|
|
|
|
# test turning the lights on and off from the HA
|
|
await async_test_on_off_from_hass(hass, group_cluster_on_off, entity_id)
|
|
|
|
# test short flashing the lights from the HA
|
|
await async_test_flash_from_hass(
|
|
hass, group_cluster_identify, entity_id, FLASH_SHORT
|
|
)
|
|
|
|
# test turning the lights on and off from the HA
|
|
await async_test_level_on_off_from_hass(
|
|
hass, group_cluster_on_off, group_cluster_level, entity_id
|
|
)
|
|
|
|
# test getting a brightness change from the network
|
|
await async_test_on_from_light(hass, group_cluster_on_off, entity_id)
|
|
await async_test_dimmer_from_light(
|
|
hass, group_cluster_level, entity_id, 150, STATE_ON
|
|
)
|
|
|
|
# test long flashing the lights from the HA
|
|
await async_test_flash_from_hass(
|
|
hass, group_cluster_identify, entity_id, FLASH_LONG
|
|
)
|
|
|
|
# test some of the group logic to make sure we key off states correctly
|
|
await dev1_cluster_on_off.on()
|
|
await dev2_cluster_on_off.on()
|
|
|
|
# test that group light is on
|
|
assert hass.states.get(entity_id).state == STATE_ON
|
|
|
|
await dev1_cluster_on_off.off()
|
|
|
|
# test that group light is still on
|
|
assert hass.states.get(entity_id).state == STATE_ON
|
|
|
|
await dev2_cluster_on_off.off()
|
|
|
|
# test that group light is now off
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
await dev1_cluster_on_off.on()
|
|
|
|
# test that group light is now back on
|
|
assert hass.states.get(entity_id).state == STATE_ON
|
|
|
|
# test that group light is now off
|
|
await group_cluster_on_off.off()
|
|
assert hass.states.get(entity_id).state == STATE_OFF
|
|
|
|
# add a new member and test that his state is also tracked
|
|
await zha_group.async_add_members([device_light_3.ieee])
|
|
await dev3_cluster_on_off.on()
|
|
assert hass.states.get(entity_id).state == STATE_ON
|