Flesh out

API.md

@@ -1,25 +1,88 @@
-# Basic HTTP Commands
+TODO: 
-## It's an API Jim, but not as we know it
+* Order the same as in the UI for most settings
+* Brief Descriptions (ESP documentation?)
+* ov2640 vs 3660 specifics (note them)
+
+# Basic HTTP Commands; 
+It's an API Jim, but not as we know it
 
 The WebUI and camera server communicate entirely via HTTP requests and responses; this makes controlling all functions of the camera via GET requests possible. An API in effect.
 
 ## URI's
 ### Http Port
-`/` Root URI; primary WebUI
+* `/` Primary WebUI
-`/capture` Return a Jpeg snapshot image
+* `/capture` Return a Jpeg snapshot image
-`/view` Simplified Viewer
+* `/view` Simplified viewer
-`/status` Returns a JSON string with all camera status <key>/<value> pairs listed
+* `/status` Returns a JSON string with all camera status <key>/<value> pairs listed
-`/control?var=<key>&val=<val>` Set <key> to <val>
+* `/control?var=<key>&val=<val>` Set <key> to <val>
-`/dump` Status page
+* `/dump` Status page
 
 ### Stream Port
-`/` Root URI; Raw stream
+* `/` Raw stream
-`/view` Stream viewer
+* `/view` Stream viewer
 
-## <key> / <val> settings and commands
+## *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.
+
+Call `/control?var=<key>&val=<val>` with a settings key and value to set camera properties or trigger actions.
+
+#### Settings
+```
+framesize       -
+quality         -
+contrast        -
+brightness      -
+saturation      -
+gainceiling     -
+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        -
+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
+lamp            - Lamp value in percent; integer, 0 - 100 (-1 = disabled)
+```
+#### Read Only
+These values are returned in the `/status` JSON response, but cannot be set via the `/control` URI.
+```
+cam_name        - Camera Name; String
+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.
+```
+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
+```
 ## Examples
-Flash light: on/off
+* Flash light: on/off
-http://<IP-ADDRESS>/control?var=lamp&val=100
+  * `http://<IP-ADDRESS>/control?var=lamp&val=100` On
-http://<IP-ADDRESS>/control?var=lamp&val=0
+  * `http://<IP-ADDRESS>/control?var=lamp&val=50` 50%
+  * `http://<IP-ADDRESS>/control?var=lamp&val=0` Off
+
+## Timelapse Example (for Linux Users)
+* Install ffmpeg
+* `Work this out... I've got an example somewhere`