Implement camera toggle (#868)

* Add support for enabling / disabling camera

* Add test

* Include version

* Formatting

* Format tests

Author: NickM-27

custom_components/frigate/camera.py

@@ -217,6 +217,9 @@ def __init__(
         self._attr_motion_detection_enabled = self._camera_config.get("motion", {}).get(
             "enabled"
         )
+        self._turn_on_off_topic = (
+            f"{frigate_config['mqtt']['topic_prefix']}" f"/{self._cam_name}/enabled/set"
+        )
         self._ptz_topic = (
             f"{frigate_config['mqtt']['topic_prefix']}" f"/{self._cam_name}/ptz"
         )
@@ -327,6 +330,28 @@ async def stream_source(self) -> str | None:
         """Return the source of the stream."""
         return self._stream_source
 
+    async def async_turn_on(self) -> None:
+        """Turn on the camera."""
+        if self._frigate_config.get("version", "0.14") >= "0.16":
+            await async_publish(
+                self.hass,
+                self._turn_on_off_topic,
+                "ON",
+                0,
+                False,
+            )
+
+    async def async_turn_off(self) -> None:
+        """Turn off the camera."""
+        if self._frigate_config.get("version", "0.14") >= "0.16":
+            await async_publish(
+                self.hass,
+                self._turn_on_off_topic,
+                "OFF",
+                0,
+                False,
+            )
+
     async def async_enable_motion_detection(self) -> None:
         """Enable motion detection for this camera."""
         await async_publish(

tests/__init__.py

@@ -79,6 +79,7 @@
 TEST_PASSWORD = "secret_password"
 TEST_FRIGATE_INSTANCE_ID = "frigate_client_id"
 TEST_CONFIG = {
+    "version": "0.16-0",
     "cameras": {
         "front_door": {
             "best_image_timeout": 60,

tests/test_camera.py

@@ -39,6 +39,8 @@
     DOMAIN as CAMERA_DOMAIN,
     SERVICE_DISABLE_MOTION,
     SERVICE_ENABLE_MOTION,
+    SERVICE_TURN_OFF,
+    SERVICE_TURN_ON,
     StreamType,
     async_get_image,
     async_get_stream_source,
@@ -446,6 +448,60 @@ async def test_camera_device_info(hass: HomeAssistant) -> None:
     assert TEST_CAMERA_FRONT_DOOR_ENTITY_ID in entities_from_device
 
 
+async def test_camera_enable_camera(hass: HomeAssistant, mqtt_mock: Any) -> None:
+    """Test built in camera toggle."""
+
+    await setup_mock_frigate_config_entry(hass)
+
+    entity_state = hass.states.get(TEST_CAMERA_FRONT_DOOR_ENTITY_ID)
+    assert entity_state
+    assert entity_state.state == "streaming"
+    assert entity_state.attributes["supported_features"] == 2
+
+    async_fire_mqtt_message(hass, "frigate/front_door/enabled/state", "ON")
+    await hass.async_block_till_done()
+
+    entity_state = hass.states.get(TEST_CAMERA_FRONT_DOOR_ENTITY_ID)
+    assert entity_state
+
+    await hass.services.async_call(
+        CAMERA_DOMAIN,
+        SERVICE_TURN_ON,
+        {ATTR_ENTITY_ID: TEST_CAMERA_FRONT_DOOR_ENTITY_ID},
+        blocking=True,
+    )
+    mqtt_mock.async_publish.assert_called_once_with(
+        "frigate/front_door/enabled/set", "ON", 0, False
+    )
+
+
+async def test_camera_disable_camera(hass: HomeAssistant, mqtt_mock: Any) -> None:
+    """Test built in camera toggle."""
+
+    await setup_mock_frigate_config_entry(hass)
+
+    entity_state = hass.states.get(TEST_CAMERA_FRONT_DOOR_ENTITY_ID)
+    assert entity_state
+    assert entity_state.state == "streaming"
+    assert entity_state.attributes["supported_features"] == 2
+
+    async_fire_mqtt_message(hass, "frigate/front_door/enabled/state", "OFF")
+    await hass.async_block_till_done()
+
+    entity_state = hass.states.get(TEST_CAMERA_FRONT_DOOR_ENTITY_ID)
+    assert entity_state
+
+    await hass.services.async_call(
+        CAMERA_DOMAIN,
+        SERVICE_TURN_OFF,
+        {ATTR_ENTITY_ID: TEST_CAMERA_FRONT_DOOR_ENTITY_ID},
+        blocking=True,
+    )
+    mqtt_mock.async_publish.assert_called_once_with(
+        "frigate/front_door/enabled/set", "OFF", 0, False
+    )
+
+
 async def test_camera_enable_motion_detection(
     hass: HomeAssistant, mqtt_mock: Any
 ) -> None: