diff --git a/README.md b/README.md index cd70258..ec24471 100644 --- a/README.md +++ b/README.md @@ -168,17 +168,12 @@ Here is a list of the available api calls for the board : * Response format : JSON * OK : { "status" : "ok", "card" : "present", "size" : "xx.xx", "unit" : "GByte" } * OK : { "status" : "ok", "card" : "not present", "size" : "0" } -* /sab/sdcard/unmount +* /sab/sdcard/action?action=mount or unmount * HTTP request method : GET - * Description : Unmount the SD Card in order to remove it + * Description : Mounts or Unmounts 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" } + * OK : { "status" : "ok", "card" : "mounted" } or { "status" : "ok", "card" : "unmounted" } + * ERROR : { "status" : "error", "message" : "begin failed" } or * /esp/restart * HTTP request method : GET * Description : Restart the UC, this one is recommended compared to the reset call @@ -194,6 +189,12 @@ Here is a list of the available api calls for the board : * Description : Get the module's station information * Response format : JSON * OK : { "status" : "ok", "RSSI" : "-XX", "RSSI2" : "X", "local IP" : "XXX.XXX.X.XX", "mac" : "XX:XX:XX:XX:XX:XX" } +* /sab/wifi/scanner + * HTTP request method : GET + * Description : Starts a scan of nearby WiFi access points and returns an array with information about them + * Response format : JSON + * OK : [ { "SSID" : "ssid_1", "RSSI" : -67, "Protected" : "Yes" }, { "SSID" : "ssid_2", "RSSI" : -42, "Protected" : "No" } ] + * /sab/systeminfo * HTTP request method : GET * Description : Get the module's system information (free memory, heap frag etc...)