Add create and delete services for input number helpers

Author: potelux

custom_components/spook/ectoplasms/input_number/services/create.py

@@ -0,0 +1,74 @@
+"""Spook - Your homie."""
+
+from __future__ import annotations
+
+import asyncio
+from typing import TYPE_CHECKING
+
+import voluptuous as vol
+
+from homeassistant.components.input_number import (
+    CONF_INITIAL,
+    CONF_MAX,
+    CONF_MIN,
+    CONF_STEP,
+    DOMAIN,
+    MODE_BOX,
+    MODE_SLIDER,
+    NumberStorageCollection,
+    _cv_input_number,
+)
+from homeassistant.const import CONF_ICON, CONF_MODE, CONF_NAME, CONF_UNIT_OF_MEASUREMENT
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import config_validation as cv
+
+from ....services import AbstractSpookAdminService
+
+if TYPE_CHECKING:
+    from homeassistant.core import ServiceCall
+
+CONF_OBJECT_ID = "object_id"
+
+CREATE_FIELDS = {
+    vol.Required(CONF_NAME): vol.All(str, vol.Length(min=1)),
+    vol.Optional(CONF_OBJECT_ID): cv.slug,
+    vol.Optional(CONF_MIN, default=0): vol.Coerce(float),
+    vol.Optional(CONF_MAX, default=100): vol.Coerce(float),
+    vol.Optional(CONF_INITIAL): vol.Coerce(float),
+    vol.Optional(CONF_STEP, default=1): vol.All(vol.Coerce(float), vol.Range(min=1e-9)),
+    vol.Optional(CONF_ICON): cv.icon,
+    vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
+    vol.Optional(CONF_MODE, default=MODE_SLIDER): vol.In([MODE_SLIDER, MODE_BOX]),
+}
+
+
+class SpookService(AbstractSpookAdminService):
+    """Input number service to create a new helper on the fly."""
+
+    domain = DOMAIN
+    service = "create"
+    schema = vol.All(vol.Schema(CREATE_FIELDS), _cv_input_number)
+
+    async def async_handle_service(self, call: ServiceCall) -> None:
+        """Handle the service call."""
+        object_id = call.data.get(CONF_OBJECT_ID)
+        data = {k: v for k, v in call.data.items() if k != CONF_OBJECT_ID}
+
+        collection: NumberStorageCollection = self.hass.data["websocket_api"][
+            "input_number/list"
+        ][0].__self__.storage_collection
+
+        if object_id:
+            async with self.hass.data.setdefault(
+                f"{DOMAIN}_create_lock", asyncio.Lock()
+            ):
+                if collection.id_manager.has_id(object_id):
+                    message = f"An input number with object ID '{object_id}' already exists"
+                    raise HomeAssistantError(message)
+                collection._get_suggested_id = lambda info: object_id  # noqa: SLF001
+                try:
+                    await collection.async_create_item(data)
+                finally:
+                    del collection._get_suggested_id  # noqa: SLF001
+        else:
+            await collection.async_create_item(data)

custom_components/spook/ectoplasms/input_number/services/delete.py

@@ -0,0 +1,40 @@
+"""Spook - Your homie."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from homeassistant.components.input_number import (
+    DOMAIN,
+    InputNumber,
+    NumberStorageCollection,
+)
+from homeassistant.exceptions import HomeAssistantError
+
+from ....services import AbstractSpookEntityComponentService
+
+if TYPE_CHECKING:
+    from homeassistant.core import ServiceCall
+
+
+class SpookService(AbstractSpookEntityComponentService[InputNumber]):
+    """Input number service to delete a helper on the fly."""
+
+    domain = DOMAIN
+    service = "delete"
+    schema = {}
+
+    async def async_handle_service(
+        self,
+        entity: InputNumber,
+        call: ServiceCall,
+    ) -> None:
+        """Handle the service call."""
+        if not entity.editable:
+            message = f"This input number is not editable: {entity.entity_id}"
+            raise HomeAssistantError(message)
+
+        collection: NumberStorageCollection = self.hass.data["websocket_api"][
+            "input_number/list"
+        ][0].__self__.storage_collection
+        await collection.async_delete_item(entity.unique_id)

custom_components/spook/services.yaml

@@ -956,6 +956,97 @@ input_number_min:
     entity:
       domain: input_number
 
+input_number_create:
+  name: Create an input number 👻
+  description: >-
+    Create a new input number helper on the fly.
+  fields:
+    name:
+      name: Name
+      description: The name of the new input number helper.
+      required: true
+      selector:
+        text:
+    object_id:
+      name: Object ID
+      description: >-
+        The object ID for the new input number helper. If not provided, the
+        object ID will be generated based on the name.
+      required: false
+      selector:
+        text:
+    min:
+      name: Minimum
+      description: The minimum value of the input number.
+      required: false
+      default: 0
+      selector:
+        number:
+          mode: box
+          step: any
+    max:
+      name: Maximum
+      description: The maximum value of the input number.
+      required: false
+      default: 100
+      selector:
+        number:
+          mode: box
+          step: any
+    initial:
+      name: Initial value
+      description: The initial value of the input number when Home Assistant starts.
+      required: false
+      selector:
+        number:
+          mode: box
+          step: any
+    step:
+      name: Step size
+      description: The step size of the input number.
+      required: false
+      default: 1
+      selector:
+        number:
+          mode: box
+          step: any
+    mode:
+      name: Display mode
+      description: >-
+        The display mode of the input number, which can be either a slider or
+        an input box.
+      required: false
+      default: slider
+      selector:
+        select:
+          options:
+            - label: Slider
+              value: slider
+            - label: Input field
+              value: box
+    icon:
+      name: Icon
+      description: The icon to use for the input number helper.
+      required: false
+      selector:
+        icon:
+    unit_of_measurement:
+      name: Unit of measurement
+      description: The unit of measurement of the input number.
+      required: false
+      selector:
+        text:
+
+input_number_delete:
+  name: Delete an input number 👻
+  description: >-
+    Delete an input number helper. This works only with input numbers created
+    and managed via the UI. Input numbers created and managed in YAML cannot
+    be managed by Spook.
+  target:
+    entity:
+      domain: input_number
+
 person_add_device_tracker:
   name: Add a device tracker 👻
   description: >-