Th3maz1ng/ESP8266_swiss_army_board
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of http://88.167.116.148/git/Th3maz1ng/ESP8266_swiss_army_board

Browse Source
This commit is contained in:
anschrammh 2019-04-09 08:01:04 +02:00
commit a8a6ef2fb1
1 changed files with 55 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -109,13 +109,66 @@ SSID : 'MyHotspotSSID'
PASSWORD : 'MySuperSecuredPassword' PASSWORD : 'MySuperSecuredPassword'
``` ```
### System WEB api :
Here is a list of the available api calls for the board :
* /sab/web/apitester
* HTTP request method : ALL
* Description : Test if the api system is available
* Response format : JSON
* OK : { "status" : "ok", "API" : "available" }
* FAIL : NOTHING
* /sab/view/next
* HTTP request method : GET
* Description : Display the next view on the screen
* Response format : JSON
* OK : { "status" : "ok", "ViewUID" : "UID" }
* FAIL : { "status" : "failed", "message" : "REASON" }
* /sab/view?UID=x
* HTTP request method : GET
* Description : Display the view with the corresponding id
* Response format : JSON
* OK : { "status" : "ok", "ViewUID" : "UID" }
* FAIL : { "status" : "failed", "message" : "REASON" }
* /sab/rtc/get/datetime
* HTTP request method : GET
* Description : Get RTC's time
* Response format : JSON
* OK : { "status" : "ok", "date" : "xx/xx/xxxx", "time" "xx:xx:xx" }
* /sab/rtc/set/datetime?datetime=day_month_year_hours_minutes_seconds
* HTTP request method : GET
* Description : Set RTC's clock
* Response format : JSON
* OK : { "status" : "ok", "date" : "xx/xx/xxxx", "time" "xx:xx:xx" }
* FAIL : { "status" : "failed", "message" : "REASON" }
* /sab/sdcard/unmount
* HTTP request method : GET
* Description : Unmount the SD Card in order to remove it
* Response format : JSON
* OK : { "status" : "ok", "card" : "unmounted" }
* /sab/sdcard/mount
* HTTP request method : GET
* Description : Mount the SD Card
* Response format : JSON
* OK : { "status" : "ok", "card" : "mounted" }
* FAIL : { "status" : "failed", "message" : "REASON" }
* /esp/restart
* HTTP request method : GET
* Description : Restart the UC, this one is recommended compared to the reset call
* Response format : NOTHING
* /esp/reset
* HTTP request method : GET
* Description : Reset the UC
* Response format : NOTHING
### Things to do : ### Things to do :
* Screen Manager ✓ * Screen Manager ✓
* µSDcard File System (In progress) * µSDcard File System ✓
* File Config Parser ✓ * File Config Parser ✓
* Templated Dictionary Class ✓ * Templated Dictionary Class ✓
* RTC Manager ✓ * RTC Manager ✓
* RTC FLASH Manager * RTC FLASH Manager
* FTP Service * FTP Service
* WEB Service * WEB ServerManager ✓
* GPIO Util * GPIO Util