Add Custom mapping of Risco states (#39218)
* Custom mapping of Risco states * More informative error log * Add alternative Risco terms * Black formatting
This commit is contained in:
1 parent
24db31fa28
commit
b14af3e727
7 files changed
+464
-111
No files matched your search
@@ -2,6 +2,12 @@
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.alarm_control_panel import DOMAIN as ALARM_DOMAIN
|
||||
from homeassistant.components.alarm_control_panel.const import (
|
||||
SUPPORT_ALARM_ARM_AWAY,
|
||||
SUPPORT_ALARM_ARM_CUSTOM_BYPASS,
|
||||
SUPPORT_ALARM_ARM_HOME,
|
||||
SUPPORT_ALARM_ARM_NIGHT,
|
||||
)
|
||||
from homeassistant.components.risco import CannotConnectError, UnauthorizedError
|
||||
from homeassistant.components.risco.const import DOMAIN
|
||||
from homeassistant.const import (
|
||||
@@ -9,10 +15,14 @@ from homeassistant.const import (
|
||||
CONF_PIN,
|
||||
CONF_USERNAME,
|
||||
SERVICE_ALARM_ARM_AWAY,
|
||||
SERVICE_ALARM_ARM_CUSTOM_BYPASS,
|
||||
SERVICE_ALARM_ARM_HOME,
|
||||
SERVICE_ALARM_ARM_NIGHT,
|
||||
SERVICE_ALARM_DISARM,
|
||||
STATE_ALARM_ARMED_AWAY,
|
||||
STATE_ALARM_ARMED_CUSTOM_BYPASS,
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
STATE_ALARM_ARMED_NIGHT,
|
||||
STATE_ALARM_ARMING,
|
||||
STATE_ALARM_DISARMED,
|
||||
STATE_ALARM_TRIGGERED,
|
||||
@@ -34,6 +44,40 @@ FIRST_ENTITY_ID = "alarm_control_panel.risco_test_site_name_partition_0"
|
||||
SECOND_ENTITY_ID = "alarm_control_panel.risco_test_site_name_partition_1"
|
||||
|
||||
CODES_REQUIRED_OPTIONS = {"code_arm_required": True, "code_disarm_required": True}
|
||||
TEST_RISCO_TO_HA = {
|
||||
"arm": STATE_ALARM_ARMED_AWAY,
|
||||
"partial_arm": STATE_ALARM_ARMED_HOME,
|
||||
"A": STATE_ALARM_ARMED_HOME,
|
||||
"B": STATE_ALARM_ARMED_HOME,
|
||||
"C": STATE_ALARM_ARMED_NIGHT,
|
||||
"D": STATE_ALARM_ARMED_NIGHT,
|
||||
}
|
||||
TEST_FULL_RISCO_TO_HA = {
|
||||
**TEST_RISCO_TO_HA,
|
||||
"D": STATE_ALARM_ARMED_CUSTOM_BYPASS,
|
||||
}
|
||||
TEST_HA_TO_RISCO = {
|
||||
STATE_ALARM_ARMED_AWAY: "arm",
|
||||
STATE_ALARM_ARMED_HOME: "partial_arm",
|
||||
STATE_ALARM_ARMED_NIGHT: "C",
|
||||
}
|
||||
TEST_FULL_HA_TO_RISCO = {
|
||||
**TEST_HA_TO_RISCO,
|
||||
STATE_ALARM_ARMED_CUSTOM_BYPASS: "D",
|
||||
}
|
||||
CUSTOM_MAPPING_OPTIONS = {
|
||||
"risco_states_to_ha": TEST_RISCO_TO_HA,
|
||||
"ha_states_to_risco": TEST_HA_TO_RISCO,
|
||||
}
|
||||
|
||||
FULL_CUSTOM_MAPPING = {
|
||||
"risco_states_to_ha": TEST_FULL_RISCO_TO_HA,
|
||||
"ha_states_to_risco": TEST_FULL_HA_TO_RISCO,
|
||||
}
|
||||
|
||||
EXPECTED_FEATURES = (
|
||||
SUPPORT_ALARM_ARM_AWAY | SUPPORT_ALARM_ARM_HOME | SUPPORT_ALARM_ARM_NIGHT
|
||||
)
|
||||
|
||||
|
||||
def _partition_mock():
|
||||
@@ -152,55 +196,68 @@ async def _check_state(hass, alarm, property, state, entity_id, partition_id):
|
||||
|
||||
async def test_states(hass, two_part_alarm):
|
||||
"""Test the various alarm states."""
|
||||
await _setup_risco(hass)
|
||||
await _setup_risco(hass, CUSTOM_MAPPING_OPTIONS)
|
||||
|
||||
assert hass.states.get(FIRST_ENTITY_ID).state == STATE_UNKNOWN
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "triggered", STATE_ALARM_TRIGGERED, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "triggered", STATE_ALARM_TRIGGERED, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "arming", STATE_ALARM_ARMING, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "arming", STATE_ALARM_ARMING, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "armed", STATE_ALARM_ARMED_AWAY, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "armed", STATE_ALARM_ARMED_AWAY, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"partially_armed",
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
FIRST_ENTITY_ID,
|
||||
0,
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"partially_armed",
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
SECOND_ENTITY_ID,
|
||||
1,
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "disarmed", STATE_ALARM_DISARMED, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "disarmed", STATE_ALARM_DISARMED, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
for partition_id, entity_id in {0: FIRST_ENTITY_ID, 1: SECOND_ENTITY_ID}.items():
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"triggered",
|
||||
STATE_ALARM_TRIGGERED,
|
||||
entity_id,
|
||||
partition_id,
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "arming", STATE_ALARM_ARMING, entity_id, partition_id
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"armed",
|
||||
STATE_ALARM_ARMED_AWAY,
|
||||
entity_id,
|
||||
partition_id,
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"partially_armed",
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
entity_id,
|
||||
partition_id,
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"disarmed",
|
||||
STATE_ALARM_DISARMED,
|
||||
entity_id,
|
||||
partition_id,
|
||||
)
|
||||
|
||||
groups = {"A": False, "B": False, "C": True, "D": False}
|
||||
with patch.object(
|
||||
two_part_alarm.partitions[partition_id],
|
||||
"groups",
|
||||
new_callable=PropertyMock(return_value=groups),
|
||||
):
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"partially_armed",
|
||||
STATE_ALARM_ARMED_NIGHT,
|
||||
entity_id,
|
||||
partition_id,
|
||||
)
|
||||
|
||||
|
||||
async def _test_service_call(hass, service, method, entity_id, partition_id, **kwargs):
|
||||
async def _test_service_call(
|
||||
hass, service, method, entity_id, partition_id, *args, **kwargs
|
||||
):
|
||||
with patch(f"homeassistant.components.risco.RiscoAPI.{method}") as set_mock:
|
||||
await _call_alarm_service(hass, service, entity_id, **kwargs)
|
||||
set_mock.assert_awaited_once_with(partition_id)
|
||||
set_mock.assert_awaited_once_with(partition_id, *args)
|
||||
|
||||
|
||||
async def _test_no_service_call(
|
||||
@@ -219,9 +276,13 @@ async def _call_alarm_service(hass, service, entity_id, **kwargs):
|
||||
)
|
||||
|
||||
|
||||
async def test_sets(hass, two_part_alarm):
|
||||
"""Test settings the various modes."""
|
||||
await _setup_risco(hass)
|
||||
async def test_sets_custom_mapping(hass, two_part_alarm):
|
||||
"""Test settings the various modes when mapping some states."""
|
||||
await _setup_risco(hass, CUSTOM_MAPPING_OPTIONS)
|
||||
|
||||
registry = await hass.helpers.entity_registry.async_get_registry()
|
||||
entity = registry.async_get(FIRST_ENTITY_ID)
|
||||
assert entity.supported_features == EXPECTED_FEATURES
|
||||
|
||||
await _test_service_call(hass, SERVICE_ALARM_DISARM, "disarm", FIRST_ENTITY_ID, 0)
|
||||
await _test_service_call(hass, SERVICE_ALARM_DISARM, "disarm", SECOND_ENTITY_ID, 1)
|
||||
@@ -233,11 +294,51 @@ async def test_sets(hass, two_part_alarm):
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", FIRST_ENTITY_ID, 0, "C"
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", SECOND_ENTITY_ID, 1, "C"
|
||||
)
|
||||
|
||||
|
||||
async def test_sets_full_custom_mapping(hass, two_part_alarm):
|
||||
"""Test settings the various modes when mapping all states."""
|
||||
await _setup_risco(hass, FULL_CUSTOM_MAPPING)
|
||||
|
||||
registry = await hass.helpers.entity_registry.async_get_registry()
|
||||
entity = registry.async_get(FIRST_ENTITY_ID)
|
||||
assert (
|
||||
entity.supported_features == EXPECTED_FEATURES | SUPPORT_ALARM_ARM_CUSTOM_BYPASS
|
||||
)
|
||||
|
||||
await _test_service_call(hass, SERVICE_ALARM_DISARM, "disarm", FIRST_ENTITY_ID, 0)
|
||||
await _test_service_call(hass, SERVICE_ALARM_DISARM, "disarm", SECOND_ENTITY_ID, 1)
|
||||
await _test_service_call(hass, SERVICE_ALARM_ARM_AWAY, "arm", FIRST_ENTITY_ID, 0)
|
||||
await _test_service_call(hass, SERVICE_ALARM_ARM_AWAY, "arm", SECOND_ENTITY_ID, 1)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", FIRST_ENTITY_ID, 0, "C"
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", SECOND_ENTITY_ID, 1, "C"
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_CUSTOM_BYPASS, "group_arm", FIRST_ENTITY_ID, 0, "D"
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_CUSTOM_BYPASS, "group_arm", SECOND_ENTITY_ID, 1, "D"
|
||||
)
|
||||
|
||||
|
||||
async def test_sets_with_correct_code(hass, two_part_alarm):
|
||||
"""Test settings the various modes when code is required."""
|
||||
await _setup_risco(hass, CODES_REQUIRED_OPTIONS)
|
||||
await _setup_risco(hass, {**CUSTOM_MAPPING_OPTIONS, **CODES_REQUIRED_OPTIONS})
|
||||
|
||||
code = {"code": 1234}
|
||||
await _test_service_call(
|
||||
@@ -258,11 +359,28 @@ async def test_sets_with_correct_code(hass, two_part_alarm):
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", SECOND_ENTITY_ID, 1, **code
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", FIRST_ENTITY_ID, 0, "C", **code
|
||||
)
|
||||
await _test_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", SECOND_ENTITY_ID, 1, "C", **code
|
||||
)
|
||||
await _test_no_service_call(
|
||||
hass, SERVICE_ALARM_ARM_CUSTOM_BYPASS, "partial_arm", FIRST_ENTITY_ID, 0, **code
|
||||
)
|
||||
await _test_no_service_call(
|
||||
hass,
|
||||
SERVICE_ALARM_ARM_CUSTOM_BYPASS,
|
||||
"partial_arm",
|
||||
SECOND_ENTITY_ID,
|
||||
1,
|
||||
**code,
|
||||
)
|
||||
|
||||
|
||||
async def test_sets_with_incorrect_code(hass, two_part_alarm):
|
||||
"""Test settings the various modes when code is required and incorrect."""
|
||||
await _setup_risco(hass, CODES_REQUIRED_OPTIONS)
|
||||
await _setup_risco(hass, {**CUSTOM_MAPPING_OPTIONS, **CODES_REQUIRED_OPTIONS})
|
||||
|
||||
code = {"code": 4321}
|
||||
await _test_no_service_call(
|
||||
@@ -283,3 +401,20 @@ async def test_sets_with_incorrect_code(hass, two_part_alarm):
|
||||
await _test_no_service_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", SECOND_ENTITY_ID, 1, **code
|
||||
)
|
||||
await _test_no_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", FIRST_ENTITY_ID, 0, **code
|
||||
)
|
||||
await _test_no_service_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "group_arm", SECOND_ENTITY_ID, 1, **code
|
||||
)
|
||||
await _test_no_service_call(
|
||||
hass, SERVICE_ALARM_ARM_CUSTOM_BYPASS, "partial_arm", FIRST_ENTITY_ID, 0, **code
|
||||
)
|
||||
await _test_no_service_call(
|
||||
hass,
|
||||
SERVICE_ALARM_ARM_CUSTOM_BYPASS,
|
||||
"partial_arm",
|
||||
SECOND_ENTITY_ID,
|
||||
1,
|
||||
**code,
|
||||
)
|
||||
@@ -1,4 +1,7 @@
|
||||
"""Test the Risco config flow."""
|
||||
import pytest
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import config_entries, data_entry_flow
|
||||
from homeassistant.components.risco.config_flow import (
|
||||
CannotConnectError,
|
||||
@@ -16,6 +19,27 @@ TEST_DATA = {
|
||||
"pin": "1234",
|
||||
}
|
||||
|
||||
TEST_RISCO_TO_HA = {
|
||||
"arm": "armed_away",
|
||||
"partial_arm": "armed_home",
|
||||
"A": "armed_home",
|
||||
"B": "armed_home",
|
||||
"C": "armed_night",
|
||||
"D": "armed_night",
|
||||
}
|
||||
|
||||
TEST_HA_TO_RISCO = {
|
||||
"armed_away": "arm",
|
||||
"armed_home": "partial_arm",
|
||||
"armed_night": "C",
|
||||
}
|
||||
|
||||
TEST_OPTIONS = {
|
||||
"scan_interval": 10,
|
||||
"code_arm_required": True,
|
||||
"code_disarm_required": True,
|
||||
}
|
||||
|
||||
|
||||
async def test_form(hass):
|
||||
"""Test we get the form."""
|
||||
@@ -133,12 +157,6 @@ async def test_form_already_exists(hass):
|
||||
|
||||
async def test_options_flow(hass):
|
||||
"""Test options flow."""
|
||||
conf = {
|
||||
"scan_interval": 10,
|
||||
"code_arm_required": True,
|
||||
"code_disarm_required": True,
|
||||
}
|
||||
|
||||
entry = MockConfigEntry(
|
||||
domain=DOMAIN,
|
||||
unique_id=TEST_DATA["username"],
|
||||
@@ -147,16 +165,71 @@ async def test_options_flow(hass):
|
||||
|
||||
entry.add_to_hass(hass)
|
||||
|
||||
result = await hass.config_entries.options.async_init(entry.entry_id)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "init"
|
||||
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input=TEST_OPTIONS,
|
||||
)
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "risco_to_ha"
|
||||
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input=TEST_RISCO_TO_HA,
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "ha_to_risco"
|
||||
|
||||
with patch("homeassistant.components.risco.async_setup_entry", return_value=True):
|
||||
result = await hass.config_entries.options.async_init(entry.entry_id)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "init"
|
||||
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input=conf,
|
||||
user_input=TEST_HA_TO_RISCO,
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
assert entry.options == conf
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
assert entry.options == {
|
||||
**TEST_OPTIONS,
|
||||
"risco_states_to_ha": TEST_RISCO_TO_HA,
|
||||
"ha_states_to_risco": TEST_HA_TO_RISCO,
|
||||
}
|
||||
|
||||
|
||||
async def test_ha_to_risco_schema(hass):
|
||||
"""Test that the schema for the ha-to-risco mapping step is generated properly."""
|
||||
entry = MockConfigEntry(
|
||||
domain=DOMAIN,
|
||||
unique_id=TEST_DATA["username"],
|
||||
data=TEST_DATA,
|
||||
)
|
||||
|
||||
entry.add_to_hass(hass)
|
||||
|
||||
result = await hass.config_entries.options.async_init(entry.entry_id)
|
||||
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input=TEST_OPTIONS,
|
||||
)
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input=TEST_RISCO_TO_HA,
|
||||
)
|
||||
|
||||
# Test an HA state that isn't used
|
||||
with pytest.raises(vol.error.MultipleInvalid):
|
||||
await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input={**TEST_HA_TO_RISCO, "armed_custom_bypass": "D"},
|
||||
)
|
||||
|
||||
# Test a combo that can't be selected
|
||||
with pytest.raises(vol.error.MultipleInvalid):
|
||||
await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input={**TEST_HA_TO_RISCO, "armed_night": "A"},
|
||||
)
|
||||
Reference in new issue
Block a user