Merge pull request #932 from dermotduffy/camera-capabilities

Don't show the timeline if no cameras support it
This commit is contained in:
Dermot Duffy
2023-02-11 07:36:23 -08:00
committed by GitHub
12 changed files with 148 additions and 129 deletions
+5 -2
View File
@@ -14,7 +14,7 @@ import {
RecordingQueryResultsMap,
RecordingSegmentsQuery,
RecordingSegmentsQueryResultsMap,
CameraManagerEngineCapabilities,
CameraManagerCameraCapabilities,
CameraManagerMediaCapabilities,
CameraManagerCameraMetadata,
} from './types';
@@ -100,6 +100,9 @@ export interface CameraManagerEngine {
cameraConfig: CameraConfig,
): CameraManagerCameraMetadata;
getCapabilities(): CameraManagerEngineCapabilities | null;
getCameraCapabilities(
cameraConfig: CameraConfig,
): CameraManagerCameraCapabilities | null;
getMediaCapabilities(media: ViewMedia): CameraManagerMediaCapabilities | null;
}
+8 -4
View File
@@ -13,7 +13,7 @@ import {
import { DateRange } from '../range';
import {
CameraManagerCameraMetadata,
CameraManagerEngineCapabilities,
CameraManagerCameraCapabilities,
CameraManagerMediaCapabilities,
DataQuery,
Engine,
@@ -805,10 +805,14 @@ export class FrigateCameraManagerEngine implements CameraManagerEngine {
return seekMilliseconds / 1000;
}
public getCapabilities(): CameraManagerEngineCapabilities {
public getCameraCapabilities(
cameraConfig: CameraConfig,
): CameraManagerCameraCapabilities {
const isBirdseye = cameraConfig.frigate.camera_name === CAMERA_BIRDSEYE;
return {
canFavoriteEvents: true,
canFavoriteRecordings: false,
canFavoriteEvents: !isBirdseye,
canFavoriteRecordings: !isBirdseye,
supportsTimeline: !isBirdseye,
};
}
+35 -17
View File
@@ -2,6 +2,7 @@ import { HomeAssistant } from 'custom-card-helpers';
import { CameraConfig, CardWideConfig } from '../types.js';
import { allPromises, arrayify, setify } from '../utils/basic.js';
import {
CameraManagerCameraCapabilities,
CameraManagerCameraMetadata,
CameraManagerCapabilities,
CameraManagerMediaCapabilities,
@@ -312,22 +313,6 @@ export class CameraManager {
return engine.getMediaDownloadPath(cameraConfig, media);
}
public getCapabilities(): CameraManagerCapabilities | null {
const engines = this._engineFactory.getAllEngines(this._cameras);
if (!engines) {
return null;
}
return {
canFavoriteEvents: engines.some(
(engine) => engine.getCapabilities()?.canFavoriteEvents,
),
canFavoriteRecordings: engines.some(
(engine) => engine.getCapabilities()?.canFavoriteRecordings,
),
};
}
public getMediaCapabilities(media: ViewMedia): CameraManagerMediaCapabilities | null {
const engine = this._engineFactory.getEngineForMedia(this._cameras, media);
if (!engine) {
@@ -534,12 +519,45 @@ export class CameraManager {
public getCameraMetadata(
hass: HomeAssistant,
cameraConfig?: CameraConfig,
cameraID: string,
): CameraManagerCameraMetadata | null {
const cameraConfig = this._cameras.get(cameraID);
const engine = this._engineFactory.getEngineForCamera(cameraConfig);
if (!engine || !cameraConfig) {
return null;
}
return engine.getCameraMetadata(hass, cameraConfig);
}
public getCameraCapabilities(
cameraID: string,
): CameraManagerCameraCapabilities | null {
const cameraConfig = this._cameras.get(cameraID);
if (!cameraConfig) {
return null;
}
const engine = this._engineFactory.getEngineForCamera(cameraConfig);
if (!engine) {
return null;
}
return engine.getCameraCapabilities(cameraConfig);
}
public getAggregateCameraCapabilities(
cameraIDs?: Set<string>,
): CameraManagerCapabilities {
const perCameraCapabilities = [...(cameraIDs ?? this._cameras.keys())].map(
(cameraID) => this.getCameraCapabilities(cameraID),
);
return {
canFavoriteEvents: perCameraCapabilities.some((cap) => cap?.canFavoriteEvents),
canFavoriteRecordings: perCameraCapabilities.some(
(cap) => cap?.canFavoriteRecordings,
),
supportsTimeline: perCameraCapabilities.some((cap) => cap?.supportsTimeline),
};
}
}
+2 -1
View File
@@ -85,10 +85,11 @@ export interface MediaMetadata {
interface BaseCapabilities {
canFavoriteEvents: boolean;
canFavoriteRecordings: boolean;
supportsTimeline: boolean;
}
export type CameraManagerCapabilities = BaseCapabilities;
export type CameraManagerEngineCapabilities = BaseCapabilities;
export type CameraManagerCameraCapabilities = BaseCapabilities;
export interface CameraManagerMediaCapabilities {
canFavorite: boolean;
}
+7 -5
View File
@@ -399,12 +399,12 @@ class FrigateCard extends LitElement {
});
if (this._cameras && this._cameras.size > 1) {
const menuItems = Array.from(this._cameras, ([camera, config]) => {
const menuItems = Array.from(this._cameras, ([cameraID, config]) => {
const action = createFrigateCardCustomAction('camera_select', {
camera: camera,
camera: cameraID,
});
const metadata = this._hass
? this._cameraManager?.getCameraMetadata(this._hass, config) ?? undefined
? this._cameraManager?.getCameraMetadata(this._hass, cameraID) ?? undefined
: undefined;
return {
@@ -413,7 +413,7 @@ class FrigateCard extends LitElement {
entity: config.camera_entity,
state_color: true,
title: metadata?.title,
selected: this._view?.camera === camera,
selected: this._view?.camera === cameraID,
...(action && { tap_action: action }),
};
});
@@ -1427,7 +1427,9 @@ class FrigateCard extends LitElement {
} else if (this._view?.is('live') && cameraEntity) {
media_content_id = `media-source://camera/${cameraEntity}`;
media_content_type = 'application/vnd.apple.mpegurl';
title = this._cameraManager.getCameraMetadata(this._hass, cameraConfig)?.title ?? null;
title =
this._cameraManager.getCameraMetadata(this._hass, this._view.camera)?.title ??
null;
thumbnail = this._hass?.states[cameraEntity]?.attributes?.entity_picture ?? null;
}
-1
View File
@@ -343,7 +343,6 @@ export class FrigateCardGalleryCore extends LitElement {
.hass=${this.hass}
.cameraManager=${this.cameraManager}
.media=${media}
.cameraConfig=${this.cameras?.get(media.getCameraID())}
.view=${this.view}
?details=${!!this.galleryConfig?.controls.thumbnails.show_details}
?show_favorite_control=${!!this.galleryConfig?.controls.thumbnails
+6 -7
View File
@@ -489,7 +489,7 @@ export class FrigateCardLiveCarousel extends LitElement {
}
protected _renderLive(
camera: string,
cameraID: string,
cameraConfig: CameraConfig,
slideIndex: number,
): TemplateResult | void {
@@ -501,7 +501,7 @@ export class FrigateCardLiveCarousel extends LitElement {
// <frigate-card-live-provider> is rendering right now.
const conditionState = {
...this.conditionState,
camera: camera,
camera: cameraID,
};
const config = getOverriddenConfig(
@@ -510,7 +510,7 @@ export class FrigateCardLiveCarousel extends LitElement {
conditionState,
) as LiveConfig;
const cameraMetadata = this.cameraManager.getCameraMetadata(this.hass, cameraConfig);
const cameraMetadata = this.cameraManager.getCameraMetadata(this.hass, cameraID);
return html`
<div class="embla__slide">
@@ -560,7 +560,6 @@ export class FrigateCardLiveCarousel extends LitElement {
if (
!slides.length ||
!this.liveConfig ||
!this.cameras ||
!this.view ||
!this.hass ||
!this.cameraManager
@@ -578,15 +577,15 @@ export class FrigateCardLiveCarousel extends LitElement {
const cameraMetadataPrevious = prevID ? this.cameraManager.getCameraMetadata(
this.hass,
this.cameras.get(prevID),
prevID,
) : null;
const cameraMetadataCurrent = this.cameraManager.getCameraMetadata(
this.hass,
this.cameras.get(this.view.camera),
this.view.camera,
);
const cameraMetadataNext = nextID ? this.cameraManager.getCameraMetadata(
this.hass,
this.cameras.get(nextID),
nextID,
) : null;
// Notes on the below:
+4 -6
View File
@@ -272,14 +272,12 @@ class FrigateCardMediaFilter extends ScopedRegistryHost(LitElement) {
protected willUpdate(changedProps: PropertyValues): void {
if (changedProps.has('cameras') && this.cameras) {
this._cameraOptions = Array.from(this.cameras.entries()).map(
([cameraID, cameraConfig]) => ({
this._cameraOptions = Array.from(this.cameras.keys()).map((cameraID) => ({
value: cameraID,
label: this.hass
? this.cameraManager?.getCameraMetadata(this.hass, cameraConfig)?.title ?? ''
? this.cameraManager?.getCameraMetadata(this.hass, cameraID)?.title ?? ''
: '',
}),
);
}));
}
if (changedProps.has('cameraManager') && this.hass && this.cameraManager) {
@@ -413,7 +411,7 @@ class FrigateCardMediaFilter extends ScopedRegistryHost(LitElement) {
const areRecordings = !!(
this.view?.query && MediaQueriesClassifier.areRecordingQueries(this.view.query)
);
const managerCapabilities = this.cameraManager?.getCapabilities();
const managerCapabilities = this.cameraManager?.getAggregateCameraCapabilities();
// Which media controls are shown depends on the view.
const showFavoriteControl = areEvents
-1
View File
@@ -190,7 +190,6 @@ export class FrigateCardSurround extends LitElement {
.config=${this.thumbnailConfig}
.cameraManager=${this.cameraManager}
.view=${this.view}
.cameras=${this.cameras}
.selected=${this.view.queryResults?.getSelectedIndex() ?? undefined}
@frigate-card:view:change=${(ev: CustomEvent) => changeDrawer(ev, 'close')}
@frigate-card:thumbnail-carousel:tap=${(
+1 -6
View File
@@ -39,9 +39,6 @@ export class FrigateCardThumbnailCarousel extends LitElement {
@property({ attribute: false })
public view?: Readonly<View>;
@property({ attribute: false })
public cameras?: Map<string, CameraConfig>;
@property({ attribute: false })
public cameraManager?: CameraManager;
@@ -150,8 +147,7 @@ export class FrigateCardThumbnailCarousel extends LitElement {
*/
protected _renderThumbnail(index: number): TemplateResult | void {
const media = this.view?.queryResults?.getResult(index) ?? null;
const cameraConfig = media ? this.cameras?.get(media.getCameraID()) : null;
if (!media || !cameraConfig || !this.view) {
if (!media || !this.view) {
return;
}
@@ -166,7 +162,6 @@ export class FrigateCardThumbnailCarousel extends LitElement {
.cameraManager=${this.cameraManager}
.hass=${this.hass}
.media=${media}
.cameraConfig=${cameraConfig}
.view=${this.view}
.seek=${seekTarget && media.includesTime(seekTarget) ? seekTarget : undefined}
?details=${!!this.config?.show_details}
+7 -8
View File
@@ -21,7 +21,7 @@ import { createFetchThumbnailTask, FetchThumbnailTaskArgs } from '../utils/thumb
import { View } from '../view/view.js';
import { Task, TaskStatus } from '@lit-labs/task';
import type { CameraConfig, ExtendedHomeAssistant } from '../types.js';
import type { ExtendedHomeAssistant } from '../types.js';
import { EventViewMedia, RecordingViewMedia, ViewMedia } from '../view/media.js';
import { CameraManager } from '../camera-manager/manager.js';
import { ViewMediaClassifier } from '../view/media-classifier.js';
@@ -245,9 +245,6 @@ export class FrigateCardThumbnail extends LitElement {
@property({ attribute: true })
public media?: ViewMedia;
@property({ attribute: false })
public cameraConfig?: CameraConfig;
@property({ attribute: true, type: Boolean })
public details = false;
@@ -268,7 +265,7 @@ export class FrigateCardThumbnail extends LitElement {
* @returns A template to display to the user.
*/
protected render(): TemplateResult | void {
if (!this.media || !this.cameraConfig || !this.cameraManager || !this.hass) {
if (!this.media || !this.cameraManager || !this.hass) {
return;
}
@@ -293,7 +290,10 @@ export class FrigateCardThumbnail extends LitElement {
this.hass &&
this.cameraManager?.getMediaCapabilities(this.media)?.canFavorite;
const cameraTitle = this.cameraManager.getCameraMetadata(this.hass, this.cameraConfig)?.title;
const cameraTitle = this.cameraManager.getCameraMetadata(
this.hass,
this.media.getCameraID(),
)?.title;
return html` ${ViewMediaClassifier.isEvent(this.media)
? html`<frigate-card-thumbnail-feature-event
@@ -364,8 +364,7 @@ export class FrigateCardThumbnail extends LitElement {
})
.removeContext('timeline')
.dispatchChangeEvent(this);
}
}
}}
></ha-icon>`
: ''}`;
}
+15 -13
View File
@@ -149,7 +149,6 @@ export class FrigateCardTimelineThumbnail extends LitElement {
return html` <frigate-card-thumbnail
.hass=${dataRequest.hass}
.cameraManager=${dataRequest.cameraManager}
.cameraConfig=${dataRequest.cameraConfig}
.media=${dataRequest.media}
.view=${dataRequest.view}
?details=${this.details}
@@ -259,7 +258,12 @@ export class FrigateCardTimelineCore extends LitElement {
if (!this.hass || !this.view || !this.timelineConfig) {
return;
}
return html`<div
const capabilities = this.cameraManager?.getAggregateCameraCapabilities(
this._getTimelineCameraIDs(),
);
return html` ${capabilities?.supportsTimeline
? html` <div
@frigate-card:timeline:thumbnail-data-request=${this._handleThumbnailDataRequest.bind(
this,
)}
@@ -275,10 +279,13 @@ export class FrigateCardTimelineCore extends LitElement {
aria-label="${this._locked
? localize('timeline.unlock')
: localize('timeline.lock')}"
title="${this._locked ? localize('timeline.unlock') : localize('timeline.lock')}"
title="${this._locked
? localize('timeline.unlock')
: localize('timeline.lock')}"
>
</ha-icon>
</div>`;
</div>`
: ''}`;
}
/**
@@ -686,15 +693,10 @@ export class FrigateCardTimelineCore extends LitElement {
if (!this.hass || !cameraConfig || !this.cameraManager) {
return;
}
const cameraMetadata = this.cameraManager.getCameraMetadata(
this.hass,
cameraConfig,
);
if (
cameraMetadata &&
cameraConfig.frigate.camera_name &&
cameraConfig.frigate.camera_name !== CAMERA_BIRDSEYE
) {
const cameraMetadata = this.cameraManager.getCameraMetadata(this.hass, cameraID);
const cameraCapabilities = this.cameraManager.getCameraCapabilities(cameraID);
if (cameraMetadata && cameraCapabilities?.supportsTimeline) {
groups.push({
id: cameraID,
content: cameraMetadata.title,