diff --git a/README.md b/README.md index d833714..cae5460 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,29 @@ This link can be opened with for example [VLC](https://www.videolan.org/vlc/). :warning: **Please be aware that there is no password present on the stream!** +## API + +There is a minimum API present to perform some tasks using HTTP requests. +The URLs are below: + +### GET: /restart + +Calling this URL will restart the device. + +### GET: /config + +Calling this URL will start the form for configuring the device in the browser. + +### GET: /snapshot + +Calling this URL will return a JPEG snapshot of the camera in the browser. + +### GET: /flash?v={value} + +Calling this URL will set the intensity of the flash LED. +The values must for {value} must be between 0 and 255. +If no v parameter is present, it will be set to the value of the configuration. + ## Issues / Nice to know - The red LED on the back of the device indicates the device is not connected. diff --git a/html/index.html b/html/index.html index 3f88b6f..f91491e 100644 --- a/html/index.html +++ b/html/index.html @@ -149,7 +149,11 @@
Failed to initialize the camera!
-Result: {{CameraInitResultText}} ({{CameraInitResult}})
+Result: {{CameraInitResultText}}
Please check hardware or correct the camera settings and restart.
@@ -172,20 +176,41 @@The configuration has been changed.
It is recommended to restart the device.
Not connected to an access point. Consider configuring the access point.
Connected to the access point
Camera was initialized successfully!
Failed to initialize the camera!
Result: {{CameraInitResultText}} ({{CameraInitResult}})
Please check hardware or correct the camera settings and restart.
The device is restarting.
In some cases, the device requires a hard reset (power cycle).
If this page takes longer than a minute, consider performing a power cycle.
The configuration has been changed.
It is recommended to restart the device.
Not connected to an access point. Consider configuring the access point.
Connected to the access point
Camera was initialized successfully!
Failed to initialize the camera!
Result: {{CameraInitResultText}}
Please check hardware or correct the camera settings and restart.
The device is restarting.
In some cases, the device requires a hard reset (power cycle).
If this page takes longer than a minute, consider performing a power cycle.