From 526cef1d8aa318e00ef3eac09c8be2c0d91d5219 Mon Sep 17 00:00:00 2001 From: Benjamin Bennett Date: Wed, 24 Jun 2020 08:56:01 -0400 Subject: [PATCH] Added docs about the debug URL parameters --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 33c84db23..725118525 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,10 @@ Example docker-compose: A `config.yml` file must exist in the `config` directory. See example [here](config/config.example.yml) and device specific info can be found [here](docs/DEVICES.md). -Access the mjpeg stream at `http://localhost:5000/` and the best snapshot for any object type with at `http://localhost:5000///best.jpg` +Access the mjpeg stream at `http://localhost:5000/` and the best snapshot for any object type with at `http://localhost:5000///best.jpg`. You can specify the following arguments on the URL: + +- `fps`: The framerate of the debug stream. Defaults to 1. +- `h`: The height of the debug stream. Debug info is available at `http://localhost:5000/debug/stats`