Fix setting random value for custom capability with no range parameter (#613)

Author: dext0r

custom_components/yandex_smart_home/capability_custom.py

@@ -268,10 +268,6 @@ def supported(self) -> bool:
     @property
     def support_random_access(self) -> bool:
         """Test if the capability accept arbitrary values to be set."""
-        for key in [CONF_ENTITY_RANGE_MIN, CONF_ENTITY_RANGE_MAX]:
-            if key not in self._config.get(CONF_ENTITY_RANGE, {}):
-                return False
-
         return self._set_value_service_config is not None
 
     async def set_instance_state(self, context: Context, state: RangeCapabilityInstanceActionState) -> None:
@@ -329,17 +325,27 @@ def _get_absolute_value(self, relative_value: float) -> float:
 
             raise APIError(ResponseCode.NOT_SUPPORTED_IN_CURRENT_MODE, f"Missing current value for {self}")
 
+        if not self._range:
+            return value + relative_value
+
         return max(min(value + relative_value, self._range.max), self._range.min)
 
     @cached_property
-    def _range(self) -> RangeCapabilityRange:
+    def _range(self) -> RangeCapabilityRange | None:
         """Return supporting value range."""
+        instance_default_range = super()._range
+        range_config = self._config.get(CONF_ENTITY_RANGE, {})
+
+        if not range_config:
+            if instance_default_range:
+                return instance_default_range
+
+            return None
+
         return RangeCapabilityRange(
-            min=self._config.get(CONF_ENTITY_RANGE, {}).get(CONF_ENTITY_RANGE_MIN, super()._range.min),
-            max=self._config.get(CONF_ENTITY_RANGE, {}).get(CONF_ENTITY_RANGE_MAX, super()._range.max),
-            precision=self._config.get(CONF_ENTITY_RANGE, {}).get(
-                CONF_ENTITY_RANGE_PRECISION, super()._range.precision
-            ),
+            min=range_config.get(CONF_ENTITY_RANGE_MIN, 0),
+            max=range_config.get(CONF_ENTITY_RANGE_MAX, 100),
+            precision=range_config.get(CONF_ENTITY_RANGE_PRECISION, 1),
         )
 
     @property

custom_components/yandex_smart_home/capability_range.py

@@ -90,26 +90,23 @@ def retrievable(self) -> bool:
     @property
     def parameters(self) -> RangeCapabilityParameters:
         """Return parameters for a devices list request."""
-        if self.support_random_access:
-            return RangeCapabilityParameters(instance=self.instance, random_access=True, range=self._range)
-
-        if self.instance in [
+        if self.instance in (
             RangeCapabilityInstance.BRIGHTNESS,
             RangeCapabilityInstance.HUMIDITY,
             RangeCapabilityInstance.OPEN,
             RangeCapabilityInstance.TEMPERATURE,
-        ]:
+        ) or (self._range and self.support_random_access):
             return RangeCapabilityParameters(
                 instance=self.instance, random_access=self.support_random_access, range=self._range
             )
 
-        return RangeCapabilityParameters(instance=self.instance, random_access=False)
+        return RangeCapabilityParameters(instance=self.instance, random_access=self.support_random_access)
 
     def get_value(self) -> float | None:
         """Return the current capability value."""
         value = self._get_value()
 
-        if self.support_random_access and value is not None:
+        if self.support_random_access and value is not None and self._range:
             if not (self._range.min <= value <= self._range.max):
                 _LOGGER.debug(
                     f"Value {value} is not in range {self._range} for instance {self.instance.value} "
@@ -137,9 +134,15 @@ def _get_service_call_value(self, state: RangeCapabilityInstanceActionState) ->
         return state.value
 
     @cached_property
-    def _range(self) -> RangeCapabilityRange:
+    def _range(self) -> RangeCapabilityRange | None:
         """Return supporting value range."""
-        return RangeCapabilityRange(min=0, max=100, precision=1)
+        match self.instance:
+            case RangeCapabilityInstance.HUMIDITY | RangeCapabilityInstance.OPEN | RangeCapabilityInstance.TEMPERATURE:
+                return RangeCapabilityRange(min=0, max=100, precision=1)
+            case RangeCapabilityInstance.BRIGHTNESS:
+                return RangeCapabilityRange(min=1, max=100, precision=1)
+
+        return None
 
     def _convert_to_float(self, value: Any, strict: bool = True) -> float | None:
         """Return float of a value, ignore some states, catch errors."""
@@ -168,6 +171,9 @@ def _get_absolute_value(self, relative_value: float) -> float:
 
             raise APIError(ResponseCode.NOT_SUPPORTED_IN_CURRENT_MODE, f"Missing current value for {self}")
 
+        if not self._range:
+            return value + relative_value
+
         return max(min(value + relative_value, self._range.max), self._range.min)
 
 
@@ -390,11 +396,6 @@ def _get_value(self) -> float | None:
 
         return None
 
-    @cached_property
-    def _range(self) -> RangeCapabilityRange:
-        """Return supporting value range."""
-        return RangeCapabilityRange(min=1, max=100, precision=1)
-
 
 class WhiteLightBrightnessCapability(StateRangeCapability, LightState):
     """Capability to control white brightness and cold white brightness of a RGBW/RGBWW light device."""
@@ -692,11 +693,7 @@ def _get_value(self) -> float | None:
     @cached_property
     def _range(self) -> RangeCapabilityRange:
         """Return supporting value range."""
-        return RangeCapabilityRange(
-            min=0,
-            max=999,
-            precision=1,
-        )
+        return RangeCapabilityRange(min=0, max=999, precision=1)
 
 
 class ValvePositionCapability(StateRangeCapability):

custom_components/yandex_smart_home/schema/capability_range.py

@@ -70,15 +70,25 @@ def compute_unit(cls, values: dict[str, Any]) -> dict[str, Any]:
     def validate_range(cls, values: dict[str, Any]) -> dict[str, Any]:
         """Force range boundaries for a capability instance."""
 
-        r: RangeCapabilityRange | None
-        if r := values.get("range"):
-            match values.get("instance"):
+        instance: RangeCapabilityInstance | None = values.get("instance")
+        r: RangeCapabilityRange | None = values.get("range")
+
+        if r:
+            match instance:
                 case RangeCapabilityInstance.HUMIDITY | RangeCapabilityInstance.OPEN:
                     r.min, r.max = max([0.0, r.min]), min([100.0, r.max])
                 case RangeCapabilityInstance.BRIGHTNESS:
                     r.min = max(min(r.min, 1.0), 0.0)
                     r.max = 100.0
                     r.precision = 1.0
+        else:
+            if instance in (
+                RangeCapabilityInstance.BRIGHTNESS,
+                RangeCapabilityInstance.HUMIDITY,
+                RangeCapabilityInstance.OPEN,
+                RangeCapabilityInstance.TEMPERATURE,
+            ):
+                raise ValueError(f"range field required for {instance}")
 
         return values
 

docs/advanced/capabilities/range.md

@@ -3,7 +3,7 @@
 
 ## Параметры { id=settings }
 
-* `set_value`: Действие выполняемое при установке абсолютного значения функции. В переменной `value` абсолютное или относительное значение (в зависимости от настроек `range` и наличия `increase_value` и `decrease_value`).
+* `set_value`: Действие, выполняемое при установке абсолютного значения функции ("Алиса, температура Х").
 Если не задано - установка абсолютного значения поддерживаться не будет.
 
     !!! example "Пример"
@@ -16,8 +16,8 @@
         ```
 
 * `increase_value` и `decrease_value`: Действия, вызываемые при относительной регулировке (кнопки `+` и `-` и "Алиса, убавь температуру"). Если не заданы - будет вызываться действие `set_value`.
-* `range`: Граничные значения диапазона. Для `humidity`, `open`, `brightness` есть ограничение: минимум `0`, максимум `100`.
-  Если не задать `min` и `max` регулировка будет только относительная (в переменной `value` - `1` или `-1`).
+* `range`: Допустимый диапазон, в котором может лежать значение функции. Для `humidity`, `open`, `brightness` есть ограничение: минимум `0`, максимум `100`.
+  Параметр является необязательным, его наличие влияет на визуальный стиль элемента управления в приложении и поведение команд убавь/прибавь.
 
     !!! example "Пример"
         ```yaml

tests/test_capability_custom.py

@@ -542,7 +542,9 @@ async def test_capability_custom_toggle(hass: HomeAssistant, entry_data: MockCon
         assert cap.new_with_value(v3).get_value() is False
 
 
-async def test_capability_custom_range_random_access(hass: HomeAssistant, entry_data: MockConfigEntryData) -> None:
+async def test_capability_custom_range_random_access_with_range(
+    hass: HomeAssistant, entry_data: MockConfigEntryData
+) -> None:
     state = State("switch.test", "30", {})
     hass.states.async_set(state.entity_id, state.state)
     cap = cast(
@@ -566,14 +568,19 @@ async def test_capability_custom_range_random_access(hass: HomeAssistant, entry_
                 ),
             },
             CapabilityType.RANGE,
-            RangeCapabilityInstance.OPEN,
+            RangeCapabilityInstance.VOLUME,
             "foo",
         ),
     )
     assert cap.supported is True
     assert cap.retrievable is True
     assert cap.reportable is True
     assert cap.support_random_access is True
+    assert cap.parameters.as_dict() == {
+        "instance": "volume",
+        "random_access": True,
+        "range": {"min": 10, "max": 50, "precision": 3},
+    }
     assert cap.get_value() == 30
 
     for v in ["55", "5"]:
@@ -586,7 +593,7 @@ async def test_capability_custom_range_random_access(hass: HomeAssistant, entry_
     for value, relative in ((40, False), (100, False), (10, True), (-3, True), (-50, True)):
         await cap.set_instance_state(
             Context(),
-            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.OPEN, value=value, relative=relative),
+            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.VOLUME, value=value, relative=relative),
         )
 
     assert len(calls) == 5
