Add device actions for Number (#44240)

homeassistant/components/number/device_action.py

@@ -0,0 +1,82 @@
+"""Provides device actions for Number."""
+from typing import Any, Dict, List, Optional
+
+import voluptuous as vol
+
+from homeassistant.const import (
+    ATTR_ENTITY_ID,
+    CONF_DEVICE_ID,
+    CONF_DOMAIN,
+    CONF_ENTITY_ID,
+    CONF_TYPE,
+)
+from homeassistant.core import Context, HomeAssistant
+from homeassistant.helpers import entity_registry
+import homeassistant.helpers.config_validation as cv
+
+from . import DOMAIN, const
+
+ATYP_SET_VALUE = "set_value"
+
+ACTION_SCHEMA = cv.DEVICE_ACTION_BASE_SCHEMA.extend(
+    {
+        vol.Required(CONF_TYPE): ATYP_SET_VALUE,
+        vol.Required(CONF_ENTITY_ID): cv.entity_domain(DOMAIN),
+        vol.Required(const.ATTR_VALUE): vol.Coerce(float),
+    }
+)
+
+
+async def async_get_actions(hass: HomeAssistant, device_id: str) -> List[dict]:
+    """List device actions for Number."""
+    registry = await entity_registry.async_get_registry(hass)
+    actions: List[Dict[str, Any]] = []
+
+    # Get all the integrations entities for this device
+    for entry in entity_registry.async_entries_for_device(registry, device_id):
+        if entry.domain != DOMAIN:
+            continue
+
+        actions.append(
+            {
+                CONF_DEVICE_ID: device_id,
+                CONF_DOMAIN: DOMAIN,
+                CONF_ENTITY_ID: entry.entity_id,
+                CONF_TYPE: ATYP_SET_VALUE,
+            }
+        )
+
+    return actions
+
+
+async def async_call_action_from_config(
+    hass: HomeAssistant, config: dict, variables: dict, context: Optional[Context]
+) -> None:
+    """Execute a device action."""
+    config = ACTION_SCHEMA(config)
+
+    if config[CONF_TYPE] != ATYP_SET_VALUE:
+        return
+
+    await hass.services.async_call(
+        DOMAIN,
+        const.SERVICE_SET_VALUE,
+        {
+            ATTR_ENTITY_ID: config[CONF_ENTITY_ID],
+            const.ATTR_VALUE: config[const.ATTR_VALUE],
+        },
+        blocking=True,
+        context=context,
+    )
+
+
+async def async_get_action_capabilities(hass: HomeAssistant, config: dict) -> dict:
+    """List action capabilities."""
+    action_type = config[CONF_TYPE]
+
+    if action_type != ATYP_SET_VALUE:
+        return {}
+
+    fields = {vol.Required(const.ATTR_VALUE): vol.Coerce(float)}
+
+    return {"extra_fields": vol.Schema(fields)}

homeassistant/components/number/strings.json

@@ -0,0 +1,8 @@
+{
+  "title": "Number",
+  "device_automation": {
+    "action_type": {
+      "set_value": "Set value for {entity_name}"
+    }
+  }
+}

tests/components/number/test_device_action.py

@@ -0,0 +1,128 @@
+"""The tests for Number device actions."""
+import pytest
+import voluptuous_serialize
+
+import homeassistant.components.automation as automation
+from homeassistant.components.number import DOMAIN, device_action
+from homeassistant.helpers import config_validation as cv, device_registry
+from homeassistant.setup import async_setup_component
+
+from tests.common import (
+    MockConfigEntry,
+    assert_lists_same,
+    async_get_device_automations,
+    async_mock_service,
+    mock_device_registry,
+    mock_registry,
+)
+from tests.components.blueprint.conftest import stub_blueprint_populate  # noqa
+
+
+@pytest.fixture
+def device_reg(hass):
+    """Return an empty, loaded, registry."""
+    return mock_device_registry(hass)
+
+
+@pytest.fixture
+def entity_reg(hass):
+    """Return an empty, loaded, registry."""
+    return mock_registry(hass)
+
+
+async def test_get_actions(hass, device_reg, entity_reg):
+    """Test we get the expected actions for an entity."""
+    config_entry = MockConfigEntry(domain="test", data={})
+    config_entry.add_to_hass(hass)
+    device_entry = device_reg.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
+    )
+    entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
+    hass.states.async_set("number.test_5678", 0.5, {"min_value": 0.0, "max_value": 1.0})
+    expected_actions = [
+        {
+            "domain": DOMAIN,
+            "type": "set_value",
+            "device_id": device_entry.id,
+            "entity_id": "number.test_5678",
+        },
+    ]
+    actions = await async_get_device_automations(hass, "action", device_entry.id)
+    assert_lists_same(actions, expected_actions)
+
+
+async def test_get_action_no_state(hass, device_reg, entity_reg):
+    """Test we get the expected actions for an entity."""
+    config_entry = MockConfigEntry(domain="test", data={})
+    config_entry.add_to_hass(hass)
+    device_entry = device_reg.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
+    )
+    entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
+    expected_actions = [
+        {
+            "domain": DOMAIN,
+            "type": "set_value",
+            "device_id": device_entry.id,
+            "entity_id": "number.test_5678",
+        },
+    ]
+    actions = await async_get_device_automations(hass, "action", device_entry.id)
+    assert_lists_same(actions, expected_actions)
+
+
+async def test_action(hass):
+    """Test for actions."""
+    hass.states.async_set("number.entity", 0.5, {"min_value": 0.0, "max_value": 1.0})
+
+    assert await async_setup_component(
+        hass,
+        automation.DOMAIN,
+        {
+            automation.DOMAIN: [
+                {
+                    "trigger": {
+                        "platform": "event",
+                        "event_type": "test_event_set_value",
+                    },
+                    "action": {
+                        "domain": DOMAIN,
+                        "device_id": "abcdefgh",
+                        "entity_id": "number.entity",
+                        "type": "set_value",
+                        "value": 0.3,
+                    },
+                },
+            ]
+        },
+    )
+
+    calls = async_mock_service(hass, DOMAIN, "set_value")
+
+    assert len(calls) == 0
+
+    hass.bus.async_fire("test_event_set_value")
+    await hass.async_block_till_done()
+
+    assert len(calls) == 1
+
+
+async def test_capabilities(hass):
+    """Test getting capabilities."""
+    capabilities = await device_action.async_get_action_capabilities(
+        hass,
+        {
+            "domain": DOMAIN,
+            "device_id": "abcdefgh",
+            "entity_id": "number.entity",
+            "type": "set_value",
+        },
+    )
+
+    assert capabilities and "extra_fields" in capabilities
+
+    assert voluptuous_serialize.convert(
+        capabilities["extra_fields"], custom_serializer=cv.custom_serializer
+    ) == [{"name": "value", "required": True, "type": "float"}]