feat: Rename the card to advanced-camera-card (#1873)

Whilst the Frigate support in this card is the best among camera
engines, the name incorrectly suggests that Frigate is a requirement.
Instead, to broaden the appeal, change to more camera agnostic name.
This does not suggest any change in priority, role or support for
Frigate.

This change is likely to be bug prone, due to the size of the rename --
the code contains 1500+ references to "Frigate" most of which make sense
to rename, some which do not, all of which needed human assessment.

- Closes #1298


BREAKING CHANGE: References to `frigate-card` in all kinds of
configuration need to be updated to `advanced-camera-card`. An automated
config upgrade should take care of the majority of usecases (click `Edit
-> Upgrade -> Save`), though may not be perfect.
This commit is contained in:
Dermot Duffy
2025-02-06 19:32:32 -08:00
committed by GitHub
parent 43947b49dc
commit cc376a8be1
305 changed files with 4270 additions and 3686 deletions
+35 -35
View File
@@ -43,8 +43,8 @@ export class ActionFactory {
cardID?: string;
},
): Action | null {
const frigateCardAction = convertActionToCardCustomAction(action);
if (action.action !== 'fire-dom-event' || !frigateCardAction) {
const cardCustomAction = convertActionToCardCustomAction(action);
if (action.action !== 'fire-dom-event' || !cardCustomAction) {
// * There is a slight typing (but not functional) difference between
// ActionType in this card and ActionConfig in `custom-card-helpers`. See
// `ExtendedConfirmationRestrictionConfig` in `types.ts` for the source and
@@ -54,15 +54,15 @@ export class ActionFactory {
if (
// Command not intended for this card (e.g. query string command).
frigateCardAction.card_id &&
frigateCardAction.card_id !== options?.cardID
cardCustomAction.card_id &&
cardCustomAction.card_id !== options?.cardID
) {
return null;
}
switch (frigateCardAction.frigate_card_action) {
switch (cardCustomAction.advanced_camera_card_action) {
case 'default':
return new DefaultAction(context, frigateCardAction, options?.config);
return new DefaultAction(context, cardCustomAction, options?.config);
case 'clip':
case 'clips':
case 'image':
@@ -73,70 +73,70 @@ export class ActionFactory {
case 'snapshots':
case 'timeline':
case 'diagnostics':
return new ViewAction(context, frigateCardAction, options?.config);
return new ViewAction(context, cardCustomAction, options?.config);
case 'sleep':
return new SleepAction(context, frigateCardAction, options?.config);
return new SleepAction(context, cardCustomAction, options?.config);
case 'download':
return new DownloadAction(context, frigateCardAction, options?.config);
return new DownloadAction(context, cardCustomAction, options?.config);
case 'camera_ui':
return new CameraUIAction(context, frigateCardAction, options?.config);
return new CameraUIAction(context, cardCustomAction, options?.config);
case 'expand':
return new ExpandAction(context, frigateCardAction, options?.config);
return new ExpandAction(context, cardCustomAction, options?.config);
case 'fullscreen':
return new FullscreenAction(context, frigateCardAction, options?.config);
return new FullscreenAction(context, cardCustomAction, options?.config);
case 'menu_toggle':
return new MenuToggleAction(context, frigateCardAction, options?.config);
return new MenuToggleAction(context, cardCustomAction, options?.config);
case 'camera_select':
return new CameraSelectAction(context, frigateCardAction, options?.config);
return new CameraSelectAction(context, cardCustomAction, options?.config);
case 'live_substream_select':
return new SubstreamSelectAction(context, frigateCardAction, options?.config);
return new SubstreamSelectAction(context, cardCustomAction, options?.config);
case 'live_substream_off':
return new SubstreamOffAction(context, frigateCardAction, options?.config);
return new SubstreamOffAction(context, cardCustomAction, options?.config);
case 'live_substream_on':
return new SubstreamOnAction(context, frigateCardAction, options?.config);
return new SubstreamOnAction(context, cardCustomAction, options?.config);
case 'media_player':
return new MediaPlayerAction(context, frigateCardAction, options?.config);
return new MediaPlayerAction(context, cardCustomAction, options?.config);
case 'microphone_connect':
return new MicrophoneConnectAction(context, frigateCardAction, options?.config);
return new MicrophoneConnectAction(context, cardCustomAction, options?.config);
case 'microphone_disconnect':
return new MicrophoneDisconnectAction(
context,
frigateCardAction,
cardCustomAction,
options?.config,
);
case 'microphone_mute':
return new MicrophoneMuteAction(context, frigateCardAction, options?.config);
return new MicrophoneMuteAction(context, cardCustomAction, options?.config);
case 'microphone_unmute':
return new MicrophoneUnmuteAction(context, frigateCardAction, options?.config);
return new MicrophoneUnmuteAction(context, cardCustomAction, options?.config);
case 'mute':
return new MuteAction(context, frigateCardAction, options?.config);
return new MuteAction(context, cardCustomAction, options?.config);
case 'unmute':
return new UnmuteAction(context, frigateCardAction, options?.config);
return new UnmuteAction(context, cardCustomAction, options?.config);
case 'play':
return new PlayAction(context, frigateCardAction, options?.config);
return new PlayAction(context, cardCustomAction, options?.config);
case 'pause':
return new PauseAction(context, frigateCardAction, options?.config);
return new PauseAction(context, cardCustomAction, options?.config);
case 'screenshot':
return new ScreenshotAction(context, frigateCardAction, options?.config);
return new ScreenshotAction(context, cardCustomAction, options?.config);
case 'display_mode_select':
return new DisplayModeSelectAction(context, frigateCardAction, options?.config);
return new DisplayModeSelectAction(context, cardCustomAction, options?.config);
case 'ptz':
return new PTZAction(context, frigateCardAction, options?.config);
return new PTZAction(context, cardCustomAction, options?.config);
case 'ptz_digital':
return new PTZDigitalAction(context, frigateCardAction, options?.config);
return new PTZDigitalAction(context, cardCustomAction, options?.config);
case 'ptz_multi':
return new PTZMultiAction(context, frigateCardAction, options?.config);
return new PTZMultiAction(context, cardCustomAction, options?.config);
case 'ptz_controls':
return new PTZControlsAction(context, frigateCardAction, options?.config);
return new PTZControlsAction(context, cardCustomAction, options?.config);
case 'log':
return new LogAction(context, frigateCardAction, options?.config);
return new LogAction(context, cardCustomAction, options?.config);
case 'status_bar':
return new StatusBarAction(context, frigateCardAction, options?.config);
return new StatusBarAction(context, cardCustomAction, options?.config);
}
/* istanbul ignore next: this path cannot be reached -- @preserve */
console.warn(
`Frigate card received unknown card action: ${frigateCardAction['frigate_card_action']}`,
`Advanced Camera Card received unknown card action: ${cardCustomAction['advanced_camera_card_action']}`,
);
/* istanbul ignore next: this path cannot be reached -- @preserve */
return null;