mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-10-10 00:32:48 +03:00
Nicolas Mowen
27a40a507b
* Implement hardware detection and UI management * Cleanup Frigate+ detection * Don't count model as changed * Fixes for audio map error * Add descriptions * Enforce that all model must exist * Fix hardware picking * Docs fixes * WebUI cleanup * Cleanup handling of scenes * UI refinement * Cleanup recommended UI * test fixews
89 lines
3.2 KiB
Markdown
89 lines
3.2 KiB
Markdown
---
|
|
id: plus
|
|
title: Frigate+
|
|
---
|
|
|
|
import NavPath from "@site/src/components/NavPath";
|
|
|
|
For more information about how to use Frigate+ to improve your model, see the [Frigate+ docs](/plus/).
|
|
|
|
:::info
|
|
|
|
Frigate+ requires an active internet connection to communicate with `https://api.frigate.video` for model downloads, image uploads, and annotations. See [Network Requirements](/frigate/network_requirements#frigate) for details.
|
|
|
|
:::
|
|
|
|
## Setup
|
|
|
|
### Create an account
|
|
|
|
Free accounts can be created at [https://plus.frigate.video](https://plus.frigate.video).
|
|
|
|
### Generate an API key
|
|
|
|
Once logged in, you can generate an API key for Frigate in Settings.
|
|
|
|
|
|
|
|
### Set your API key
|
|
|
|
In Frigate, you can use an environment variable or a docker secret named `PLUS_API_KEY` to enable the `Frigate+` buttons on the Explore page. Home Assistant App users can set it under Settings > Apps > Frigate > Configuration > Options (be sure to toggle the "Show unused optional configuration options" switch).
|
|
|
|
:::warning
|
|
|
|
You cannot use the `environment_vars` section of your Frigate configuration file to set this environment variable. It must be defined as an environment variable in the docker config or Home Assistant App config.
|
|
|
|
:::
|
|
|
|
## Submit examples
|
|
|
|
Once your API key is configured, you can submit examples directly from the Explore page in Frigate. From the More Filters menu, select "Has a Snapshot - Yes" and "Submitted to Frigate+ - No", and press Apply at the bottom of the pane. Then, click on a thumbnail and select the Snapshot tab.
|
|
|
|
You can use your keyboard's left and right arrow keys to quickly navigate between the tracked object snapshots.
|
|
|
|
:::note
|
|
|
|
Snapshots must be enabled to be able to submit examples to Frigate+
|
|
|
|
:::
|
|
|
|
|
|
|
|
### Annotate and verify
|
|
|
|
You can view all of your submitted images at [https://plus.frigate.video](https://plus.frigate.video). Annotations can be added by clicking an image. For more detailed information about labeling, see the documentation on [annotating](../plus/annotating.md).
|
|
|
|
|
|
|
|
## Use Models
|
|
|
|
Once you have [requested your first model](../plus/first_model.md) and gotten your own model ID, it can be used with a special model path. No other information needs to be configured for Frigate+ models because it fetches the remaining config from Frigate+ automatically.
|
|
|
|
You can either choose the new model from the <NavPath path="Settings > System > Detection models" /> pane in the Frigate UI (on the **Frigate+** tab of the model you want to change), or set it on that model in your config:
|
|
|
|
```yaml
|
|
models:
|
|
- devices: ...
|
|
path: plus://<your_model_id>
|
|
```
|
|
|
|
:::note
|
|
|
|
Model IDs are not secret values and can be shared freely. Access to your model is protected by your API key.
|
|
|
|
:::
|
|
|
|
Models are downloaded into the `/config/model_cache` folder and only downloaded if needed.
|
|
|
|
If needed, you can override the labelmap for Frigate+ models. This is not recommended as renaming labels will break the Submit to Frigate+ feature if the labels are not available in Frigate+.
|
|
|
|
```yaml
|
|
models:
|
|
- devices: ...
|
|
path: plus://<your_model_id>
|
|
labelmap:
|
|
3: animal
|
|
4: animal
|
|
5: animal
|
|
```
|