Merge pull request #1293 from dermotduffy/engine-detection

Improve engine identification and id generation

src/camera-manager/engine-factory.ts

@@ -96,6 +96,11 @@ export class CameraManagerEngineFactory {
         // Frigate technically does not need an entity, if the camera name is
         // manually set the camera is assumed to be Frigate.
         engine = Engine.Frigate;
+      } else if (
+        cameraConfig.webrtc_card?.url ||
+        (cameraConfig.go2rtc?.url && cameraConfig.go2rtc?.stream)
+      ) {
+        engine = Engine.Generic;
       }
     }
 

src/camera-manager/generic/engine-generic.ts

@@ -31,7 +31,7 @@ import {
   RecordingSegmentsQuery,
   RecordingSegmentsQueryResultsMap,
 } from '../types';
-import { getDefaultGo2RTCEndpoint } from '../utils.js';
+import { getCameraEntityFromConfig, getDefaultGo2RTCEndpoint } from '../utils.js';
 
 export class GenericCameraManagerEngine implements CameraManagerEngine {
   public getEngineType(): Engine {
@@ -159,6 +159,7 @@ export class GenericCameraManagerEngine implements CameraManagerEngine {
     hass: HomeAssistant,
     cameraConfig: CameraConfig,
   ): CameraManagerCameraMetadata {
+    const cameraEntity = getCameraEntityFromConfig(cameraConfig);
     return {
       title:
         cameraConfig.title ??
@@ -166,7 +167,9 @@ export class GenericCameraManagerEngine implements CameraManagerEngine {
         getEntityTitle(hass, cameraConfig.webrtc_card?.entity) ??
         cameraConfig.id ??
         '',
-      icon: cameraConfig?.icon ?? getEntityIcon(hass, cameraConfig.camera_entity),
+      icon:
+        cameraConfig?.icon ??
+        (cameraEntity ? getEntityIcon(hass, cameraEntity, 'mdi:video') : 'mdi:video'),
     };
   }
 

src/camera-manager/manager.ts

@@ -259,6 +259,9 @@ export class CameraManager {
         );
       }
 
+      // Always ensure the actual ID used in the card is in the configuration itself.
+      result.initializedConfig.id = id;
+
       this._store.addCamera(id, result.initializedConfig, result.engine);
     });
 

src/components-lib/menu-controller.ts

