Add Reolink IO input binary sensor (home-assistant#154133)

Author: starkillerOG

homeassistant/components/reolink/binary_sensor.py

@@ -57,6 +57,17 @@ class ReolinkSmartAIBinarySensorEntityDescription(
     supported: Callable[[Host, int, int], bool] = lambda api, ch, loc: True
 
 
+@dataclass(frozen=True, kw_only=True)
+class ReolinkIndexBinarySensorEntityDescription(
+    BinarySensorEntityDescription,
+    ReolinkEntityDescription,
+):
+    """A class that describes binary sensor entities with an extra index."""
+
+    value: Callable[[Host, int, int], bool | None]
+    supported: Callable[[Host, int, int], bool] = lambda api, ch, idx: True
+
+
 BINARY_PUSH_SENSORS = (
     ReolinkBinarySensorEntityDescription(
         key="motion",
@@ -282,6 +293,13 @@ class ReolinkSmartAIBinarySensorEntityDescription(
     ),
 )
 
+BINARY_IO_INPUT_SENSOR = ReolinkIndexBinarySensorEntityDescription(
+    key="io_input",
+    cmd_id=677,
+    translation_key="io_input",
+    value=lambda api, ch, idx: api.baichuan.io_input_state(ch, idx),
+)
+
 
 async def async_setup_entry(
     hass: HomeAssistant,
@@ -292,7 +310,7 @@ async def async_setup_entry(
     reolink_data: ReolinkData = config_entry.runtime_data
     api = reolink_data.host.api
 
-    entities: list[ReolinkBinarySensorEntity | ReolinkSmartAIBinarySensorEntity] = []
+    entities: list[BinarySensorEntity] = []
     for channel in api.channels:
         entities.extend(
             ReolinkPushBinarySensorEntity(reolink_data, channel, entity_description)
@@ -314,6 +332,12 @@ async def async_setup_entry(
             )
             if entity_description.supported(api, channel, location)
         )
+        entities.extend(
+            ReolinkIndexBinarySensorEntity(
+                reolink_data, channel, index, BINARY_IO_INPUT_SENSOR
+            )
+            for index in api.baichuan.io_inputs(channel)
+        )
 
     async_add_entities(entities)
 
@@ -407,3 +431,31 @@ def is_on(self) -> bool:
         return self.entity_description.value(
             self._host.api, self._channel, self._location
         )
+
+
+class ReolinkIndexBinarySensorEntity(
+    ReolinkChannelCoordinatorEntity, BinarySensorEntity
+):
+    """Binary-sensor class for Reolink IP camera with an extra index."""
+
+    entity_description: ReolinkIndexBinarySensorEntityDescription
+
+    def __init__(
+        self,
+        reolink_data: ReolinkData,
+        channel: int,
+        index: int,
+        entity_description: ReolinkIndexBinarySensorEntityDescription,
+    ) -> None:
+        """Initialize Reolink binary sensor."""
+        self.entity_description = entity_description
+        super().__init__(reolink_data, channel)
+        self._attr_unique_id = f"{self._attr_unique_id}_{index}"
+
+        self._index = index
+        self._attr_translation_placeholders = {"index": str(index)}
+
+    @property
+    def is_on(self) -> bool | None:
+        """State of the sensor."""
+        return self.entity_description.value(self._host.api, self._channel, self._index)

homeassistant/components/reolink/icons.json

@@ -126,6 +126,12 @@
         "state": {
           "on": "mdi:package-variant-closed-check"
         }
+      },
+      "io_input": {
+        "default": "mdi:electric-switch",
+        "state": {
+          "on": "mdi:electric-switch-closed"
+        }
       }
     },
     "button": {

homeassistant/components/reolink/strings.json

@@ -427,6 +427,13 @@
           "off": "[%key:component::binary_sensor::entity_component::gas::state::off%]",
           "on": "[%key:component::binary_sensor::entity_component::gas::state::on%]"
         }
+      },
+      "io_input": {
+        "name": "IO input {index}",
+        "state": {
+          "off": "[%key:common::state::disconnected%]",
+          "on": "[%key:common::state::connected%]"
+        }
       }
     },
     "button": {

tests/components/reolink/test_binary_sensor.py

@@ -53,7 +53,6 @@ async def test_motion_sensor(
 
 async def test_smart_ai_sensor(
     hass: HomeAssistant,
-    hass_client_no_auth: ClientSessionGenerator,
     freezer: FrozenDateTimeFactory,
     config_entry: MockConfigEntry,
     reolink_host: MagicMock,
@@ -77,6 +76,31 @@ async def test_smart_ai_sensor(
     assert hass.states.get(entity_id).state == STATE_OFF
 
 
+async def test_index_sensor(
+    hass: HomeAssistant,
+    freezer: FrozenDateTimeFactory,
+    config_entry: MockConfigEntry,
+    reolink_host: MagicMock,
+) -> None:
+    """Test index binary sensor entity."""
+    reolink_host.baichuan.io_inputs.return_value = [0]
+    reolink_host.baichuan.io_input_state.return_value = True
+    with patch("homeassistant.components.reolink.PLATFORMS", [Platform.BINARY_SENSOR]):
+        assert await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+    assert config_entry.state is ConfigEntryState.LOADED
+
+    entity_id = f"{Platform.BINARY_SENSOR}.{TEST_CAM_NAME}_io_input_0"
+    assert hass.states.get(entity_id).state == STATE_ON
+
+    reolink_host.baichuan.io_input_state.return_value = False
+    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    async_fire_time_changed(hass)
+    await hass.async_block_till_done()
+
+    assert hass.states.get(entity_id).state == STATE_OFF
+
+
 async def test_tcp_callback(
     hass: HomeAssistant,
     config_entry: MockConfigEntry,