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:
@@ -23,7 +23,7 @@ challenging.
|
||||
## Example configuration
|
||||
|
||||
```yaml
|
||||
type: custom:frigate-card
|
||||
type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.office
|
||||
live_provider: go2rtc
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
This card allows casting a camera stream to a Google Cast device. You can enable the cast button with:
|
||||
|
||||
```yaml
|
||||
type: custom:frigate-card
|
||||
type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.office
|
||||
live_provider: go2rtc
|
||||
@@ -21,7 +21,7 @@ There are two different casting methods for cameras: `standard` and `dashboard`
|
||||
This is the default casting method.
|
||||
|
||||
```yaml
|
||||
type: custom:frigate-card
|
||||
type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.office
|
||||
live_provider: go2rtc
|
||||
@@ -41,7 +41,7 @@ The main disadvantage of this method is that the stream will be played through H
|
||||
This method is powered by [Home Assistant Cast](https://cast.home-assistant.io) and requires additional configuration, but allows **low latency streaming** with go2rtc.
|
||||
|
||||
```yaml
|
||||
type: custom:frigate-card
|
||||
type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.office
|
||||
live_provider: go2rtc
|
||||
@@ -68,7 +68,7 @@ For the example above to work, a dashboard with `dashboard-cast` URL must exist:
|
||||
|
||||

|
||||
|
||||
Within that dashboard, create an `office` view and finally within that view you can place the Frigate card configured for that camera for a proper full-screen casting experience:
|
||||
Within that dashboard, create an `office` view and finally within that view you can place the Advanced Camera Card configured for that camera for a proper full-screen casting experience:
|
||||
|
||||
```yaml
|
||||
views:
|
||||
@@ -76,7 +76,7 @@ views:
|
||||
type: panel
|
||||
path: office
|
||||
cards:
|
||||
- type: custom:frigate-card
|
||||
- type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.office
|
||||
live_provider: go2rtc
|
||||
@@ -92,7 +92,7 @@ The `casting` profile pre-configures the card to be casted to a 16:9 screen (suc
|
||||
When casting to a Google Nest Hub, the following configuration can be used:
|
||||
|
||||
```yaml
|
||||
type: custom:frigate-card
|
||||
type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.office
|
||||
live_provider: go2rtc
|
||||
|
||||
+13
-11
@@ -1,12 +1,12 @@
|
||||
# URL Actions
|
||||
|
||||
It is possible to pass the Frigate card one or more
|
||||
It is possible to pass the Advanced Camera Card one or more
|
||||
[actions](../configuration/actions/README.md) from the URL (e.g. select a particular
|
||||
camera, open the live view in expanded mode, etc).
|
||||
|
||||
### When actions are executed
|
||||
|
||||
The Frigate card will execute these actions in the following circumstances:
|
||||
The Advanced Camera Card will execute these actions in the following circumstances:
|
||||
|
||||
- On initial card load.
|
||||
- On 'tab' change in a dashboard.
|
||||
@@ -17,28 +17,30 @@ The Frigate card will execute these actions in the following circumstances:
|
||||
|
||||
## Instructions
|
||||
|
||||
To send an action to _all_ Frigate Cards on a dashboard:
|
||||
To send an action to _all_ Advanced Camera Cards on a dashboard:
|
||||
|
||||
```
|
||||
[PATH_TO_YOUR_HA_DASHBOARD]?frigate-card-action.[ACTION]=[VALUE]
|
||||
[PATH_TO_YOUR_HA_DASHBOARD]?advanced-camera-card-action.[ACTION]=[VALUE]
|
||||
```
|
||||
|
||||
To send an action to a specific named Frigate Card:
|
||||
To send an action to a specific named Advanced Camera Card:
|
||||
|
||||
```
|
||||
[PATH_TO_YOUR_HA_DASHBOARD]?frigate-card-action.[CARD_ID].[ACTION]=[VALUE]
|
||||
[PATH_TO_YOUR_HA_DASHBOARD]?advanced-camera-card-action.[CARD_ID].[ACTION]=[VALUE]
|
||||
```
|
||||
|
||||
?> For backwards compatibility, the card will also respond to `frigate-card-action` as a query-parameter with the same syntax.
|
||||
|
||||
| Parameter | Description |
|
||||
| --------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `ACTION` | One of the supported Frigate Card custom actions. See below. |
|
||||
| `ACTION` | One of the supported Advanced Camera Card custom actions. See below. |
|
||||
| `CARD_ID` | When specified only cards that have a [`card_id`](../configuration/README.md) parameter will act. |
|
||||
| `VALUE` | An optional value to use with the `camera_select` and `live_substream_select` actions. |
|
||||
|
||||
?> Both `.` and `:` may be used as the delimiter. If you use `:` some
|
||||
browsers may require it be escaped to `%3A`.
|
||||
|
||||
!> If a dashboard has multiple Frigate cards on it, even if they are on
|
||||
!> If a dashboard has multiple Advanced Camera Cards on it, even if they are on
|
||||
different 'tabs' within that dashboard, they will all respond to the actions
|
||||
unless the action is targeted with a `CARD_ID` as shown above.
|
||||
|
||||
@@ -59,16 +61,16 @@ Only a subset of all [actions](../configuration/actions/README.md) are supported
|
||||
| `image` | :white_check_mark: | |
|
||||
| `live_substream_select` | :white_check_mark: | |
|
||||
| `live` | :white_check_mark: | |
|
||||
| `media_player` | :heavy_multiplication_x: | Please [request](https://github.com/dermotduffy/frigate-hass-card/issues) if you need this. |
|
||||
| `media_player` | :heavy_multiplication_x: | Please [request](https://github.com/dermotduffy/advanced-camera-card/issues) if you need this. |
|
||||
| `menu_toggle` | :white_check_mark: | |
|
||||
| `microphone_connect`, `microphone_disconnect`, `microphone_mute`, `microphone_unmute` | :heavy_multiplication_x: | |
|
||||
| `mute`, `unmute` | :heavy_multiplication_x: | |
|
||||
| `play`, `pause` | :heavy_multiplication_x: | |
|
||||
| `ptz` | :heavy_multiplication_x: | Please [request](https://github.com/dermotduffy/frigate-hass-card/issues) if you need this. |
|
||||
| `ptz` | :heavy_multiplication_x: | Please [request](https://github.com/dermotduffy/advanced-camera-card/issues) if you need this. |
|
||||
| `recording` | :white_check_mark: | |
|
||||
| `recordings` | :white_check_mark: | |
|
||||
| `screenshot` | :heavy_multiplication_x: | Latest media information is not available on initial render. |
|
||||
| `ptz_controls` | :heavy_multiplication_x: | Please [request](https://github.com/dermotduffy/frigate-hass-card/issues) if you need this. |
|
||||
| `ptz_controls` | :heavy_multiplication_x: | Please [request](https://github.com/dermotduffy/advanced-camera-card/issues) if you need this. |
|
||||
| `snapshot` | :white_check_mark: | |
|
||||
| `snapshots` | :white_check_mark: | |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user