From ea7b2d3fca19e5f3323f453712afb6fa6feace3f Mon Sep 17 00:00:00 2001 From: Julian Gog Date: Thu, 10 Nov 2022 18:31:38 +0100 Subject: [PATCH] docs(README): add description for new endpoint, add column for default availability --- tools/esp8266/README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/tools/esp8266/README.md b/tools/esp8266/README.md index e1f06a35..f8cc07f3 100644 --- a/tools/esp8266/README.md +++ b/tools/esp8266/README.md @@ -184,19 +184,20 @@ When everything is wired up and the firmware is flashed, it is time to connect t ##### HTTP based Pages To take control of your Ahoy DTU, you can directly call one of the following sub-pages (e.g. http://192.168.1.1/setup ).
-| page | use | output | -| ---- | ------ | ------ | -| /uptime | displays the uptime uf your Ahoy DTU | 0 Days, 01:37:34; now: 2022-08-21 11:13:53 | -| /reboot | reboots the Ahoy DTU | | -| /erase | erases the EEPROM | | -| /factory | resets to the factory defaults configured in config.h | | -| /setup | opens the setup page | | -| /save | | | -| /cmdstat | show stat from the home page | | -| /visualization | displays the information from your converter | | -| /livedata | displays the live data | | -| /json | gets live-data in JSON format | json output from the livedata | -| /api | | | +| page | use | output | default availability | +| ---- | ------ | ------ | ------ | +| /uptime | displays the uptime uf your Ahoy DTU | 0 Days, 01:37:34; now: 2022-08-21 11:13:53 | yes | +| /reboot | reboots the Ahoy DTU | | yes | +| /erase | erases the EEPROM | | yes | +| /factory | resets to the factory defaults configured in config.h | | yes | +| /setup | opens the setup page | | yes | +| /save | | | yes | +| /cmdstat | show stat from the home page | | yes | +| /visualization | displays the information from your converter | | yes | +| /livedata | displays the live data | | yes | +| /json | gets live-data in JSON format | json output from the livedata | no - enable via config_override.h | +| /metrics | gets live-data for prometheus | prometheus metrics from the livedata | no - enable via config_override.h | +| /api | | | yes |