@@ -606,7 +613,7 @@ async def test_capability_custom_range_random_access(hass: HomeAssistant, entry_
     with pytest.raises(APIError) as e:
         await cap.set_instance_state(
             Context(),
-            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.OPEN, value=10, relative=True),
+            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.VOLUME, value=10, relative=True),
         )
     assert e.value.code == ResponseCode.DEVICE_OFF
     assert e.value.message == "Device switch.test probably turned off"
@@ -615,21 +622,81 @@ async def test_capability_custom_range_random_access(hass: HomeAssistant, entry_
     with pytest.raises(APIError) as e:
         await cap.set_instance_state(
             Context(),
-            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.OPEN, value=10, relative=True),
+            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.VOLUME, value=10, relative=True),
         )
     assert e.value.code == ResponseCode.NOT_SUPPORTED_IN_CURRENT_MODE
-    assert e.value.message == "Missing current value for instance open of range capability of foo"
+    assert e.value.message == "Missing current value for instance volume of range capability of foo"
 
     hass.states.async_remove(state.entity_id)
     with pytest.raises(APIError) as e:
         await cap.set_instance_state(
             Context(),
-            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.OPEN, value=10, relative=True),
+            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.VOLUME, value=10, relative=True),
         )
     assert e.value.code == ResponseCode.DEVICE_OFF
     assert e.value.message == "Entity switch.test not found"
 
 