@@ -91,7 +91,7 @@ export class MenuButtonController {
         const action = createFrigateCardCustomAction('camera_select', {
           camera: cameraID,
         });
-        const metadata = cameraManager.getCameraMetadata(cameraID) ?? undefined;
+        const metadata = cameraManager.getCameraMetadata(cameraID);
 
         return {
           enabled: true,

src/utils/camera.ts

@@ -14,8 +14,15 @@ export function getCameraID(
     (typeof config?.camera_entity === 'string' && config.camera_entity) ||
     (typeof config?.webrtc_card === 'object' &&
       config.webrtc_card &&
-      typeof config.webrtc_card['entity'] === 'string' &&
+      ((typeof config.webrtc_card['entity'] === 'string' &&
         config.webrtc_card['entity']) ||
+        (typeof config.webrtc_card['url'] === 'string' && config.webrtc_card['url']))) ||
+    (typeof config?.go2rtc === 'object' &&
+      config.go2rtc &&
+      typeof config.go2rtc['url'] === 'string' &&
+      typeof config.go2rtc['stream'] === 'string' &&
+      // Artifical identifier that includes both url / stream.
+      `${config.go2rtc['url']}#${config.go2rtc['stream']}`) ||
     (typeof config?.frigate === 'object' &&
       config.frigate &&
       typeof config?.frigate['camera_name'] === 'string' &&

src/utils/ha/index.ts

@@ -1,4 +1,4 @@
-import { computeStateDomain, HomeAssistant } from 'custom-card-helpers';
+import { computeDomain, computeStateDomain, HomeAssistant } from 'custom-card-helpers';
 import { HassEntity, MessageBase } from 'home-assistant-js-websocket';
 import { StyleInfo } from 'lit/directives/style-map.js';
 import { ZodSchema } from 'zod';
@@ -11,7 +11,7 @@ import {
   signedPathSchema,
   StateParameters,
 } from '../../types.js';
-import { stateIcon } from '../icons/state-icon.js';
+import { domainIcon } from '../icons/domain-icon.js';
 import { getParseErrorKeys } from '../zod.js';
 
 /**
@@ -234,7 +234,7 @@ export function refreshDynamicStateParameters(
     params.style = { ...computeStyle(state), ...params.style };
   }
   params.title = params.title ?? (state?.attributes?.friendly_name || params.entity);
-  params.icon = params.icon ?? stateIcon(state);
+  params.icon = params.icon ?? getEntityIcon(hass, params.entity);
 
   const domain = state ? computeStateDomain(state) : undefined;
   params.data_domain =
@@ -262,12 +262,25 @@ export function getEntityTitle(
 
 /**
  * Get the icon of an entity.
- * @param entity The entity id.
+ * @param entityID The entity id.
  * @param hass The Home Assistant object.
  * @returns The icon or undefined.
  */
-export function getEntityIcon(hass?: HomeAssistant, entity?: string): string {
+export function getEntityIcon(
-  return stateIcon(entity ? hass?.states[entity] : null);
+  hass: HomeAssistant,
+  entityID: string,
+  defaultIcon?: string,
+): string {
+  const entityState = hass.states[entityID];
+  if (entityState && entityState.attributes.icon) {
+    return entityState.attributes.icon;
+  }
+  return domainIcon(
+    computeDomain(entityID),
+    entityState,
+    entityState?.state,
+    defaultIcon,
+  );
 }
 
 /**

src/utils/icons/domain-icon.ts

@@ -52,7 +52,7 @@ const FIXED_DOMAIN_ICONS = {
   zone: 'mdi:map-marker-radius',
 };
 
-export function domainIcon(domain: string, entity?: HassEntity, state?: string): string {
+export function domainIcon(domain: string, entity?: HassEntity, state?: string, defaultIcon?: string): string {
   switch (domain) {
     case 'alarm_control_panel':
       return alarmPanelIcon(state);
@@ -195,6 +195,5 @@ export function domainIcon(domain: string, entity?: HassEntity, state?: string):
     return FIXED_DOMAIN_ICONS[domain];
   }
 
-  console.warn(`Unable to find icon for domain: ${domain}`);
+  return defaultIcon ?? DEFAULT_DOMAIN_ICON;
-  return DEFAULT_DOMAIN_ICON;
 }

src/utils/icons/state-icon.ts

@@ -1,18 +0,0 @@
-import { computeDomain } from 'custom-card-helpers';
-import { HassEntity } from 'home-assistant-js-websocket';
-import { DEFAULT_DOMAIN_ICON, domainIcon } from './domain-icon';
-
-export function stateIcon(entity?: HassEntity | null): string {
-  if (!entity) {
-    return DEFAULT_DOMAIN_ICON;
-  }
-  if (entity.attributes.icon) {
-    return entity.attributes.icon;
-  }
-
-  const domain = computeDomain(entity.entity_id);
-
-  const state = entity.state;
-
-  return domainIcon(domain, entity, state);
-}

tests/camera-manager/engine-factory.test.ts

@@ -29,26 +29,16 @@ const createFactory = (options?: {
   );
 };
 
-describe('CameraManagerEngineFactory.getEngineForCamera()', () => {
+describe('getEngineForCamera()', () => {
-  it('should get frigate engine from config', async () => {
+  describe('should get a frigate camera', () => {
+    it('from manually set engine', async () => {
       const config = createCameraConfig({ engine: 'frigate' });
       expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
         Engine.Frigate,
       );
     });
-  it('should get motionEye engine from config', async () => {
+
-    const config = createCameraConfig({ engine: 'motioneye' });
+    it('from auto detection', async () => {
-    expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
-      Engine.MotionEye,
-    );
-  });
-  it('should get generic engine from config', async () => {
-    const config = createCameraConfig({ engine: 'generic' });
-    expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
-      Engine.Generic,
-    );
-  });
-  it('should get frigate engine from auto config', async () => {
       const config = createCameraConfig({ engine: 'auto', camera_entity: 'camera.foo' });
       const entityRegistryManager = new EntityRegistryManager(new EntityCache());
 
@@ -64,7 +54,26 @@ describe('CameraManagerEngineFactory.getEngineForCamera()', () => {
         }).getEngineForCamera(createHASS(), config),
       ).toBe(Engine.Frigate);
     });
-  it('should get motioneye engine from auto config', async () => {
+
+    it('from config with camera_name', async () => {
+      const config = createCameraConfig({
+        frigate: { client_id: 'bar', camera_name: 'foo' },
+      });
+      expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
+        Engine.Frigate,
+      );
+    });
+  });
+
+  describe('should get a motionEye camera', () => {
+    it('from manually set engine', async () => {
+      const config = createCameraConfig({ engine: 'motioneye' });
+      expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
+        Engine.MotionEye,
+      );
+    });
+
+    it('from auto detection', async () => {
       const config = createCameraConfig({ engine: 'auto', camera_entity: 'camera.foo' });
       const entityRegistryManager = new EntityRegistryManager(new EntityCache());
 
@@ -80,7 +89,17 @@ describe('CameraManagerEngineFactory.getEngineForCamera()', () => {
         }).getEngineForCamera(createHASS(), config),
       ).toBe(Engine.MotionEye);
     });
-  it('should get generic engine from auto config', async () => {
+  });
+
+  describe('should get a generic camera', () => {
+    it('from manually set engine', async () => {
+      const config = createCameraConfig({ engine: 'generic' });
+      expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
+        Engine.Generic,
+      );
+    });
+
+    it('from auto detection', async () => {
       const config = createCameraConfig({ engine: 'auto', camera_entity: 'camera.foo' });
       const entityRegistryManager = new EntityRegistryManager(new EntityCache());
 
@@ -96,32 +115,8 @@ describe('CameraManagerEngineFactory.getEngineForCamera()', () => {
         }).getEngineForCamera(createHASS(), config),
       ).toBe(Engine.Generic);
     });
-  it('should get frigate engine from config with camera_name', async () => {
-    const config = createCameraConfig({
-      frigate: { client_id: 'bar', camera_name: 'foo' },
-    });
-    expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
-      Engine.Frigate,
-    );
-  });
-  it('should get no engine from config with insufficient details', async () => {
-    const config = createCameraConfig({});
-    expect(await createFactory().getEngineForCamera(createHASS(), config)).toBeNull();
-  });
 
-  it('should throw error on invalid entity', async () => {
+    it('from entity not in registry but with state', async () => {
-    const config = createCameraConfig({ engine: 'auto', camera_entity: 'camera.foo' });
-    const entityRegistryManager = new EntityRegistryManager(new EntityCache());
-
-    entityRegistryManager.getEntity = vi.fn().mockRejectedValue(new Error());
-
-    await expect(
-      createFactory({
-        entityRegistryManager: entityRegistryManager,
-      }).getEngineForCamera(createHASS(), config),
-    ).rejects.toThrow();
-  });
-  it('should treat entity not in registry but with state as generic', async () => {
       const config = createCameraConfig({
         engine: 'auto',
         webrtc_card: { entity: 'camera.foo' },
@@ -141,7 +136,36 @@ describe('CameraManagerEngineFactory.getEngineForCamera()', () => {
         ),
       ).toBe(Engine.Generic);
     });
-  it('should get engine from webrtc-card configuration', async () => {
+
+    it('from webrtc-card url', async () => {
+      const config = createCameraConfig({
+        engine: 'auto',
+        webrtc_card: { url: 'camera.foo' },
+      });
+
+      expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
+        Engine.Generic,
+      );
+    });
+
+    it('from go2rtc url and stream', async () => {
+      const config = createCameraConfig({
+        engine: 'auto',
+        go2rtc: { url: 'https://my-go2rtc', stream: 'office' },
+      });
+
+      expect(await createFactory().getEngineForCamera(createHASS(), config)).toBe(
+        Engine.Generic,
+      );
+    });
+  });
+
+  it('should get no engine from config with insufficient details', async () => {
+    const config = createCameraConfig({});
+    expect(await createFactory().getEngineForCamera(createHASS(), config)).toBeNull();
+  });
+
+  it('should throw error on invalid entity', async () => {
     const config = createCameraConfig({ engine: 'auto', camera_entity: 'camera.foo' });
     const entityRegistryManager = new EntityRegistryManager(new EntityCache());
 
@@ -155,7 +179,7 @@ describe('CameraManagerEngineFactory.getEngineForCamera()', () => {
   });
 });
 
-describe('CameraManagerEngineFactory.createEngine()', () => {
+describe('createEngine()', () => {
   it('should create generic engine', async () => {
     expect(await createFactory().createEngine(Engine.Generic)).toBeInstanceOf(
       GenericCameraManagerEngine,

tests/camera-manager/generic/engine-generic.test.ts

@@ -192,11 +192,23 @@ describe('GenericCameraManagerEngine', () => {
       expect(
         createEngine().getCameraMetadata(createHASS(), createGenericCameraConfig()),
       ).toEqual({
-        icon: 'mdi:bookmark',
+        icon: 'mdi:video',
         title: '',
       });
     });
 
+    it('with id', async () => {
+      expect(
+        createEngine().getCameraMetadata(
+          createHASS(),
+          createGenericCameraConfig({ id: 'https://go2rtc#stream' }),
+        ),
+      ).toEqual({
+        icon: 'mdi:video',
+        title: 'https://go2rtc#stream',
+      });
+    });
+
     it('with configured title', async () => {
       expect(
         createEngine().getCameraMetadata(
@@ -206,7 +218,7 @@ describe('GenericCameraManagerEngine', () => {
           }),
         ),
       ).toEqual({
-        icon: 'mdi:bookmark',
+        icon: 'mdi:video',
         title: 'My Camera',
       });
     });
@@ -225,7 +237,7 @@ describe('GenericCameraManagerEngine', () => {
             }),
           ),
         ).toEqual({
-          icon: 'mdi:bookmark',
+          icon: 'mdi:video',
           title: 'My Entity Camera',
         });
       });
@@ -245,7 +257,7 @@ describe('GenericCameraManagerEngine', () => {
             }),
           ),
         ).toEqual({
-          icon: 'mdi:bookmark',
+          icon: 'mdi:video',
           title: 'My Entity Camera',
         });
       });

tests/utils/camera.test.ts

@@ -20,6 +20,14 @@ describe('getCameraID', () => {
     const config = createCameraConfig({ webrtc_card: { entity: 'foo' } });
     expect(getCameraID(config)).toBe('foo');
   });
+  it('should get camera id with webrtc url', () => {
+    const config = createCameraConfig({ webrtc_card: { url: 'foo' } });
+    expect(getCameraID(config)).toBe('foo');
+  });
+  it('should get camera id with go2rtc url and stream', () => {
+    const config = createCameraConfig({ go2rtc: { url: 'https://foo', stream: 'office' } });
+    expect(getCameraID(config)).toBe('https://foo#office');
+  });
   it('should get camera id with frigate camera_name', () => {
     const config = createCameraConfig({
       frigate: { client_id: 'bar', camera_name: 'foo' },

tests/utils/ha/index.test.ts

@@ -1,7 +1,10 @@
 import { HomeAssistant } from 'custom-card-helpers';
 import { describe, expect, it } from 'vitest';
-import { hasHAConnectionStateChanged } from '../../../src/utils/ha/index.js';
+import {
-import { createHASS } from '../../test-utils.js';
+  getEntityIcon,
+  hasHAConnectionStateChanged,
+} from '../../../src/utils/ha/index.js';
+import { createHASS, createStateEntity } from '../../test-utils.js';
 
 const createConnected = (connected: boolean): HomeAssistant => {
   const hass = createHASS();
@@ -43,3 +46,24 @@ describe('hasHAConnectionStateChanged', () => {
     expect(hasHAConnectionStateChanged(null, null)).toBeFalsy();
   });
 });
+
+describe('getEntityIcon', () => {
+  it('should get icon from attributes', () => {
+    expect(
+      getEntityIcon(
+        createHASS({
+          'camera.test': createStateEntity({
+            attributes: {
+              icon: 'mdi:cow',
+            },
+          }),
+        }),
+        'camera.test',
+      ),
+    ).toBe('mdi:cow');
+  });
+
+  it('should get icon from domain', () => {
+    expect(getEntityIcon(createHASS(), 'camera.test')).toBe('mdi:video');
+  });
+});