From 884c114e3285ac5d159f9c473b242c39a18f036b Mon Sep 17 00:00:00 2001 From: Ralf Bauer Date: Fri, 30 Jun 2023 21:18:10 +0200 Subject: [PATCH] Update README.md description of new APIs --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ec8864b1..17c9df3e 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,19 @@ OpenDTU-Database adds an ESP32 LittleFS Database and two energy charts, a column chart of the last 25 hours and a full calendar chart. +There are 3 new APIs available, returning JSON strings: + +| API | returned values | +|-------------------|-----------------| +| /api/database | returns all recored data points from the database with total energy value | +| /api/databaseHour | returns the energy per hour for the last 25 hours | +| /api/databaseDay | returns the energy for each day | + +Each data point has the following format: +[ _year (00-99)_, _month (1-12)_, _day (1-31)_, _hour (0-23)_, _energy (Wh)_ ] + +Example: [23,6,30,15,132.995605] + ![Screenshot](https://github.com/RaBa64/OpenDTU/blob/Database/docs/screenshots/23_Database.png) ## !! IMPORTANT UPGRADE NOTES !!