+async def test_capability_custom_range_random_access_no_range(
+    hass: HomeAssistant, entry_data: MockConfigEntryData
+) -> None:
+    state = State("switch.test", "30", {})
+    hass.states.async_set(state.entity_id, state.state)
+    cap = cast(
+        CustomRangeCapability,
+        get_custom_capability(
+            hass,
+            entry_data,
+            {
+                CONF_ENTITY_CUSTOM_CAPABILITY_STATE_ENTITY_ID: state.entity_id,
+                CONF_ENTITY_CUSTOM_RANGE_SET_VALUE: SERVICE_SCHEMA(
+                    {
+                        CONF_SERVICE: "test.set_value",
+                        ATTR_ENTITY_ID: "input_number.test",
+                        CONF_SERVICE_DATA: {"value": dynamic_template("value: {{ value|int }}")},
+                    }
+                ),
+            },
+            CapabilityType.RANGE,
+            RangeCapabilityInstance.VOLUME,
+            "foo",
+        ),
+    )
+    assert cap.supported is True
+    assert cap.retrievable is True
+    assert cap.reportable is True
+    assert cap.support_random_access is True
+    assert cap.parameters.as_dict() == {
+        "instance": "volume",
+        "random_access": True,
+    }
+    assert cap.get_value() == 30
+
+    for v in [55, 5]:
+        hass.states.async_set(state.entity_id, str(v))
+        assert cap.get_value() == v
+
+    hass.states.async_set(state.entity_id, "30")
+
+    calls = async_mock_service(hass, "test", "set_value")
+    for value, relative in ((40, False), (100, False), (10, True), (-3, True), (-50, True), (100, True)):
+        await cap.set_instance_state(
+            Context(),
+            RangeCapabilityInstanceActionState(instance=RangeCapabilityInstance.VOLUME, value=value, relative=relative),
+        )
+
+    assert len(calls) == 6
+    for i in range(0, len(calls)):
+        assert calls[i].data[ATTR_ENTITY_ID] == ["input_number.test"]
+
+    assert calls[0].data["value"] == "value: 40"
+    assert calls[1].data["value"] == "value: 100"
+    assert calls[2].data["value"] == "value: 40"
+    assert calls[3].data["value"] == "value: 27"
+    assert calls[4].data["value"] == "value: -20"
+    assert calls[5].data["value"] == "value: 130"
+
+
 async def test_capability_custom_range_random_access_no_state(
     hass: HomeAssistant, entry_data: MockConfigEntryData
 ) -> None:
