Mirror
/
esp32-cam-webserver
mirror of https://github.com/easytarget/esp32-cam-webserver.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Flesh out

This commit is contained in:
Owen 2020-10-14 10:13:31 +02:00
parent f38acc1a0a
commit 7f27938379
2 changed files with 28 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
API.md
View File

@ -10,9 +10,9 @@ The WebUI and camera server communicate entirely via HTTP requests and responses
## URI's
### Http Port
* `/` Primary WebUI
* `/capture` Return a Jpeg snapshot image
* `/view` Simplified viewer
* `/` - Default index
* `/?target=full|simple|portal - Go direct to specific index
* `/capture` - Return a Jpeg snapshot image
* `/status` Returns a JSON string with all camera status <key>/<value> pairs listed
* `/control?var=<key>&val=<val>` Set <key> to <val>
* `/dump` Status page
@ -22,8 +22,6 @@ The WebUI and camera server communicate entirely via HTTP requests and responses
* `/view` Stream viewer
## *key / val* settings and commands
.. thie list.. the list is the thing.
### Use
Call the `/status` URI to recieve a JSON response containing all the available settings and responses.
@ -31,30 +29,30 @@ Call `/control?var=<key>&val=<val>` with a settings key and value to set camera
#### Settings
```
framesize -
quality -
contrast -
brightness -
saturation -
gainceiling -
framesize - QQVGA|HQVGA|QVGA|CIF|VGA|SVGA|XGA|SXGA|UXGA|QXGA(ov3660)
quality - 10 ro 63
contrast - -2 to 2
brightness - -2 to 2
saturation - -2 to 2
gainceiling - 0 to 6
colorbar - Overlays a color test pattern on the stream; integer, 1 = enabled
awb -
agc -
aec -
hmirror -
vflip -
awb - 0 = disable , 1 = enable
agc - 0 = disable , 1 = enable
aec - 0 = disable , 1 = enable
hmirror - 0 = disable , 1 = enable
vflip - 0 = disable , 1 = enable
awb_gain -
agc_gain -
aec_value -
aec2 -
dcw -
bpc -
wpc -
raw_gma -
lenc -
special_effect -
wb_mode -
ae_level -
agc_gain - 0 to 30
aec_value - 0 to 1200
aec2 - 0 = disable , 1 = enable
dcw - 0 = disable , 1 = enable
bpc - 0 = disable , 1 = enable
wpc - 0 = disable , 1 = enable
raw_gma - 0 = disable , 1 = enable
lenc - 0 = disable , 1 = enable
special_effect - 0 - No Effect, 1 - Negative, 2 - Grayscale, 3 - Red Tint, 4 - Green Tint, 5 - Blue Tint, 6 - Sepia
wb_mode - if awb enabled: 0 - Auto, 1 - Sunny, 2 - Cloudy, 3 - Office, 4 - Home
ae_level - -2 to 2
rotate - Rotation Angle; integer, only -90, 0, 90 values are recognised
face_detect - Face Detection; 1 = enabled, Only settable if framesize <= 4 (CIF)
face_recognize - Face recognition; 1 = enabled, only settable if Face detection is already enabled
@ -68,11 +66,9 @@ code_ver - Code compile date and time; String
stream_url - Raw stream URL; string
```
#### Commands
These are commands; they can be sent by calling the `/control` URI with them as the `<key>`, the `<val>` supplied is ignored.
These are commands; they can be sent by calling the `/control` URI with them as the `<key>`, the `<val>` must be supplied, but can be any value and is ignored.
```
face_enroll - Enroll a new face in the FaceDB (only when face recognition is avctive)
save_face - Saves the FaceDB file (NOT YET IMPLEMENTED)
clear_face - Clears the FaceDB file (NOT YET IMPLEMENTED)
save_prefs - Saves preferences file
clear_prefs - Deletes the preferences file
reboot - Reboots the camera

2
CONTRIBUTING.md
View File

@ -19,7 +19,7 @@ Pull requests are the best way to propose changes to the codebase (I use [Github
4. Issue that pull request!
## Any contributions you make will be under the GNU Lesser General Public License v2.1
In short, when you submit code changes, your submissions are understood to be under the same [License](./LICENSE.md) that covers the project.
In short, when you submit code changes, your submissions are understood to be under the same [License](./LICENSE) that covers the project.
## Report bugs using Github's [issues](https://github.com/easytarget/esp32-cam-webserver/issues)
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!