mirror of https://github.com/home-assistant/core
529 lines
19 KiB
Python
529 lines
19 KiB
Python
"""Test ZHA cover."""
|
|
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
from zigpy.profiles import zha
|
|
from zigpy.zcl.clusters import closures
|
|
import zigpy.zcl.foundation as zcl_f
|
|
|
|
from homeassistant.components.cover import (
|
|
ATTR_CURRENT_POSITION,
|
|
ATTR_CURRENT_TILT_POSITION,
|
|
ATTR_TILT_POSITION,
|
|
DOMAIN as COVER_DOMAIN,
|
|
SERVICE_CLOSE_COVER,
|
|
SERVICE_CLOSE_COVER_TILT,
|
|
SERVICE_OPEN_COVER,
|
|
SERVICE_OPEN_COVER_TILT,
|
|
SERVICE_SET_COVER_POSITION,
|
|
SERVICE_SET_COVER_TILT_POSITION,
|
|
SERVICE_STOP_COVER,
|
|
SERVICE_STOP_COVER_TILT,
|
|
CoverState,
|
|
)
|
|
from homeassistant.components.zha.helpers import (
|
|
ZHADeviceProxy,
|
|
ZHAGatewayProxy,
|
|
get_zha_gateway,
|
|
get_zha_gateway_proxy,
|
|
)
|
|
from homeassistant.const import Platform
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers.entity_component import async_update_entity
|
|
|
|
from .common import find_entity_id, send_attributes_report, update_attribute_cache
|
|
from .conftest import SIG_EP_INPUT, SIG_EP_OUTPUT, SIG_EP_PROFILE, SIG_EP_TYPE
|
|
|
|
Default_Response = zcl_f.GENERAL_COMMANDS[zcl_f.GeneralCommand.Default_Response].schema
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def cover_platform_only():
|
|
"""Only set up the cover and required base platforms to speed up tests."""
|
|
with patch(
|
|
"homeassistant.components.zha.PLATFORMS",
|
|
(
|
|
Platform.COVER,
|
|
Platform.DEVICE_TRACKER,
|
|
Platform.NUMBER,
|
|
Platform.SELECT,
|
|
),
|
|
):
|
|
yield
|
|
|
|
|
|
WCAttrs = closures.WindowCovering.AttributeDefs
|
|
WCCmds = closures.WindowCovering.ServerCommandDefs
|
|
WCT = closures.WindowCovering.WindowCoveringType
|
|
WCCS = closures.WindowCovering.ConfigStatus
|
|
|
|
|
|
async def test_cover(hass: HomeAssistant, setup_zha, zigpy_device_mock) -> None:
|
|
"""Test ZHA cover platform."""
|
|
|
|
await setup_zha()
|
|
gateway = get_zha_gateway(hass)
|
|
gateway_proxy: ZHAGatewayProxy = get_zha_gateway_proxy(hass)
|
|
|
|
zigpy_device = zigpy_device_mock(
|
|
{
|
|
1: {
|
|
SIG_EP_PROFILE: zha.PROFILE_ID,
|
|
SIG_EP_TYPE: zha.DeviceType.WINDOW_COVERING_DEVICE,
|
|
SIG_EP_INPUT: [closures.WindowCovering.cluster_id],
|
|
SIG_EP_OUTPUT: [],
|
|
}
|
|
},
|
|
)
|
|
# load up cover domain
|
|
cluster = zigpy_device.endpoints[1].window_covering
|
|
cluster.PLUGGED_ATTR_READS = {
|
|
WCAttrs.current_position_lift_percentage.name: 0,
|
|
WCAttrs.current_position_tilt_percentage.name: 42,
|
|
WCAttrs.window_covering_type.name: WCT.Tilt_blind_tilt_and_lift,
|
|
WCAttrs.config_status.name: WCCS(~WCCS.Open_up_commands_reversed),
|
|
}
|
|
update_attribute_cache(cluster)
|
|
|
|
gateway.get_or_create_device(zigpy_device)
|
|
await gateway.async_device_initialized(zigpy_device)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
zha_device_proxy: ZHADeviceProxy = gateway_proxy.get_device_proxy(zigpy_device.ieee)
|
|
entity_id = find_entity_id(Platform.COVER, zha_device_proxy, hass)
|
|
assert entity_id is not None
|
|
|
|
assert (
|
|
not zha_device_proxy.device.endpoints[1]
|
|
.all_cluster_handlers[f"1:0x{cluster.cluster_id:04x}"]
|
|
.inverted
|
|
)
|
|
assert cluster.read_attributes.call_count == 3
|
|
assert (
|
|
WCAttrs.current_position_lift_percentage.name
|
|
in cluster.read_attributes.call_args[0][0]
|
|
)
|
|
assert (
|
|
WCAttrs.current_position_tilt_percentage.name
|
|
in cluster.read_attributes.call_args[0][0]
|
|
)
|
|
|
|
await async_update_entity(hass, entity_id)
|
|
state = hass.states.get(entity_id)
|
|
assert state
|
|
assert state.state == CoverState.OPEN
|
|
assert state.attributes[ATTR_CURRENT_POSITION] == 100
|
|
assert state.attributes[ATTR_CURRENT_TILT_POSITION] == 58
|
|
|
|
# test that the state has changed from unavailable to off
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 100}
|
|
)
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSED
|
|
|
|
# test to see if it opens
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 0}
|
|
)
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
# test that the state remains after tilting to 100%
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_tilt_percentage.id: 100}
|
|
)
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
# test to see the state remains after tilting to 0%
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_tilt_percentage.id: 0}
|
|
)
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
# close from UI
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x1, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN, SERVICE_CLOSE_COVER, {"entity_id": entity_id}, blocking=True
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x01
|
|
assert cluster.request.call_args[0][2].command.name == WCCmds.down_close.name
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 100}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSED
|
|
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x1, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_CLOSE_COVER_TILT,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x08
|
|
assert (
|
|
cluster.request.call_args[0][2].command.name
|
|
== WCCmds.go_to_tilt_percentage.name
|
|
)
|
|
assert cluster.request.call_args[0][3] == 100
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_tilt_percentage.id: 100}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSED
|
|
|
|
# open from UI
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x0, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN, SERVICE_OPEN_COVER, {"entity_id": entity_id}, blocking=True
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x00
|
|
assert cluster.request.call_args[0][2].command.name == WCCmds.up_open.name
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.OPENING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 0}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x0, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_OPEN_COVER_TILT,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x08
|
|
assert (
|
|
cluster.request.call_args[0][2].command.name
|
|
== WCCmds.go_to_tilt_percentage.name
|
|
)
|
|
assert cluster.request.call_args[0][3] == 0
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.OPENING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_tilt_percentage.id: 0}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
# set position UI
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x5, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_SET_COVER_POSITION,
|
|
{"entity_id": entity_id, "position": 47},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x05
|
|
assert (
|
|
cluster.request.call_args[0][2].command.name
|
|
== WCCmds.go_to_lift_percentage.name
|
|
)
|
|
assert cluster.request.call_args[0][3] == 53
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 35}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 53}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x5, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_SET_COVER_TILT_POSITION,
|
|
{"entity_id": entity_id, ATTR_TILT_POSITION: 47},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x08
|
|
assert (
|
|
cluster.request.call_args[0][2].command.name
|
|
== WCCmds.go_to_tilt_percentage.name
|
|
)
|
|
assert cluster.request.call_args[0][3] == 53
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 35}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSING
|
|
|
|
await send_attributes_report(
|
|
hass, cluster, {WCAttrs.current_position_lift_percentage.id: 53}
|
|
)
|
|
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
# stop from UI
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x2, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN, SERVICE_STOP_COVER, {"entity_id": entity_id}, blocking=True
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x02
|
|
assert cluster.request.call_args[0][2].command.name == WCCmds.stop.name
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
with patch("zigpy.zcl.Cluster.request", return_value=[0x2, zcl_f.Status.SUCCESS]):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_STOP_COVER_TILT,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert cluster.request.call_args[0][0] is False
|
|
assert cluster.request.call_args[0][1] == 0x02
|
|
assert cluster.request.call_args[0][2].command.name == WCCmds.stop.name
|
|
assert cluster.request.call_args[1]["expect_reply"] is True
|
|
|
|
|
|
async def test_cover_failures(
|
|
hass: HomeAssistant, setup_zha, zigpy_device_mock
|
|
) -> None:
|
|
"""Test ZHA cover platform failure cases."""
|
|
await setup_zha()
|
|
gateway = get_zha_gateway(hass)
|
|
gateway_proxy: ZHAGatewayProxy = get_zha_gateway_proxy(hass)
|
|
|
|
zigpy_device = zigpy_device_mock(
|
|
{
|
|
1: {
|
|
SIG_EP_PROFILE: zha.PROFILE_ID,
|
|
SIG_EP_TYPE: zha.DeviceType.WINDOW_COVERING_DEVICE,
|
|
SIG_EP_INPUT: [closures.WindowCovering.cluster_id],
|
|
SIG_EP_OUTPUT: [],
|
|
}
|
|
},
|
|
)
|
|
# load up cover domain
|
|
cluster = zigpy_device.endpoints[1].window_covering
|
|
cluster.PLUGGED_ATTR_READS = {
|
|
WCAttrs.current_position_tilt_percentage.name: 42,
|
|
WCAttrs.window_covering_type.name: WCT.Tilt_blind_tilt_and_lift,
|
|
}
|
|
update_attribute_cache(cluster)
|
|
|
|
gateway.get_or_create_device(zigpy_device)
|
|
await gateway.async_device_initialized(zigpy_device)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
zha_device_proxy: ZHADeviceProxy = gateway_proxy.get_device_proxy(zigpy_device.ieee)
|
|
entity_id = find_entity_id(Platform.COVER, zha_device_proxy, hass)
|
|
assert entity_id is not None
|
|
|
|
# test that the state has changed from unavailable to closed
|
|
await send_attributes_report(hass, cluster, {0: 0, 8: 100, 1: 1})
|
|
assert hass.states.get(entity_id).state == CoverState.CLOSED
|
|
|
|
# test to see if it opens
|
|
await send_attributes_report(hass, cluster, {0: 1, 8: 0, 1: 100})
|
|
assert hass.states.get(entity_id).state == CoverState.OPEN
|
|
|
|
# close from UI
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.down_close.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to close cover"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_CLOSE_COVER,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.down_close.id
|
|
)
|
|
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.go_to_tilt_percentage.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to close cover tilt"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_CLOSE_COVER_TILT,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.go_to_tilt_percentage.id
|
|
)
|
|
|
|
# open from UI
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.up_open.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to open cover"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_OPEN_COVER,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.up_open.id
|
|
)
|
|
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.go_to_tilt_percentage.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to open cover tilt"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_OPEN_COVER_TILT,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.go_to_tilt_percentage.id
|
|
)
|
|
|
|
# set position UI
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.go_to_lift_percentage.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to set cover position"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_SET_COVER_POSITION,
|
|
{"entity_id": entity_id, "position": 47},
|
|
blocking=True,
|
|
)
|
|
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.go_to_lift_percentage.id
|
|
)
|
|
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.go_to_tilt_percentage.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(
|
|
HomeAssistantError, match=r"Failed to set cover tilt position"
|
|
):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_SET_COVER_TILT_POSITION,
|
|
{"entity_id": entity_id, "tilt_position": 42},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.go_to_tilt_percentage.id
|
|
)
|
|
|
|
# stop from UI
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.stop.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to stop cover"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_STOP_COVER,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.stop.id
|
|
)
|
|
|
|
# stop from UI
|
|
with patch(
|
|
"zigpy.zcl.Cluster.request",
|
|
return_value=Default_Response(
|
|
command_id=closures.WindowCovering.ServerCommandDefs.stop.id,
|
|
status=zcl_f.Status.UNSUP_CLUSTER_COMMAND,
|
|
),
|
|
):
|
|
with pytest.raises(HomeAssistantError, match=r"Failed to stop cover"):
|
|
await hass.services.async_call(
|
|
COVER_DOMAIN,
|
|
SERVICE_STOP_COVER_TILT,
|
|
{"entity_id": entity_id},
|
|
blocking=True,
|
|
)
|
|
assert cluster.request.call_count == 1
|
|
assert (
|
|
cluster.request.call_args[0][1]
|
|
== closures.WindowCovering.ServerCommandDefs.stop.id
|
|
)
|