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 / pairs listed +`/control?var=&val=` Set to +`/dump` Status page + +### Stream Port +`/` Root URI; Raw stream +`/view` Stream viewer + +## / settings and commands +.. thie list.. the list is the thing. + +## Examples +Flash light: on/off +http:///control?var=lamp&val=100 +http:///control?var=lamp&val=0