Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-08 20:46:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document stream endpoint

Browse Source
This commit is contained in:
JxxIT
2024-07-05 12:13:58 +02:00
committed by GitHub
parent 5efcc584df
commit 4cc8546008
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/REST-API.md
View File

@@ -113,6 +113,16 @@ Note: For more detailed information to the REST handler, have a look to the code
### capture_with_flashlight
Capture a new image with flashlight
### stream
Stream a live video of the camera.
It has a slow refresh rate of only 2 FPS to avoid stressing the system. Flow processing continues to work in the background, albeit possibly a bit slower.
When the `flashlight` parameter is set, it turns on the flaslight. Both `http://<IP>/stream?flashlight=true` and `http://<IP>/stream?flashlight` turn on the flashlight.
**LIMITATION:** To avoid using extra memory, no additional dedicated stream webserver is implemented for this feature (instead, the web interface server is reused in a kind of "blocking way"). This means that either the web interface is fully functional or the stream is active, but not both at the same time. However, this is sufficient for the intended use case.
### save
Save a new image to SD card
- The `save` entrypoint also support parameters:
@@ -135,4 +145,4 @@ Note: For more detailed information to the REST handler, have a look to the code
## Prometheus/OpenMetrics
### metrics
Provides a set of metrics that can be scraped by prometheus. See [Prometheus/OpenMetrics](../prometheus-openmetrics) for details.
Provides a set of metrics that can be scraped by prometheus. See [Prometheus/OpenMetrics](../prometheus-openmetrics) for details.