Dermot Duffy
cc376a8be1
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.
63 lines
1.4 KiB
Markdown
63 lines
1.4 KiB
Markdown
# Getting Started
|
|
|
|
## Installation
|
|
|
|
- [HACS](https://hacs.xyz/) is **highly** recommended to install the card -- it works for all Home Assistant variants. If you don't have [HACS](https://hacs.xyz/) installed, start there -- then come back to these instructions.
|
|
|
|
- Find the card in HACS:
|
|
|
|
```
|
|
Home Assistant > HACS > Frontend > "Explore & Add Integrations" > Frigate Card
|
|
```
|
|
|
|
[](./common/rename-hacs.md ':include')
|
|
|
|
- Click `Download this repository with HACS`.
|
|
|
|
See [Advanced Installation](advanced-installation.md) for other installation resources, or [Rolling Back](./rolling-back.md) to rollback to prior versions.
|
|
|
|
## Adding your card
|
|
|
|
- On a Home Assistant dashboard, choose:
|
|
|
|
```
|
|
[Three dots menu] > Edit dashboard
|
|
```
|
|
|
|
- Click `+ Add Card` shown on the bottom of the screen
|
|
- Choose `Custom: Advanced Camera Card` from the list
|
|
|
|
## Initial configuration
|
|
|
|
### Minimal configuration
|
|
|
|
```yaml
|
|
type: custom:advanced-camera-card
|
|
cameras:
|
|
- camera_entity: camera.office
|
|
```
|
|
|
|
### Video scrubbing configuration
|
|
|
|
```yaml
|
|
type: custom:advanced-camera-card
|
|
cameras:
|
|
- camera_entity: camera.office
|
|
profiles:
|
|
- scrubbing
|
|
```
|
|
|
|
### Multi-camera grid configuration
|
|
|
|
```yaml
|
|
type: custom:advanced-camera-card
|
|
cameras:
|
|
- camera_entity: camera.office
|
|
- camera_entity: camera.kitchen
|
|
live:
|
|
display:
|
|
mode: grid
|
|
```
|
|
|
|
See [Configuration](configuration/README.md) for full details on supported configuration options.
|