From 36055409780663c3be3b74f29c5a50dd79e2d2e5 Mon Sep 17 00:00:00 2001 From: FrYakaTKoP Date: Mon, 30 Oct 2017 00:16:02 +0100 Subject: [PATCH] fancypants md --- README.md | 53 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 8927c42..c06f943 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,36 @@ # Esp8266-Laser Wifi Host for the Arduino-Laser-Spirograph -HTTP endpoints: - /spirograph GET returns laser and motor values (0 at startup) - POST sets new value(s) - laser=1-128 (1:permanent, 2-127 pulse, 128 off) - motor1=1-128 - motor2=1-128 - motor3=1-128 - - - /wificonfig -> GET returns wifi settings - POST sets new wifi setting{s} - apMode=0: will try to connect to SSID first, 1: will directly start the AP - SSID=ssid - password=password - save=true will save config to spiffs, false will only change RAM variable (useful for onetime ap joins) - apply=true will reset wifi and try to connect with new param (buggy atm) - /saveconf -> POST write wificonfig to file (similar to wificonfig->save=true) - /resetwifi -> POST reconnect wifi (similar to wificonfig->apply=true) - /heap -> GET returns free heap of the ESP8266 - /files -> GET returns list of files - /presetMode -> GET returns current mode 0: presetsOff 1: cycle (not completed feature) - POST sets mode (see above) - /presets -> GET returns /presets.json +# HTTP endpoints: +* /spirograph + * **GET** returns laser and motor values (0 at startup) + * **POST** sets new value(s) + * laser=1-128 (1:permanent, 2-127 pulse, 128 off) + * motor1=1-128 + * motor2=1-128 + * motor3=1-128 + +* /wificonfig -> + * **GET** returns wifi settings + * **POST** sets new wifi setting{s} + * apMode=0: will try to connect to SSID first, 1: will directly start the AP + * SSID=ssid + * password=password + * save=true will save config to spiffs, false will only change RAM variable (useful for onetime ap joins) + * apply=true will reset wifi and try to connect with new param (buggy atm) +* /saveconf -> + * **POST** write wificonfig to file (similar to wificonfig->save=true) +* /resetwifi -> + * **POST** reconnect wifi (similar to wificonfig->apply=true) +* /heap -> + * **GET** returns free heap of the ESP8266 +* /files -> + * **GET** returns list of files +* /presetMode -> + * **GET** returns current mode + * **POST** sets mode 0: presetsOff 1: cycle (not completed feature) +* /presets -> + * **GET** returns /presets.json # Install