@@ -664,6 +731,12 @@ async def test_capability_custom_range_random_access_no_state(
     assert cap.retrievable is False
     assert cap.reportable is False
     assert cap.support_random_access is True
+    assert cap.parameters.as_dict() == {
+        "instance": "open",
+        "random_access": True,
+        "range": {"min": 10, "max": 50, "precision": 3},
+        "unit": "unit.percent",
+    }
     assert cap.get_value() is None
 
     calls = async_mock_service(hass, "test", "set_value")
@@ -865,7 +938,7 @@ async def test_capability_custom_range_no_service(hass: HomeAssistant, entry_dat
         [RangeCapabilityInstance.OPEN, (-10, 150), (0, 100)],
     ],
 )
-async def test_capability_custom_range_parameters_range(
+async def test_capability_custom_range_limits(
     hass: HomeAssistant,
     entry_data: MockConfigEntryData,
     instance: RangeCapabilityInstance,
@@ -892,3 +965,38 @@ async def test_capability_custom_range_parameters_range(
     assert cap.supported is True
     assert cap.parameters.range
     assert (cap.parameters.range.min, cap.parameters.range.max) == expected_range
+
+
+@pytest.mark.parametrize(
+    "instance,range_expected",
+    [
+        (RangeCapabilityInstance.BRIGHTNESS, True),
+        (RangeCapabilityInstance.CHANNEL, False),
+        (RangeCapabilityInstance.HUMIDITY, True),
+        (RangeCapabilityInstance.OPEN, True),
+        (RangeCapabilityInstance.TEMPERATURE, True),
+        (RangeCapabilityInstance.VOLUME, False),
+    ],
+)
+async def test_capability_custom_range_requirement(
+    hass: HomeAssistant,
+    entry_data: MockConfigEntryData,
+    instance: RangeCapabilityInstance,
+    range_expected: bool,
+) -> None:
+    cap = cast(
+        CustomRangeCapability,
+        get_custom_capability(
+            hass,
+            entry_data,
+            {},
+            CapabilityType.RANGE,
+            instance,
+            "foo",
+        ),
+    )
+    assert cap.supported is True
+    if range_expected:
+        assert cap.parameters.range is not None
+    else:
+        assert cap.parameters.range is None