Merge pull request #776 from dermotduffy/rtmp

fix: Remove [old] `rtmp` support
blakeblackshear · Nov 24, 2024 · 6635bf5 · 6635bf5
2 parents 4019772 + 60888ed
commit 6635bf5
Show file tree

Hide file tree

Showing 16 changed files with 42 additions and 170 deletions.
diff --git a/custom_components/frigate/__init__.py b/custom_components/frigate/__init__.py
@@ -45,6 +45,7 @@
     ATTRIBUTE_LABELS,
     CONF_CAMERA_STATIC_IMAGE_HEIGHT,
     CONF_ENABLE_WEBRTC,
+    CONF_RTMP_URL_TEMPLATE,
     DOMAIN,
     FRIGATE_RELEASES_URL,
     FRIGATE_VERSION_ERROR_CUTOFF,
@@ -206,11 +207,11 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     except FrigateApiClientError as exc:
         raise ConfigEntryNotReady from exc
 
-    if AwesomeVersion(server_version.split("-")[0]) <= AwesomeVersion(
+    if AwesomeVersion(server_version.split("-")[0]) < AwesomeVersion(
         FRIGATE_VERSION_ERROR_CUTOFF
     ):
         _LOGGER.error(
-            "Using a Frigate server (%s) with version %s <= %s which is not "
+            "Using a Frigate server (%s) with version %s < %s which is not "
             "compatible -- you must upgrade: %s",
             entry.data[CONF_URL],
             server_version,
@@ -265,7 +266,11 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
             entity_registry.async_remove(entity_id)
 
     # Remove old options.
-    OLD_OPTIONS = [CONF_CAMERA_STATIC_IMAGE_HEIGHT, CONF_ENABLE_WEBRTC]
+    OLD_OPTIONS = [
+        CONF_CAMERA_STATIC_IMAGE_HEIGHT,
+        CONF_ENABLE_WEBRTC,
+        CONF_RTMP_URL_TEMPLATE,
+    ]
     if any(option in entry.options for option in OLD_OPTIONS):
         new_options = entry.options.copy()
         for option in OLD_OPTIONS:

diff --git a/custom_components/frigate/camera.py b/custom_components/frigate/camera.py
@@ -44,7 +44,6 @@
     ATTR_PTZ_ACTION,
     ATTR_PTZ_ARGUMENT,
     ATTR_START_TIME,
-    CONF_RTMP_URL_TEMPLATE,
     CONF_RTSP_URL_TEMPLATE,
     DEVICE_CLASS_CAMERA,
     DOMAIN,
@@ -174,11 +173,7 @@ def __init__(
         # from motion camera entities on selectors
         self._attr_device_class = DEVICE_CLASS_CAMERA
         self._stream_source = None
-        self._attr_is_streaming = (
-            self._camera_config.get("rtmp", {}).get("enabled")
-            or self._cam_name
-            in self._frigate_config.get("go2rtc", {}).get("streams", {}).keys()
-        )
+        self._attr_is_streaming = True
         self._attr_is_recording = self._camera_config.get("record", {}).get("enabled")
         self._attr_motion_detection_enabled = self._camera_config.get("motion", {}).get(
             "enabled"
@@ -210,23 +205,6 @@ def __init__(
                 self._stream_source = (
                     f"rtsp://{URL(self._url).host}:8554/{self._cam_name}"
                 )
-        elif self._camera_config.get("rtmp", {}).get("enabled"):
-            streaming_template = config_entry.options.get(
-                CONF_RTMP_URL_TEMPLATE, ""
-            ).strip()
-
-            if streaming_template:
-                # Can't use homeassistant.helpers.template as it requires hass which
-                # is not available in the constructor, so use direct jinja2
-                # template instead. This means templates cannot access HomeAssistant
-                # state, but rather only the camera config.
-                self._stream_source = Template(streaming_template).render(
-                    **self._camera_config
-                )
-            else:
-                self._stream_source = (
-                    f"rtmp://{URL(self._url).host}/live/{self._cam_name}"
-                )
 
     @callback
     def _state_message_received(self, msg: ReceiveMessage) -> None:
@@ -287,9 +265,6 @@ def extra_state_attributes(self) -> dict[str, str]:
     @property
     def supported_features(self) -> CameraEntityFeature:
         """Return supported features of this camera."""
-        if not self._attr_is_streaming:
-            return CameraEntityFeature(0)
-
         return CameraEntityFeature.STREAM
 
     async def async_camera_image(
@@ -310,8 +285,6 @@ async def async_camera_image(
 
     async def stream_source(self) -> str | None:
         """Return the source of the stream."""
-        if not self._attr_is_streaming:
-            return None
         return self._stream_source
 
     async def async_enable_motion_detection(self) -> None:

diff --git a/custom_components/frigate/config_flow.py b/custom_components/frigate/config_flow.py
@@ -20,7 +20,6 @@
     CONF_MEDIA_BROWSER_ENABLE,
     CONF_NOTIFICATION_PROXY_ENABLE,
     CONF_NOTIFICATION_PROXY_EXPIRE_AFTER_SECONDS,
-    CONF_RTMP_URL_TEMPLATE,
     CONF_RTSP_URL_TEMPLATE,
     DEFAULT_HOST,
     DOMAIN,
@@ -123,16 +122,6 @@ async def async_step_init(
             return self.async_abort(reason="only_advanced_options")
 
         schema: dict[Any, Any] = {
-            # The input URL is not validated as being a URL to allow for the
-            # possibility the template input won't be a valid URL until after
-            # it's rendered.
-            vol.Optional(
-                CONF_RTMP_URL_TEMPLATE,
-                default=self._config_entry.options.get(
-                    CONF_RTMP_URL_TEMPLATE,
-                    "",
-                ),
-            ): str,
             # The input URL is not validated as being a URL to allow for the
             # possibility the template input won't be a valid URL until after
             # it's rendered.

diff --git a/custom_components/frigate/const.py b/custom_components/frigate/const.py
@@ -3,7 +3,7 @@
 # Base component constants
 NAME = "Frigate"
 DOMAIN = "frigate"
-FRIGATE_VERSION_ERROR_CUTOFF = "0.12.1"
+FRIGATE_VERSION_ERROR_CUTOFF = "0.12.0"
 FRIGATE_RELEASES_URL = "https://github.com/blakeblackshear/frigate/releases"
 FRIGATE_RELEASE_TAG_URL = f"{FRIGATE_RELEASES_URL}/tag"
 
@@ -47,15 +47,17 @@
 ATTRIBUTE_LABELS = ["amazon", "face", "fedex", "license_plate", "ups"]
 
 # Configuration and options
-CONF_CAMERA_STATIC_IMAGE_HEIGHT = "camera_image_height"
 CONF_MEDIA_BROWSER_ENABLE = "media_browser_enable"
 CONF_NOTIFICATION_PROXY_ENABLE = "notification_proxy_enable"
+CONF_NOTIFICATION_PROXY_EXPIRE_AFTER_SECONDS = "notification_proxy_expire_after_seconds"
 CONF_PASSWORD = "password"
 CONF_PATH = "path"
-CONF_RTMP_URL_TEMPLATE = "rtmp_url_template"
 CONF_RTSP_URL_TEMPLATE = "rtsp_url_template"
+
+# Removed options
+CONF_CAMERA_STATIC_IMAGE_HEIGHT = "camera_image_height"
 CONF_ENABLE_WEBRTC = "enable_webrtc"
-CONF_NOTIFICATION_PROXY_EXPIRE_AFTER_SECONDS = "notification_proxy_expire_after_seconds"
+CONF_RTMP_URL_TEMPLATE = "rtmp_url_template"
 
 # Defaults
 DEFAULT_NAME = DOMAIN

diff --git a/custom_components/frigate/translations/ca.json b/custom_components/frigate/translations/ca.json
@@ -2,7 +2,7 @@
   "config": {
     "step": {
       "user": {
-        "description": "L'URL que utilitzeu per accedir a Frigate (p. ex. 'http://frigate:5000/')\\n\\nSi feu servir HassOS amb el complement, l'URL hauria de ser 'http://ccab4aaf-frigate:5000/' \\n\\nHome Assistant necessita accedir al port 5000 (api) i 1935 (rtmp) per a totes les funcions.\\n\\nLa integració configurarà sensors, càmeres i la funcionalitat del navegador multimèdia.\\n\\nSensors:\\n- Estadístiques per supervisar el rendiment de Frigate\\n- Recompte d'objectes per a totes les zones i càmeres\\n\\nCàmeres:\\n- Càmeres per a la imatge de l'últim objecte detectat per a cada càmera\\n- Entitats de càmera amb suport de transmissió (requereix RTMP)\\n\\nNavegador multimèdia:\\n - Interfície d'usuari enriquida amb miniatures per explorar clips d'esdeveniments\\n- Interfície d'usuari enriquida per navegar per enregistraments les 24 hores al dia, els set dies a la setmana, per mes, dia, càmera, hora\\n\\nAPI:\\n- API de notificació amb punts de connexió públics per a imatges a les notificacions.",
+        "description": "L'URL que utilitzeu per accedir a Frigate (p. ex. 'http://frigate:5000/')\\n\\nSi feu servir HassOS amb el complement, l'URL hauria de ser 'http://ccab4aaf-frigate:5000/' \\n\\nHome Assistant necessita accedir al port 5000 (api) i 8554/8555 (rtsp, webrtc) per a totes les funcions.\\n\\nLa integració configurarà sensors, càmeres i la funcionalitat del navegador multimèdia.\\n\\nSensors:\\n- Estadístiques per supervisar el rendiment de Frigate\\n- Recompte d'objectes per a totes les zones i càmeres\\n\\nCàmeres:\\n- Càmeres per a la imatge de l'últim objecte detectat per a cada càmera\\n- Entitats de càmera amb suport de transmissió\\n\\nNavegador multimèdia:\\n - Interfície d'usuari enriquida amb miniatures per explorar clips d'esdeveniments\\n- Interfície d'usuari enriquida per navegar per enregistraments les 24 hores al dia, els set dies a la setmana, per mes, dia, càmera, hora\\n\\nAPI:\\n- API de notificació amb punts de connexió públics per a imatges a les notificacions.",
         "data": {
           "url": "URL"
         }
@@ -20,7 +20,6 @@
     "step": {
       "init": {
         "data": {
-          "rtmp_url_template": "Plantilla de l'URL del RTMP (vegeu la documentació)",
           "rtsp_url_template": "Plantilla de l'URL del RTSP (vegeu la documentació)",
           "media_browser_enable": "Habiliteu el navegador multimèdia",
           "notification_proxy_enable": "Habiliteu el servidor intermediari no autenticat d'esdeveniments de notificacions",

diff --git a/custom_components/frigate/translations/de.json b/custom_components/frigate/translations/de.json
@@ -2,7 +2,7 @@
   "config": {
     "step": {
       "user": {
-        "description": "URL, die Sie für den Zugriff auf Frigate verwenden (z. B. \"http://frigate:5000/\")\n\nWenn Sie HassOS mit dem Addon verwenden, sollte die URL „http://ccab4aaf-frigate:5000/“ lauten\n\nHome Assistant benötigt für alle Funktionen Zugriff auf Port 5000 (api) und 1935 (rtmp).\n\nDie Integration richtet Sensoren, Kameras und Medienbrowser-Funktionen ein.\n\nSensoren:\n- Statistiken zur Überwachung der Frigate-Leistung\n- Objektzählungen für alle Zonen und Kameras\n\nKameras:\n- Kameras für Bild des zuletzt erkannten Objekts für jede Kamera\n- Kameraeinheiten mit Stream-Unterstützung (erfordert RTMP)\n\nMedienbrowser:\n- Umfangreiche Benutzeroberfläche mit Vorschaubildern zum Durchsuchen von Event-Clips\n- Umfangreiche Benutzeroberfläche zum Durchsuchen von 24/7-Aufzeichnungen nach Monat, Tag, Kamera und Uhrzeit\n\nAPI:\n- Benachrichtigungs-API mit öffentlich zugänglichen Endpunkten für Bilder in Benachrichtigungen",
+        "description": "URL, die Sie für den Zugriff auf Frigate verwenden (z. B. \"http://frigate:5000/\")\n\nWenn Sie HassOS mit dem Addon verwenden, sollte die URL „http://ccab4aaf-frigate:5000/“ lauten\n\nHome Assistant benötigt für alle Funktionen Zugriff auf Port 5000 (api) und 8554/8555 (rtsp, webrtc).\n\nDie Integration richtet Sensoren, Kameras und Medienbrowser-Funktionen ein.\n\nSensoren:\n- Statistiken zur Überwachung der Frigate-Leistung\n- Objektzählungen für alle Zonen und Kameras\n\nKameras:\n- Kameras für Bild des zuletzt erkannten Objekts für jede Kamera\n- Kameraeinheiten mit Stream-Unterstützung\n\nMedienbrowser:\n- Umfangreiche Benutzeroberfläche mit Vorschaubildern zum Durchsuchen von Event-Clips\n- Umfangreiche Benutzeroberfläche zum Durchsuchen von 24/7-Aufzeichnungen nach Monat, Tag, Kamera und Uhrzeit\n\nAPI:\n- Benachrichtigungs-API mit öffentlich zugänglichen Endpunkten für Bilder in Benachrichtigungen",
         "data": {
           "url": "URL"
         }
@@ -20,7 +20,6 @@
     "step": {
       "init": {
         "data": {
-          "rtmp_url_template": "RTMP-URL-Vorlage (siehe Dokumentation)",
           "rtsp_url_template": "RTSP-URL-Vorlage (siehe Dokumentation)",
           "media_browser_enable": "Aktivieren Sie den Medienbrowser",
           "notification_proxy_enable": "Aktivieren Sie den Proxy für nicht authentifizierte Benachrichtigungsereignisse",

diff --git a/custom_components/frigate/translations/en.json b/custom_components/frigate/translations/en.json
@@ -2,7 +2,7 @@
   "config": {
     "step": {
       "user": {
-        "description": "URL you use to access Frigate (ie. `http://frigate:5000/`)\n\nIf you are using HassOS with the addon, the URL should be `http://ccab4aaf-frigate:5000/`\n\nHome Assistant needs access to port 5000 (api) and 1935 (rtmp) for all features.\n\nThe integration will setup sensors, cameras, and media browser functionality.\n\nSensors:\n- Stats to monitor frigate performance\n- Object counts for all zones and cameras\n\nCameras:\n- Cameras for image of the last detected object for each camera\n- Camera entities with stream support (requires RTMP)\n\nMedia Browser:\n- Rich UI with thumbnails for browsing event clips\n- Rich UI for browsing 24/7 recordings by month, day, camera, time\n\nAPI:\n- Notification API with public facing endpoints for images in notifications",
+        "description": "URL you use to access Frigate (ie. `http://frigate:5000/`)\n\nIf you are using HassOS with the addon, the URL should be `http://ccab4aaf-frigate:5000/`\n\nHome Assistant needs access to port 5000 (api) and 8554/8555 (rtsp, webrtc) for all features.\n\nThe integration will setup sensors, cameras, and media browser functionality.\n\nSensors:\n- Stats to monitor frigate performance\n- Object counts for all zones and cameras\n\nCameras:\n- Cameras for image of the last detected object for each camera\n- Camera entities with stream support\n\nMedia Browser:\n- Rich UI with thumbnails for browsing event clips\n- Rich UI for browsing 24/7 recordings by month, day, camera, time\n\nAPI:\n- Notification API with public facing endpoints for images in notifications",
         "data": {
           "url": "URL"
         }
@@ -20,7 +20,6 @@
     "step": {
       "init": {
         "data": {
-          "rtmp_url_template": "RTMP URL template (see documentation)",
           "rtsp_url_template": "RTSP URL template (see documentation)",
           "media_browser_enable": "Enable the media browser",
           "notification_proxy_enable": "Enable the unauthenticated notification event proxy",

diff --git a/custom_components/frigate/translations/fr.json b/custom_components/frigate/translations/fr.json
@@ -2,7 +2,7 @@
   "config": {
     "step": {
       "user": {
-        "description": "URL que vous utilisez pour accéder à Frigate (par exemple, `http://frigate:5000/`)\n\nSi vous utilisez HassOS avec l'addon, l'URL devrait être `http://ccab4aaf-frigate:5000/`\n\nHome Assistant a besoin d'accès au port 5000 (api) et 1935 (rtmp) pour toutes les fonctionnalités.\n\nL'intégration configurera des capteurs, des caméras et la fonctionnalité de navigateur multimédia.\n\nCapteurs :\n- Statistiques pour surveiller la performance de Frigate\n- Comptes d'objets pour toutes les zones et caméras\n\nCaméras :\n- Caméras pour l'image du dernier objet détecté pour chaque caméra\n- Entités de caméra avec support de flux (nécessite RTMP)\n\nNavigateur multimédia :\n- Interface riche avec miniatures pour parcourir les clips d'événements\n- Interface riche pour parcourir les enregistrements 24/7 par mois, jour, caméra, heure\n\nAPI :\n- API de notification avec des points de terminaison publics pour les images dans les notifications",
+        "description": "URL que vous utilisez pour accéder à Frigate (par exemple, `http://frigate:5000/`)\n\nSi vous utilisez HassOS avec l'addon, l'URL devrait être `http://ccab4aaf-frigate:5000/`\n\nHome Assistant a besoin d'accès au port 5000 (api) et 8554/8555 (rtsp, webrtc) pour toutes les fonctionnalités.\n\nL'intégration configurera des capteurs, des caméras et la fonctionnalité de navigateur multimédia.\n\nCapteurs :\n- Statistiques pour surveiller la performance de Frigate\n- Comptes d'objets pour toutes les zones et caméras\n\nCaméras :\n- Caméras pour l'image du dernier objet détecté pour chaque caméra\n- Entités de caméra avec support de flux\n\nNavigateur multimédia :\n- Interface riche avec miniatures pour parcourir les clips d'événements\n- Interface riche pour parcourir les enregistrements 24/7 par mois, jour, caméra, heure\n\nAPI :\n- API de notification avec des points de terminaison publics pour les images dans les notifications",
         "data": {
           "url": "URL"
         }
@@ -20,7 +20,6 @@
     "step": {
       "init": {
         "data": {
-          "rtmp_url_template": "Modèle d'URL RTMP (voir la documentation)",
           "rtsp_url_template": "Modèle d'URL RTSP (voir la documentation)",
           "media_browser_enable": "Activer le navigateur multimédia",
           "notification_proxy_enable": "Activer le proxy d'événement de notification non authentifié",

diff --git a/custom_components/frigate/translations/pt-BR.json b/custom_components/frigate/translations/pt-BR.json
@@ -2,7 +2,7 @@
   "config": {
     "step": {
       "user": {
-        "description": "URL que você usa para acessar o Frigate (ou seja, `http://frigate:5000/`)\n\nSe você estiver usando HassOS com o complemento, o URL deve ser `http://ccab4aaf-frigate:5000/`\n\nO Home Assistant precisa de acesso à porta 5000 (api) e 1935 (rtmp) para ter todos os recursos.\n\nA integração configurará sensores, câmeras e funcionalidades do navegador de mídia.\n\nSensores:\n- Estatísticas para monitorar o desempenho do frigate \n- Contagem de objetos para todas as zonas e câmeras\n\nCâmeras:\n- Câmeras para imagem do último objeto detectado para cada câmera\n- Entidades da câmera com suporte a stream (requer RTMP)\n\nNavegador de mídia:\n- UI avançada com miniaturas para navegar em clipes de eventos\n- UI avançada para navegar 24 horas por dia, 7 dias por semana e por mês, dia, câmera, hora\n\nAPI:\n- API de notificação com endpoints voltados para o público para imagens em notificações",
+        "description": "URL que você usa para acessar o Frigate (ou seja, `http://frigate:5000/`)\n\nSe você estiver usando HassOS com o complemento, o URL deve ser `http://ccab4aaf-frigate:5000/`\n\nO Home Assistant precisa de acesso à porta 5000 (api) e 8554/8555 (rtsp, webrtc) para ter todos os recursos.\n\nA integração configurará sensores, câmeras e funcionalidades do navegador de mídia.\n\nSensores:\n- Estatísticas para monitorar o desempenho do frigate \n- Contagem de objetos para todas as zonas e câmeras\n\nCâmeras:\n- Câmeras para imagem do último objeto detectado para cada câmera\n- Entidades da câmera com suporte a stream\n\nNavegador de mídia:\n- UI avançada com miniaturas para navegar em clipes de eventos\n- UI avançada para navegar 24 horas por dia, 7 dias por semana e por mês, dia, câmera, hora\n\nAPI:\n- API de notificação com endpoints voltados para o público para imagens em notificações",
         "data": {
           "url": "URL"
         }
@@ -20,7 +20,6 @@
     "step": {
       "init": {
         "data": {
-          "rtmp_url_template": "Modelo de URL RTMP (consulte a documentação)",
           "rtsp_url_template": "Modelo de URL RTSP (consulte a documentação)",
           "notification_proxy_enable": "Habilitar o proxy de evento de notificação não autenticado",
           "notification_proxy_expire_after_seconds": "Proibir acesso de notificação não autenticado após segundos (0=nunca)",