From b00de5268685f7ed0d69a7fc6c2d1306c2db9089 Mon Sep 17 00:00:00 2001 From: Th3maz1ng Date: Fri, 5 Apr 2019 13:06:33 +0200 Subject: [PATCH 1/5] =?UTF-8?q?Mettre=20=C3=A0=20jour=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0e7b10b..1900567 100644 --- a/README.md +++ b/README.md @@ -109,13 +109,35 @@ SSID : 'MyHotspotSSID' 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 : NOTHING +/sab/rtc/get/datetime +/sab/sdcard/eject +/sab/sdcard/insert +/esp/restart +/esp/reset + + ### Things to do : * Screen Manager ✓ -* µSDcard File System (In progress) +* µSDcard File System ✓ * File Config Parser ✓ * Templated Dictionary Class ✓ * RTC Manager ✓ * RTC FLASH Manager * FTP Service -* WEB Service +* WEB ServerManager ✓ * GPIO Util \ No newline at end of file From ff3c4d0e7700385e885119e42d0b76d2cb941ead Mon Sep 17 00:00:00 2001 From: Th3maz1ng Date: Fri, 5 Apr 2019 15:11:56 +0200 Subject: [PATCH 2/5] =?UTF-8?q?Mettre=20=C3=A0=20jour=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 1900567..f7e5cbf 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,12 @@ Here is a list of the available api calls for the board : * Response format : JSON * OK : { "status" : "ok", "ViewUID" : "UID" } * FAIL : NOTHING +* /sab/view?id=x + * HTTP request method : GET + * Description : Display the view with the corresponding id + * Response format : JSON + * OK : { "status" : "ok", "ViewUID" : "UID" } + * FAIL : NOTHING /sab/rtc/get/datetime /sab/sdcard/eject /sab/sdcard/insert From ea06b7d4de98a887d61a617beb8e6939e56c63ee Mon Sep 17 00:00:00 2001 From: Th3maz1ng Date: Fri, 5 Apr 2019 15:12:32 +0200 Subject: [PATCH 3/5] =?UTF-8?q?Mettre=20=C3=A0=20jour=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f7e5cbf..d4f1478 100644 --- a/README.md +++ b/README.md @@ -129,12 +129,12 @@ Here is a list of the available api calls for the board : * Description : Display the view with the corresponding id * Response format : JSON * OK : { "status" : "ok", "ViewUID" : "UID" } - * FAIL : NOTHING -/sab/rtc/get/datetime -/sab/sdcard/eject -/sab/sdcard/insert -/esp/restart -/esp/reset + * FAIL : NOTHING +/sab/rtc/get/datetime +/sab/sdcard/eject +/sab/sdcard/insert +/esp/restart +/esp/reset ### Things to do : From a1fb1a3ae858ecbeaa940a8f9151e8cdd2e108f6 Mon Sep 17 00:00:00 2001 From: Th3maz1ng Date: Fri, 5 Apr 2019 16:42:07 +0200 Subject: [PATCH 4/5] =?UTF-8?q?Mettre=20=C3=A0=20jour=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d4f1478..758a51e 100644 --- a/README.md +++ b/README.md @@ -123,13 +123,13 @@ Here is a list of the available api calls for the board : * Description : Display the next view on the screen * Response format : JSON * OK : { "status" : "ok", "ViewUID" : "UID" } - * FAIL : NOTHING -* /sab/view?id=x + * 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 : NOTHING + * FAIL : { "status" : "failed", "message" : "REASON" } /sab/rtc/get/datetime /sab/sdcard/eject /sab/sdcard/insert From acb8c0be017be3bc45c31805d1ec3af324dbccec Mon Sep 17 00:00:00 2001 From: Th3maz1ng Date: Sat, 6 Apr 2019 14:37:53 +0200 Subject: [PATCH 5/5] =?UTF-8?q?Mettre=20=C3=A0=20jour=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 758a51e..db0aa79 100644 --- a/README.md +++ b/README.md @@ -130,11 +130,36 @@ Here is a list of the available api calls for the board : * Response format : JSON * OK : { "status" : "ok", "ViewUID" : "UID" } * FAIL : { "status" : "failed", "message" : "REASON" } -/sab/rtc/get/datetime -/sab/sdcard/eject -/sab/sdcard/insert -/esp/restart -/esp/reset +* /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 :