From c9bc9159dbbc7522a6431b942b47cf7ed29db03b Mon Sep 17 00:00:00 2001
From: Owen <owen@easytarget.org>
Date: Sat, 3 Oct 2020 23:21:07 +0200
Subject: [PATCH] Initial, needs key/val pair description

---
 API.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..0babb40
--- /dev/null
+++ b/API.md
@@ -0,0 +1,25 @@
+# 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
+`/capture` Return a Jpeg snapshot image
+`/view` Simplified Viewer
+`/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
+
+### Stream Port
+`/` Root URI; Raw stream
+`/view` Stream viewer
+
+## <key> / <val> settings and commands
+.. thie list.. the list is the thing.
+
+## Examples
+Flash light: on/off
+http://<IP-ADDRESS>/control?var=lamp&val=100
+http://<IP-ADDRESS>/control?var=lamp&val=0