diff --git a/README.md b/README.md index d80c2d6..4fead80 100644 --- a/README.md +++ b/README.md @@ -228,7 +228,24 @@ Here is a list of the available api calls for the board : * Description : Set the module's I/O mode (ie input or ouput), it is possible to set the mode for specific pins * Response format : JSON * OK : { "status" : "ok", "P0" : "IN", "P1" : "OU", "P2" : "OUT", "P3" : "OUT", "P4" : "IN", "P5" : "OUT", "P6" : "IN", "P7" : "OUT" } - +* /sab/ota/update/device + * HTTP request method : GET + * Description : Check if an OTA update is available, if yes fetch the version + * Response format : JSON + * OK : {"status":"ok","ota":"disabled"} + * OK : {"status":"ok","ota":"enabled","msg":"Update available","version":"X.X.X"} + * OK : {"status":"ok","ota":"enabled","msg":"No update available"} + * ERROR : {"status":"error","ota":"enabled","msg":"OTA reach error"} + * ERROR : {"status":"error","ota":"enabled","msg":"Undefined error"} +* /sab/ota/update/device?update + * HTTP request method : GET + * Description : Check if an OTA update is available, **if yes, applies the update** + * Response format : JSON + * OK : {"status":"ok","ota":"enabled","msg":"Updating the device, please wait","version":"X.X.X"} + * OK : {"status":"ok","ota":"disabled"} + * OK : {"status":"ok","ota":"enabled","msg":"No update available"} + * ERROR : {"status":"error","ota":"enabled","msg":"OTA reach error"} + * ERROR : {"status":"error","ota":"enabled","msg":"Undefined error"} ### Things to do : - [X] Screen Manager