core/tests/components/homekit_controller/test_number.py

"""Basic checks for HomeKit sensor."""

from collections.abc import Callable

from aiohomekit.model import Accessory
from aiohomekit.model.characteristics import CharacteristicsTypes
from aiohomekit.model.services import Service, ServicesTypes

from homeassistant.components.number import NumberDeviceClass
from homeassistant.const import UnitOfTime
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er

from .common import Helper, setup_test_component


def create_switch_with_spray_level(accessory: Accessory) -> Service:
    """Define battery level characteristics."""
    service = accessory.add_service(ServicesTypes.OUTLET)

    spray_level = service.add_char(
        CharacteristicsTypes.VENDOR_VOCOLINC_HUMIDIFIER_SPRAY_LEVEL
    )

    spray_level.perms.append("ev")
    spray_level.value = 1
    spray_level.minStep = 1
    spray_level.minValue = 1
    spray_level.maxValue = 5
    spray_level.format = "float"

    cur_state = service.add_char(CharacteristicsTypes.ON)
    cur_state.value = True

    return service


def create_valve_with_set_duration(accessory: Accessory) -> Service:
    """Define valve characteristics with a set duration."""
    service = accessory.add_service(ServicesTypes.VALVE)

    active = service.add_char(CharacteristicsTypes.ACTIVE)
    active.value = False

    set_duration = service.add_char(CharacteristicsTypes.SET_DURATION)
    set_duration.value = 1200
    set_duration.minValue = 0
    set_duration.maxValue = 5400
    set_duration.minStep = 60

    return service


async def test_migrate_unique_id(
    hass: HomeAssistant,
    entity_registry: er.EntityRegistry,
    get_next_aid: Callable[[], int],
) -> None:
    """Test a we can migrate a number unique id."""
    aid = get_next_aid()
    number = entity_registry.async_get_or_create(
        "number",
        "homekit_controller",
        f"homekit-0001-aid:{aid}-sid:8-cid:9",
        suggested_object_id="testdevice_spray_quantity",
    )
    await setup_test_component(hass, aid, create_switch_with_spray_level)

    assert (
        entity_registry.async_get(number.entity_id).unique_id
        == f"00:00:00:00:00:00_{aid}_8_9"
    )


async def test_read_number(
    hass: HomeAssistant, get_next_aid: Callable[[], int]
) -> None:
    """Test a switch service that has a sensor characteristic is correctly handled."""
    helper = await setup_test_component(
        hass, get_next_aid(), create_switch_with_spray_level
    )

    # Helper will be for the primary entity, which is the outlet. Make a helper for the
    # sensor.
    spray_level = Helper(
        hass,
        "number.testdevice_spray_quantity",
        helper.pairing,
        helper.accessory,
        helper.config_entry,
    )

    state = await spray_level.poll_and_get_state()
    assert state.state == "1"
    assert state.attributes["step"] == 1
    assert state.attributes["min"] == 1
    assert state.attributes["max"] == 5

    state = await spray_level.async_update(
        ServicesTypes.OUTLET,
        {CharacteristicsTypes.VENDOR_VOCOLINC_HUMIDIFIER_SPRAY_LEVEL: 5},
    )
    assert state.state == "5"


async def test_write_number(
    hass: HomeAssistant, get_next_aid: Callable[[], int]
) -> None:
    """Test a switch service that has a sensor characteristic is correctly handled."""
    helper = await setup_test_component(
        hass, get_next_aid(), create_switch_with_spray_level
    )

    # Helper will be for the primary entity, which is the outlet. Make a helper for the
    # sensor.
    spray_level = Helper(
        hass,
        "number.testdevice_spray_quantity",
        helper.pairing,
        helper.accessory,
        helper.config_entry,
    )

    await hass.services.async_call(
        "number",
        "set_value",
        {"entity_id": "number.testdevice_spray_quantity", "value": 5},
        blocking=True,
    )
    spray_level.async_assert_service_values(
        ServicesTypes.OUTLET,
        {CharacteristicsTypes.VENDOR_VOCOLINC_HUMIDIFIER_SPRAY_LEVEL: 5},
    )

    await hass.services.async_call(
        "number",
        "set_value",
        {"entity_id": "number.testdevice_spray_quantity", "value": 3},
        blocking=True,
    )
    spray_level.async_assert_service_values(
        ServicesTypes.OUTLET,
        {CharacteristicsTypes.VENDOR_VOCOLINC_HUMIDIFIER_SPRAY_LEVEL: 3},
    )


async def test_valve_set_duration_number(
    hass: HomeAssistant,
    get_next_aid: Callable[[], int],
) -> None:
    """Test a valve service set duration characteristic is correctly handled."""
    helper = await setup_test_component(
        hass, get_next_aid(), create_valve_with_set_duration
    )

    set_duration = Helper(
        hass,
        "number.testdevice_duration",
        helper.pairing,
        helper.accessory,
        helper.config_entry,
    )

    state = await set_duration.poll_and_get_state()
    assert state.state == "1200"
    assert state.attributes["device_class"] == NumberDeviceClass.DURATION
    assert state.attributes["unit_of_measurement"] == UnitOfTime.SECONDS
    assert state.attributes["step"] == 60
    assert state.attributes["min"] == 0
    assert state.attributes["max"] == 5400

    state = await set_duration.async_update(
        ServicesTypes.VALVE,
        {CharacteristicsTypes.SET_DURATION: 1800},
    )
    assert state.state == "1800"

    await hass.services.async_call(
        "number",
        "set_value",
        {"entity_id": "number.testdevice_duration", "value": 600},
        blocking=True,
    )
    set_duration.async_assert_service_values(
        ServicesTypes.VALVE,
        {CharacteristicsTypes.SET_DURATION: 600},
    )