chris/frigate
1
0
Fork 0
forked from Github/frigate
Code Pull Requests Packages Activity

Update docs deps (#10591)

Browse Source 
* remove deprecated caution in facor of warning

* Update last dep
This commit is contained in:
Nicolas Mowen
2024-03-21 11:52:45 -06:00
committed by GitHub
parent 0ac7aaabe3
commit e5595ebb2f
15 changed files with 74 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/docs/integrations/api.md
View File

@@ -29,8 +29,8 @@ Sample response:
/***************
* Frames per second being consumed from your camera. If this is higher
* than it is supposed to be, you should set -r FPS in your input_args.
* camera_fps = process_fps + skipped_fps
***************/
* camera_fps = process_fps + skipped_fps
***************/
"camera_fps": 5.0,
/***************
* Number of times detection is run per second. This can be higher than
@@ -40,19 +40,19 @@ Sample response:
"detection_fps": 1.5,
/***************
* PID for the ffmpeg process that consumes this camera
***************/
***************/
"capture_pid": 27,
/***************
* PID for the process that runs detection for this camera
***************/
* PID for the process that runs detection for this camera
***************/
"pid": 34,
/***************
* Frames per second being processed by Frigate.
***************/
* Frames per second being processed by Frigate.
***************/
"process_fps": 5.1,
/***************
* Frames per second skip for processing by Frigate.
***************/
* Frames per second skip for processing by Frigate.
***************/
"skipped_fps": 0.0
}
},
@@ -117,15 +117,15 @@ Sample response:
"cmdline": "ffmpeg...",
"cpu": "5.0",
"cpu_average": "3.0",
"mem": "0.5",
"mem": "0.5"
}
},
"gpu_usages": {
"gpu-type": {
"gpu": "17%",
"mem": "18%",
},
},
"mem": "18%"
}
}
}
```
@@ -278,7 +278,7 @@ Sub labels must be 100 characters or shorter.
```json
{
"subLabel": "some_string",
"subLabelScore": 0.79,
"subLabelScore": 0.79
}
```
@@ -317,7 +317,7 @@ Accepts the following query string parameters, but they are only applied when an
Create a manual event with a given `label` (ex: doorbell press) to capture a specific event besides an object being detected.
:::caution
:::warning
Recording retention config still applies to manual events, if frigate is configured with `mode: motion` then the manual event will only keep recording segments when motion occurred.
@@ -409,7 +409,7 @@ It is also possible to export this recording as a time-lapse.
```json
{
"playback": "realtime", // playback factor: realtime or timelapse_25x
"playback": "realtime" // playback factor: realtime or timelapse_25x
}
```
@@ -444,25 +444,25 @@ Returns the snapshot image from the specific point in that cameras recordings.
Reviews from the database. Accepts the following query string parameters:
| param | Type | Description |
| -------------------- | ----- | ---------------------------------------------------------------------- |
| `before` | int | Epoch time |
| `after` | int | Epoch time |
| `cameras` | str | , separated list of cameras |
| `labels` | str | , separated list of labels |
| `reviewed` | int | Include items that have been reviewed (0 or 1) |
| `limit` | int | Limit the number of events returned |
| `severity` | str | Limit items to severity (alert, detection, significant_motion) |
| param | Type | Description |
| ---------- | ---- | -------------------------------------------------------------- |
| `before` | int | Epoch time |
| `after` | int | Epoch time |
| `cameras` | str | , separated list of cameras |
| `labels` | str | , separated list of labels |
| `reviewed` | int | Include items that have been reviewed (0 or 1) |
| `limit` | int | Limit the number of events returned |
| `severity` | str | Limit items to severity (alert, detection, significant_motion) |
### `GET /api/review/summary`
Summary of reviews for the last 30 days. Accepts the following query string parameters:
| param | Type | Description |
| -------------------- | ----- | ---------------------------------------------------------------------- |
| `cameras` | str | , separated list of cameras |
| `labels` | str | , separated list of labels |
| `timezone` | str | Timezone name |
| param | Type | Description |
| ---------- | ---- | --------------------------- |
| `cameras` | str | , separated list of cameras |
| `labels` | str | , separated list of labels |
| `timezone` | str | Timezone name |
### `POST /api/review/<id>/viewed`

2
docs/docs/integrations/plus.md
View File

@@ -21,7 +21,7 @@ Once logged in, you can generate an API key for Frigate in Settings.
In Frigate, you can use an environment variable or a docker secret named `PLUS_API_KEY` to enable the `SEND TO FRIGATE+` buttons on the events page. Home Assistant Addon users can set it under Settings > Addons > Frigate NVR > Configuration > Options (be sure to toggle the "Show unused optional configuration options" switch).
:::caution
:::warning
You cannot use the `environment_vars` section of your configuration file to set this environment variable.

2
docs/docs/integrations/third_party_extensions.md
View File

@@ -6,7 +6,7 @@ title: Third Party Extensions
Being open source, others have the possibility to modify and extend the rich functionality Frigate already offers.
This page is meant to be an overview over additions one can make to the home NVR setup. The list is not exhaustive and can be extended via PR to the Frigate docs.
:::caution
:::warning
This page does not recommend or rate the presented projects.
Please use your own knowledge to assess and vet them before you install anything on your system.