From 7f27938379752610a86b21bd77d02702ca8e11c2 Mon Sep 17 00:00:00 2001 From: Owen Date: Wed, 14 Oct 2020 10:13:31 +0200 Subject: [PATCH] Flesh out --- API.md | 58 +++++++++++++++++++++++-------------------------- CONTRIBUTING.md | 2 +- 2 files changed, 28 insertions(+), 32 deletions(-) diff --git a/API.md b/API.md index a650809..4025afb 100644 --- a/API.md +++ b/API.md @@ -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 / pairs listed * `/control?var=&val=` Set to * `/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=&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_gain - -agc_gain - -aec_value - -aec2 - -dcw - -bpc - -wpc - -raw_gma - -lenc - -special_effect - -wb_mode - -ae_level - +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 - 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 ``, the `` supplied is ignored. +These are commands; they can be sent by calling the `/control` URI with them as the ``, the `` 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2975da6..dc0a741 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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!