Add 'dependent camera' support.

This commit is contained in:
Dermot Duffy
2022-04-23 11:22:04 -07:00
parent 58813c156e
commit fb9d5684ec
11 changed files with 363 additions and 164 deletions
+220 -51
View File
@@ -1,16 +1,18 @@
import { HomeAssistant } from 'custom-card-helpers'; import { HomeAssistant } from 'custom-card-helpers';
import type { import {
BrowseMediaQueryParametersBase,
BrowseMediaQueryParameters, BrowseMediaQueryParameters,
FrigateBrowseMediaSource, FrigateBrowseMediaSource,
CameraConfig, CameraConfig,
MEDIA_CLASS_PLAYLIST,
MEDIA_TYPE_PLAYLIST,
} from './types.js'; } from './types.js';
import { View } from './view.js'; import { View } from './view.js';
import { frigateBrowseMediaSourceSchema } from './types.js'; import { frigateBrowseMediaSourceSchema } from './types.js';
import { import {
dispatchErrorMessageEvent, dispatchErrorMessageEvent,
dispatchMessageEvent, dispatchMessageEvent,
getCameraTitle,
homeAssistantWSRequest, homeAssistantWSRequest,
} from './common.js'; } from './common.js';
import { localize } from './localize/localize.js'; import { localize } from './localize/localize.js';
@@ -73,11 +75,9 @@ export class BrowseMediaUtil {
type: 'media_source/browse_media', type: 'media_source/browse_media',
media_content_id: media_content_id, media_content_id: media_content_id,
}; };
return homeAssistantWSRequest(hass, frigateBrowseMediaSourceSchema, request); return await homeAssistantWSRequest(hass, frigateBrowseMediaSourceSchema, request);
} }
// Browse Frigate media with query parameters.
/** /**
* Browse Frigate media with a media query. May throw. * Browse Frigate media with a media query. May throw.
* @param hass The HomeAssistant object. * @param hass The HomeAssistant object.
@@ -109,13 +109,100 @@ export class BrowseMediaUtil {
); );
} }
/**
* Browse multiple Frigate media queries. May throw.
* @param hass The HomeAssistant object.
* @param params An array of search parameters to use to search for media.
* @returns A map of FrigateBrowseMediaSource object or null on malformed.
*/
static async multipleBrowseMediaQuery(
hass: HomeAssistant,
params: BrowseMediaQueryParameters | BrowseMediaQueryParameters[],
): Promise<Map<BrowseMediaQueryParameters, FrigateBrowseMediaSource>> {
params = Array.isArray(params) ? params : [params];
const output: Map<BrowseMediaQueryParameters, FrigateBrowseMediaSource> = new Map();
await Promise.all(
params.map(async (param: BrowseMediaQueryParameters): Promise<void> => {
output.set(param, await this.browseMediaQuery(hass, param));
}),
);
return output;
}
/**
* Browse multiple Frigate media queries, then merged them. May throw.
* @param hass The HomeAssistant object.
* @param params An array of search parameters to use to search for media.
* @returns A single FrigateBrowseMediaSource object or null on malformed.
*/
static async multipleBrowseMediaQueryMerged(
hass: HomeAssistant,
params: BrowseMediaQueryParameters | BrowseMediaQueryParameters[],
): Promise<FrigateBrowseMediaSource> {
return this.mergeFrigateBrowseMediaSources(
await this.multipleBrowseMediaQuery(hass, params),
);
}
/**
* Merge multiple FrigateBrowseMediaSource into a single. Note that this may
* use information from the query to differentiate results that may otherwise
* be identical.
* @param input A map of query -> result.
* @returns A single FrigateBrowseMediaSource object.
*/
static mergeFrigateBrowseMediaSources(
input: Map<BrowseMediaQueryParameters, FrigateBrowseMediaSource>,
): FrigateBrowseMediaSource {
const children: FrigateBrowseMediaSource[] = [];
for (const [query, result] of input.entries()) {
for (const child of result.children || []) {
if (this.isTrueMedia(child)) {
children.push(child);
} else {
if (query.title) {
children.push({ ...child, title: `[${query.title}] ${child.title}` });
} else {
children.push(child);
}
}
}
}
const eventSort = (
a: FrigateBrowseMediaSource,
b: FrigateBrowseMediaSource,
): number => {
if (
!a.frigate?.event ||
(b.frigate?.event && b.frigate.event.start_time < a.frigate.event.start_time)
) {
return 1;
}
if (
!b.frigate?.event ||
(a.frigate?.event && b.frigate.event.start_time > a.frigate.event.start_time)
) {
return -1;
}
return 0;
};
return this.createEventParentForChildren('Merged events', children.sort(eventSort));
}
/** /**
* Get the parameters to search for media. * Get the parameters to search for media.
* @returns A BrowseMediaQueryParameters object. * @returns A BrowseMediaQueryParameters object.
*/ */
static getBrowseMediaQueryParametersBase( static getBrowseMediaQueryParameters(
hass: HomeAssistant,
cameraID: string,
cameraConfig?: CameraConfig, cameraConfig?: CameraConfig,
): BrowseMediaQueryParametersBase | null { overrides?: Partial<BrowseMediaQueryParameters>,
): BrowseMediaQueryParameters | null {
if (!cameraConfig || !cameraConfig.camera_name) { if (!cameraConfig || !cameraConfig.camera_name) {
return null; return null;
} }
@@ -124,84 +211,143 @@ export class BrowseMediaUtil {
cameraName: cameraConfig.camera_name, cameraName: cameraConfig.camera_name,
label: cameraConfig.label, label: cameraConfig.label,
zone: cameraConfig.zone, zone: cameraConfig.zone,
title: getCameraTitle(hass, cameraConfig),
cameraID: cameraID,
...overrides,
}; };
} }
/** /**
* Set the mediaType parameter from the current view. * Apply overrides to multiple query parameters.
* @param browseMediaQueryParametersBase The base media query parameters object. * @param parameters An array of query parameters.
* @param view The current view. * @param overrides The overrides to apply.
* @returns A fully populated BrowseMediaQueryParameters or null. * @returns The override query parameters.
*/ */
static setMediaTypeFromView( static overrideMultiBrowseMediaQueryParameters(
browseMediaQueryParametersBase: BrowseMediaQueryParametersBase | null, parameters: BrowseMediaQueryParameters[],
view: View, overrides: Partial<BrowseMediaQueryParameters>,
): BrowseMediaQueryParameters | null { ): BrowseMediaQueryParameters[] {
if ( const output: BrowseMediaQueryParameters[] = [];
!browseMediaQueryParametersBase || parameters.forEach((param) => {
!(view.isClipRelatedView() || view.isSnapshotRelatedView()) output.push({ ...param, ...overrides });
) { });
return null; return output;
}
/**
* Get BrowseMediaQueryParameters for a camera (including its dependencies).
* @param hass Home Assistant object.
* @param cameras Cameras map.
* @param camera Name of the current camera.
* @param mediaType Optional media type to include in the parameters.
* @returns An array of query parameters.
*/
static getFullDependentBrowseMediaQueryParameters(
hass: HomeAssistant,
cameras: Map<string, CameraConfig>,
camera: string,
mediaType?: 'clips' | 'snapshots',
): BrowseMediaQueryParameters[] | null {
const cameraIDs: Set<string> = new Set();
const getDependentCameras = (camera: string): void => {
const cameraConfig = cameras.get(camera);
if (cameraConfig) {
cameraIDs.add(camera);
for (const eventCameraID of cameraConfig.dependent_cameras || []) {
if (!cameraIDs.has(eventCameraID)) {
getDependentCameras(eventCameraID);
}
}
}
};
getDependentCameras(camera);
const params: BrowseMediaQueryParameters[] = [];
for (const cameraID of cameraIDs) {
const param = BrowseMediaUtil.getBrowseMediaQueryParameters(
hass,
cameraID,
cameras.get(cameraID),
mediaType ? { mediaType: mediaType } : {},
);
// Fail on a single bad camera, as it's almost certainly a user error that
// should be fixed rather than hidden.
if (!param) {
return null;
}
params.push(param);
} }
return { return params.length ? params : null;
...browseMediaQueryParametersBase,
mediaType: view.isClipRelatedView() ? 'clips' : 'snapshots',
};
} }
/** /**
* Get the parameters to search for media related to the current view. * Get BrowseMediaQueryParameters for a camera (including its dependencies) or dispatch an error.
* @returns A BrowseMediaQueryParameters object. * @param element The element from which to dispatch the error.
* @param hass Home Assistant object.
* @param cameras Cameras map.
* @param camera Name of the current camera.
* @param mediaType Optional media type to include in the parameters.
* @returns An array of query parameters.
*/ */
static getBrowseMediaQueryParametersBaseOrDispatchError( static getFullDependentBrowseMediaQueryParametersOrDispatchError(
node: HTMLElement, element: HTMLElement,
cameraConfig: CameraConfig, hass: HomeAssistant,
): BrowseMediaQueryParametersBase | null { cameras: Map<string, CameraConfig>,
// Verify there is a camera name, otherwise getBrowseMediaQueryParametersBase() camera: string,
// will return undefined. mediaType?: 'clips' | 'snapshots',
if (!cameraConfig.camera_name) { ): BrowseMediaQueryParameters[] | null {
const params = this.getFullDependentBrowseMediaQueryParameters(
hass,
cameras,
camera,
mediaType,
);
if (!params) {
dispatchErrorMessageEvent( dispatchErrorMessageEvent(
node, element,
localize('error.no_camera_name') + `: ${JSON.stringify(cameraConfig)}`, localize('error.no_camera_name'),
cameras.get(camera),
); );
return null; return null;
} }
return params;
return BrowseMediaUtil.getBrowseMediaQueryParametersBase(cameraConfig);
} }
/** /**
* Fetch the latest media and dispatch a change view event to reflect the * Fetch the latest media and dispatch a change view event to reflect the
* results. If no media is found a suitable message event will be triggered * results. If no media is found a suitable message event will be triggered
* instead. * instead.
* @param node The HTMLElement to dispatch events from. * @param element The HTMLElement to dispatch events from.
* @param hass The Home Assistant object. * @param hass The Home Assistant object.
* @param view The current view to evolve. * @param view The current view to evolve.
* @param browseMediaQueryParameters The media parameters to query with. * @param browseMediaQueryParameters The media parameters to query with.
* @returns * @returns
*/ */
static async fetchLatestMediaAndDispatchViewChange( static async fetchLatestMediaAndDispatchViewChange(
node: HTMLElement, element: HTMLElement,
hass: HomeAssistant, hass: HomeAssistant,
view: Readonly<View>, view: Readonly<View>,
browseMediaQueryParameters: BrowseMediaQueryParameters, browseMediaQueryParameters:
| BrowseMediaQueryParameters
| BrowseMediaQueryParameters[],
): Promise<void> { ): Promise<void> {
let parent: FrigateBrowseMediaSource | null; let parent: FrigateBrowseMediaSource | null;
try { try {
parent = await BrowseMediaUtil.browseMediaQuery(hass, browseMediaQueryParameters); parent = await BrowseMediaUtil.multipleBrowseMediaQueryMerged(
hass,
browseMediaQueryParameters,
);
} catch (e) { } catch (e) {
return dispatchErrorMessageEvent(node, (e as Error).message); return dispatchErrorMessageEvent(element, (e as Error).message);
} }
const childIndex = BrowseMediaUtil.getFirstTrueMediaChildIndex(parent); const childIndex = BrowseMediaUtil.getFirstTrueMediaChildIndex(parent);
if (!parent || !parent.children || childIndex == null) { if (!parent || !parent.children || childIndex == null) {
return dispatchMessageEvent( return dispatchMessageEvent(
node, element,
browseMediaQueryParameters.mediaType == 'clips' view.isClipRelatedView()
? localize('common.no_clip') ? localize('common.no_clip')
: localize('common.no_snapshot'), : localize('common.no_snapshot'),
browseMediaQueryParameters.mediaType == 'clips' view.isClipRelatedView() ? 'mdi:filmstrip-off' : 'mdi:camera-off',
? 'mdi:filmstrip-off'
: 'mdi:camera-off',
); );
} }
@@ -210,7 +356,7 @@ export class BrowseMediaUtil {
target: parent, target: parent,
childIndex: childIndex, childIndex: childIndex,
}) })
.dispatchChangeEvent(node); .dispatchChangeEvent(element);
} }
/** /**
@@ -223,7 +369,7 @@ export class BrowseMediaUtil {
* @returns * @returns
*/ */
static async fetchChildMediaAndDispatchViewChange( static async fetchChildMediaAndDispatchViewChange(
node: HTMLElement, element: HTMLElement,
hass: HomeAssistant, hass: HomeAssistant,
view: Readonly<View>, view: Readonly<View>,
child: Readonly<FrigateBrowseMediaSource>, child: Readonly<FrigateBrowseMediaSource>,
@@ -232,13 +378,36 @@ export class BrowseMediaUtil {
try { try {
parent = await BrowseMediaUtil.browseMedia(hass, child.media_content_id); parent = await BrowseMediaUtil.browseMedia(hass, child.media_content_id);
} catch (e) { } catch (e) {
return dispatchErrorMessageEvent(node, (e as Error).message); return dispatchErrorMessageEvent(element, (e as Error).message);
} }
view view
.evolve({ .evolve({
target: parent, target: parent,
}) })
.dispatchChangeEvent(node); .dispatchChangeEvent(element);
}
/**
* Given an array of media children, create a parent for them.
* @param title The title to use for the parent.
* @param children The children media items.
* @returns A single parent containing the children.
*/
static createEventParentForChildren(
title: string,
children: FrigateBrowseMediaSource[],
): FrigateBrowseMediaSource {
return {
title: title,
media_class: MEDIA_CLASS_PLAYLIST,
media_content_type: MEDIA_TYPE_PLAYLIST,
media_content_id: '',
can_play: false,
can_expand: true,
children_media_class: MEDIA_CLASS_PLAYLIST,
thumbnail: null,
children: children,
};
} }
} }
+9 -7
View File
@@ -8,7 +8,7 @@ import {
} from 'lit'; } from 'lit';
import { HomeAssistant, LovelaceCardEditor, getLovelace } from 'custom-card-helpers'; import { HomeAssistant, LovelaceCardEditor, getLovelace } from 'custom-card-helpers';
import { StyleInfo, styleMap } from 'lit/directives/style-map.js'; import { StyleInfo, styleMap } from 'lit/directives/style-map.js';
import { customElement, property, query, state } from 'lit/decorators.js'; import { customElement, property, state } from 'lit/decorators.js';
import { classMap } from 'lit/directives/class-map.js'; import { classMap } from 'lit/directives/class-map.js';
import { createRef, ref, Ref } from 'lit/directives/ref.js'; import { createRef, ref, Ref } from 'lit/directives/ref.js';
import screenfull from 'screenfull'; import screenfull from 'screenfull';
@@ -328,11 +328,12 @@ export class FrigateCard extends LitElement {
const cameraConfig = this._getSelectedCameraConfig(); const cameraConfig = this._getSelectedCameraConfig();
// Don't show `clips` button if there's no `camera_name` (e.g. non-Frigate // Don't show `clips` button if there's no `camera_name` (e.g. non-Frigate
// cameras), or is birdseye. // cameras), or is birdseye (unless there are dependent cameras).
if ( if (
this._getConfig().menu.buttons.clips && this._getConfig().menu.buttons.clips &&
cameraConfig?.camera_name && cameraConfig?.camera_name &&
cameraConfig?.camera_name !== 'birdseye' (cameraConfig?.camera_name !== 'birdseye' ||
cameraConfig?.dependent_cameras?.length)
) { ) {
buttons.push({ buttons.push({
type: 'custom:frigate-card-menu-icon', type: 'custom:frigate-card-menu-icon',
@@ -345,11 +346,12 @@ export class FrigateCard extends LitElement {
} }
// Don't show `snapshots` button if there's no `camera_name` (e.g. non-Frigate // Don't show `snapshots` button if there's no `camera_name` (e.g. non-Frigate
// cameras), or is birdseye. // cameras), or is birdseye (unless there are dependent cameras).
if ( if (
this._getConfig().menu.buttons.snapshots && this._getConfig().menu.buttons.snapshots &&
cameraConfig?.camera_name && cameraConfig?.camera_name &&
cameraConfig?.camera_name !== 'birdseye' (cameraConfig?.camera_name !== 'birdseye' ||
cameraConfig?.dependent_cameras?.length)
) { ) {
buttons.push({ buttons.push({
type: 'custom:frigate-card-menu-icon', type: 'custom:frigate-card-menu-icon',
@@ -1299,7 +1301,7 @@ export class FrigateCard extends LitElement {
? html` <frigate-card-gallery ? html` <frigate-card-gallery
.hass=${this._hass} .hass=${this._hass}
.view=${this._view} .view=${this._view}
.cameraConfig=${cameraConfig} .cameras=${this._cameras}
.galleryConfig=${this._getConfig().event_gallery} .galleryConfig=${this._getConfig().event_gallery}
> >
</frigate-card-gallery>` </frigate-card-gallery>`
@@ -1308,7 +1310,7 @@ export class FrigateCard extends LitElement {
? html` <frigate-card-viewer ? html` <frigate-card-viewer
.hass=${this._hass} .hass=${this._hass}
.view=${this._view} .view=${this._view}
.cameraConfig=${cameraConfig} .cameras=${this._cameras}
.viewerConfig=${this._getConfig().event_viewer} .viewerConfig=${this._getConfig().event_viewer}
.resolvedMediaCache=${this._resolvedMediaCache} .resolvedMediaCache=${this._resolvedMediaCache}
> >
+1
View File
@@ -477,6 +477,7 @@ export function getCameraTitle(
config?.title || config?.title ||
(config?.camera_entity ? getEntityTitle(hass, config.camera_entity) : '') || (config?.camera_entity ? getEntityTitle(hass, config.camera_entity) : '') ||
(config?.camera_name ? prettifyFrigateName(config.camera_name) : '') || (config?.camera_name ? prettifyFrigateName(config.camera_name) : '') ||
config?.id ||
'' ''
); );
} }
+19 -14
View File
@@ -11,11 +11,7 @@ import {
import { HomeAssistant } from 'custom-card-helpers'; import { HomeAssistant } from 'custom-card-helpers';
import { customElement, property } from 'lit/decorators.js'; import { customElement, property } from 'lit/decorators.js';
import { import { CameraConfig, GalleryConfig, frigateCardConfigDefaults } from '../types.js';
CameraConfig,
GalleryConfig,
frigateCardConfigDefaults,
} from '../types.js';
import { BrowseMediaUtil } from '../browse-media-util.js'; import { BrowseMediaUtil } from '../browse-media-util.js';
import { View } from '../view.js'; import { View } from '../view.js';
import { THUMBNAIL_DETAILS_WIDTH_MIN } from './thumbnail.js'; import { THUMBNAIL_DETAILS_WIDTH_MIN } from './thumbnail.js';
@@ -35,28 +31,37 @@ export class FrigateCardGallery extends LitElement {
protected view?: Readonly<View>; protected view?: Readonly<View>;
@property({ attribute: false }) @property({ attribute: false })
protected cameraConfig?: CameraConfig; protected galleryConfig?: GalleryConfig;
@property({ attribute: false }) @property({ attribute: false })
protected galleryConfig?: GalleryConfig; protected cameras?: Map<string, CameraConfig>;
/** /**
* Master render method. * Master render method.
* @returns A rendered template. * @returns A rendered template.
*/ */
protected render(): TemplateResult | void { protected render(): TemplateResult | void {
if (!this.hass || !this.view || !this.cameraConfig || !this.view.isGalleryView()) { const mediaType = this.view?.getMediaType();
if (
!this.hass ||
!this.view ||
!this.cameras ||
!this.view.isGalleryView() ||
!mediaType
) {
return; return;
} }
if (!this.view.target) { if (!this.view.target) {
const browseMediaQueryParameters = BrowseMediaUtil.setMediaTypeFromView( const browseMediaQueryParameters =
BrowseMediaUtil.getBrowseMediaQueryParametersBaseOrDispatchError( BrowseMediaUtil.getFullDependentBrowseMediaQueryParametersOrDispatchError(
this, this,
this.cameraConfig, this.hass,
), this.cameras,
this.view, this.view.camera,
); mediaType,
);
if (!browseMediaQueryParameters) { if (!browseMediaQueryParameters) {
return; return;
} }
+10 -9
View File
@@ -19,7 +19,6 @@ import {
LiveProvider, LiveProvider,
TransitionEffect, TransitionEffect,
frigateCardConfigDefaults, frigateCardConfigDefaults,
BrowseMediaQueryParameters,
} from '../types.js'; } from '../types.js';
import { EmblaOptionsType, EmblaPluginType } from 'embla-carousel'; import { EmblaOptionsType, EmblaPluginType } from 'embla-carousel';
import { HomeAssistant } from 'custom-card-helpers'; import { HomeAssistant } from 'custom-card-helpers';
@@ -127,16 +126,18 @@ export class FrigateCardLive extends LitElement {
this.conditionState, this.conditionState,
) as LiveConfig; ) as LiveConfig;
const browseMediaParamsBase = BrowseMediaUtil.getBrowseMediaQueryParametersBase( const browseMediaParams =
this.cameras.get(this.view.camera), BrowseMediaUtil.getFullDependentBrowseMediaQueryParametersOrDispatchError(
); this,
if (!browseMediaParamsBase) { this.hass,
this.cameras,
this.view.camera,
config.controls.thumbnails.media,
);
if (!browseMediaParams) {
return; return;
} }
const browseMediaParams: BrowseMediaQueryParameters = {
...browseMediaParamsBase,
mediaType: config.controls.thumbnails.media,
}
// Note use of liveConfig and not config below -- the carousel will // Note use of liveConfig and not config below -- the carousel will
// independently override the liveconfig to reflect the camera in the // independently override the liveconfig to reflect the camera in the
+9 -4
View File
@@ -34,7 +34,9 @@ export class FrigateCardSurround extends LitElement {
protected targetView?: FrigateCardView; protected targetView?: FrigateCardView;
@property({ attribute: false }) @property({ attribute: false })
protected browseMediaParams?: BrowseMediaQueryParameters; protected browseMediaParams?:
| BrowseMediaQueryParameters
| BrowseMediaQueryParameters[];
// A task to await the load of the WebRTC component. // A task to await the load of the WebRTC component.
protected _browseTask = new Task(this, this._fetchMedia.bind(this), () => [ protected _browseTask = new Task(this, this._fetchMedia.bind(this), () => [
@@ -53,22 +55,25 @@ export class FrigateCardSurround extends LitElement {
| HomeAssistant | HomeAssistant
| Readonly<View> | Readonly<View>
| BrowseMediaQueryParameters | BrowseMediaQueryParameters
| BrowseMediaQueryParameters[]
| undefined | undefined
)[]): Promise<void> { )[]): Promise<void> {
hass = hass as HomeAssistant; hass = hass as HomeAssistant;
view = view as Readonly<View>; view = view as Readonly<View>;
browseMediaParams = browseMediaParams as BrowseMediaQueryParameters; browseMediaParams = browseMediaParams as
| BrowseMediaQueryParameters
| BrowseMediaQueryParameters[];
if (!hass || !view || view.target || !browseMediaParams) { if (!hass || !view || view.target || !browseMediaParams) {
return; return;
} }
let parent: FrigateBrowseMediaSource | null; let parent: FrigateBrowseMediaSource | null;
try { try {
parent = await BrowseMediaUtil.browseMediaQuery(hass, browseMediaParams); parent = await BrowseMediaUtil.multipleBrowseMediaQueryMerged(hass, browseMediaParams);
} catch (e) { } catch (e) {
return dispatchErrorMessageEvent(this, (e as Error).message); return dispatchErrorMessageEvent(this, (e as Error).message);
} }
if (BrowseMediaUtil.getFirstTrueMediaChildIndex(parent) != null) { if (BrowseMediaUtil.getFirstTrueMediaChildIndex(parent) !== null) {
this.view this.view
?.evolve({ ?.evolve({
...(this.targetView && { view: this.targetView }), ...(this.targetView && { view: this.targetView }),
+44 -55
View File
@@ -25,10 +25,9 @@ import { isEqual } from 'lodash-es';
import { BrowseMediaUtil } from '../browse-media-util'; import { BrowseMediaUtil } from '../browse-media-util';
import { import {
BrowseMediaQueryParameters,
CameraConfig, CameraConfig,
FrigateBrowseMediaSource, FrigateBrowseMediaSource,
MEDIA_CLASS_PLAYLIST,
MEDIA_TYPE_PLAYLIST,
TimelineConfig, TimelineConfig,
FrigateEvent, FrigateEvent,
frigateCardConfigDefaults, frigateCardConfigDefaults,
@@ -278,49 +277,47 @@ class TimelineEventManager {
} }
this._dateFetch = new Date(); this._dateFetch = new Date();
const fetchCameraEvents = async ( const params: BrowseMediaQueryParameters[] = [];
camera: string, cameras.forEach((cameraConfig, cameraID) => {
fetchMedia: 'clips' | 'snapshots', (media === 'all' ? ['clips', 'snapshots'] : [media]).forEach((mediaType) => {
): Promise<void> => { if (this._dateEnd && this._dateStart) {
const cameraConfig = cameras.get(camera); const param = BrowseMediaUtil.getBrowseMediaQueryParameters(
if (!cameraConfig || !this._dateStart || !this._dateEnd) { hass,
return; cameraID,
} cameraConfig,
const browseMediaQueryParametersBase = {
BrowseMediaUtil.getBrowseMediaQueryParametersBase(cameraConfig); // Events are always fetched for the maximum extent of the managed
if (!browseMediaQueryParametersBase) { // range. This is because events may change at any point in time
return; // (e.g. a long-running event that ends).
} before: this._dateEnd.getTime() / 1000,
try { after: this._dateStart.getTime() / 1000,
this._addMediaSource( unlimited: true,
camera, mediaType: mediaType as 'clips' | 'snapshots',
media, },
await BrowseMediaUtil.browseMediaQuery(hass, { );
...browseMediaQueryParametersBase, if (param) {
params.push(param);
}
}
});
});
// Events are always fetched for the maximum extent of the managed if (!params.length) {
// range. This is because events may change at any point in time return;
// (e.g. a long-running event that ends). }
before: this._dateEnd.getTime() / 1000,
after: this._dateStart.getTime() / 1000,
unlimited: true,
mediaType: fetchMedia,
}),
);
} catch (e) {
return dispatchErrorMessageEvent(element, (e as Error).message);
}
};
const promises: Promise<void>[] = []; let results: Map<BrowseMediaQueryParameters, FrigateBrowseMediaSource>;
(media === 'all' ? ['clips', 'snapshots'] : [media]).forEach((mediaType) => try {
promises.push( results = await BrowseMediaUtil.multipleBrowseMediaQuery(hass, params);
...Array.from(cameras.keys()).map((camera) => } catch (e) {
fetchCameraEvents(camera, mediaType as 'clips' | 'snapshots'), return dispatchErrorMessageEvent(element, (e as Error).message);
), }
),
); for (const [query, result] of results.entries()) {
await Promise.all(promises); if (query.cameraID) {
this._addMediaSource(query.cameraID, media, result);
}
}
} }
} }
@@ -574,18 +571,10 @@ export class FrigateCardTimelineCore extends LitElement {
return null; return null;
} }
const target = { const target = BrowseMediaUtil.createEventParentForChildren(
title: `Timeline events`, 'Timeline events',
media_class: MEDIA_CLASS_PLAYLIST, children,
media_content_type: MEDIA_TYPE_PLAYLIST, );
media_content_id: '',
can_play: false,
can_expand: true,
children_media_class: MEDIA_CLASS_PLAYLIST,
thumbnail: null,
children: children,
};
return { return {
target: target, target: target,
childIndex: childIndex < 0 ? null : childIndex, childIndex: childIndex < 0 ? null : childIndex,
+19 -17
View File
@@ -17,7 +17,7 @@ import { ref } from 'lit/directives/ref.js';
import { AutoMediaPlugin } from './embla-plugins/automedia.js'; import { AutoMediaPlugin } from './embla-plugins/automedia.js';
import type { import type {
BrowseMediaNeighbors, BrowseMediaNeighbors,
BrowseMediaQueryParametersBase, BrowseMediaQueryParameters,
FrigateBrowseMediaSource, FrigateBrowseMediaSource,
CameraConfig, CameraConfig,
MediaShowInfo, MediaShowInfo,
@@ -54,7 +54,7 @@ export class FrigateCardViewer extends LitElement {
protected viewerConfig?: ViewerConfig; protected viewerConfig?: ViewerConfig;
@property({ attribute: false }) @property({ attribute: false })
protected cameraConfig?: CameraConfig; protected cameras?: Map<string, CameraConfig>;
@property({ attribute: false }) @property({ attribute: false })
protected resolvedMediaCache?: ResolvedMediaCache; protected resolvedMediaCache?: ResolvedMediaCache;
@@ -64,21 +64,19 @@ export class FrigateCardViewer extends LitElement {
* @returns A rendered template. * @returns A rendered template.
*/ */
protected render(): TemplateResult | void { protected render(): TemplateResult | void {
if (!this.hass || !this.view || !this.cameraConfig || !this.viewerConfig) { if (!this.hass || !this.view || !this.cameras || !this.viewerConfig) {
return; return;
} }
const browseMediaQueryParametersBase = const browseMediaQueryParameters =
BrowseMediaUtil.getBrowseMediaQueryParametersBaseOrDispatchError( BrowseMediaUtil.getFullDependentBrowseMediaQueryParametersOrDispatchError(
this, this,
this.cameraConfig, this.hass,
this.cameras,
this.view.camera,
); );
if (!this.view.target) { if (!this.view.target) {
const browseMediaQueryParameters = BrowseMediaUtil.setMediaTypeFromView(
browseMediaQueryParametersBase,
this.view,
);
if (!browseMediaQueryParameters) { if (!browseMediaQueryParameters) {
return; return;
} }
@@ -101,7 +99,7 @@ export class FrigateCardViewer extends LitElement {
.hass=${this.hass} .hass=${this.hass}
.view=${this.view} .view=${this.view}
.viewerConfig=${this.viewerConfig} .viewerConfig=${this.viewerConfig}
.browseMediaQueryParametersBase=${browseMediaQueryParametersBase} .browseMediaQueryParameters=${browseMediaQueryParameters}
.resolvedMediaCache=${this.resolvedMediaCache} .resolvedMediaCache=${this.resolvedMediaCache}
> >
</frigate-card-viewer-carousel> </frigate-card-viewer-carousel>
@@ -133,7 +131,7 @@ export class FrigateCardViewerCarousel extends FrigateCardMediaCarousel {
protected viewerConfig?: ViewerConfig; protected viewerConfig?: ViewerConfig;
@property({ attribute: false }) @property({ attribute: false })
protected browseMediaQueryParametersBase?: BrowseMediaQueryParametersBase; protected browseMediaQueryParameters?: BrowseMediaQueryParameters[] | null;
@property({ attribute: false }) @property({ attribute: false })
protected resolvedMediaCache?: ResolvedMediaCache; protected resolvedMediaCache?: ResolvedMediaCache;
@@ -338,7 +336,7 @@ export class FrigateCardViewerCarousel extends FrigateCardMediaCarousel {
!this.view.target || !this.view.target ||
!this.view.target.children || !this.view.target.children ||
!this.view.target.children.length || !this.view.target.children.length ||
!this.browseMediaQueryParametersBase !this.browseMediaQueryParameters
) { ) {
return null; return null;
} }
@@ -379,13 +377,17 @@ export class FrigateCardViewerCarousel extends FrigateCardMediaCarousel {
let clips: FrigateBrowseMediaSource | null; let clips: FrigateBrowseMediaSource | null;
try { const params = BrowseMediaUtil.overrideMultiBrowseMediaQueryParameters(
clips = await BrowseMediaUtil.browseMediaQuery(this.hass, { this.browseMediaQueryParameters,
...this.browseMediaQueryParametersBase, {
mediaType: 'clips', mediaType: 'clips',
before: latest, before: latest,
after: earliest, after: earliest,
}); },
);
try {
clips = await BrowseMediaUtil.multipleBrowseMediaQueryMerged(this.hass, params);
} catch (e) { } catch (e) {
// This is best effort. // This is best effort.
return null; return null;
+1 -1
View File
@@ -276,7 +276,7 @@
"invalid_elements_config": "Invalid picture elements configuration", "invalid_elements_config": "Invalid picture elements configuration",
"jsmpeg_no_sign": "Could not retrieve or sign JSMPEG websocket path", "jsmpeg_no_sign": "Could not retrieve or sign JSMPEG websocket path",
"jsmpeg_no_player": "Could not start JSMPEG player", "jsmpeg_no_player": "Could not start JSMPEG player",
"no_camera_name": "Could not determine Frigate camera name for camera, please specify either 'camera_entity' or 'camera_name' for the following camera", "no_camera_name": "Could not determine a Frigate camera name for camera (or one of its dependents), please specify either 'camera_entity' or 'camera_name'",
"download_no_media": "No media to download", "download_no_media": "No media to download",
"download_no_event_id": "Could not extract Frigate event id from media", "download_no_event_id": "Could not extract Frigate event id from media",
"download_sign_failed": "Could not sign media URL for download" "download_sign_failed": "Could not sign media URL for download"
+18 -5
View File
@@ -327,6 +327,9 @@ const cameraConfigSchema = z
// Camera identifiers for WebRTC. // Camera identifiers for WebRTC.
webrtc_card: webrtcCardCameraConfigSchema.optional(), webrtc_card: webrtcCardCameraConfigSchema.optional(),
// Set of cameras IDs upon which this camera depends.
dependent_cameras: z.string().array().optional(),
}) })
.default(cameraConfigDefault); .default(cameraConfigDefault);
export type CameraConfig = z.infer<typeof cameraConfigSchema>; export type CameraConfig = z.infer<typeof cameraConfigSchema>;
@@ -936,11 +939,14 @@ export type MenuButton = z.infer<typeof menuButtonSchema>;
export interface ExtendedHomeAssistant extends HomeAssistant { export interface ExtendedHomeAssistant extends HomeAssistant {
hassUrl(path?): string; hassUrl(path?): string;
themes: Themes & { themes: Themes & {
darkMode?: boolean darkMode?: boolean;
}; };
} }
export interface BrowseMediaQueryParametersBase { export interface BrowseMediaQueryParameters {
// ========================================
// Parameters used to construct media query
// ========================================
mediaType?: 'clips' | 'snapshots'; mediaType?: 'clips' | 'snapshots';
clientId: string; clientId: string;
cameraName: string; cameraName: string;
@@ -949,10 +955,17 @@ export interface BrowseMediaQueryParametersBase {
before?: number; before?: number;
after?: number; after?: number;
unlimited?: boolean; unlimited?: boolean;
}
export interface BrowseMediaQueryParameters extends BrowseMediaQueryParametersBase { // ========================================
mediaType: 'clips' | 'snapshots'; // Parameters used to differentiate results
// ========================================
// Optional title to be used for separating results when merging multiple
// sets of results. See `mergeFrigateBrowseMediaSources()` .
title?: string;
// Optional camera-id to which this query is associated. May be used to map
// results to a particular camera within the card.
cameraID?: string;
} }
export interface BrowseMediaNeighbors { export interface BrowseMediaNeighbors {
+12
View File
@@ -110,6 +110,18 @@ export class View {
return ['snapshot', 'snapshots'].includes(this.view); return ['snapshot', 'snapshots'].includes(this.view);
} }
/**
* Get the media type for this view if available.
* @returns Whether the media is `clips` or `snapshots` or unknown (`null`)
*/
public getMediaType(): 'clips' | 'snapshots' | null {
return this.isClipRelatedView()
? 'clips'
: this.isSnapshotRelatedView()
? 'snapshots'
: null;
}
/** /**
* Get the media item that should be played. * Get the media item that should be played.
**/ **/