updated readme

This commit is contained in:
2EEEB 2020-06-22 17:41:39 +02:00
parent d30d6096d1
commit 30c065abd6
Signed by: 2EEEB
GPG Key ID: 8F12BD6D9D435DB2

View File

@ -2,10 +2,10 @@
Flask web app for data visalization. Client side is built with [Chart.js](https://chartjs.org) and [justgage](https://github.com/toorshia/justgage) js libraries and jQuery.
The app exposes a simple api for querying the database and source sensor status available at /api/*function*.
The app exposes a simple api for querying the database and source sensor status available at /api/*function*.
The functions are:
- /api/getData
- /api/getdata
- Method: GET, POST
- Number of samples can be specified with argument samples=*desired number*, defaults to 120 i.e 2 hours.
- Returns json with the datasets and information about sensor status
@ -17,9 +17,6 @@ The functions are:
The client side comprises of several parts:
- `templates/index.html` provides the basic html structure
- `static/styles/chartstyle.css` takes care of some basic styling and layout
- `static/main.js` script taking care of creating the plots and gauges, requesting data from server and updating the view every two minutes.
- `templates/index.html` provides the basic html skeleton
- `static/styles/style.css` takes care of some basic styling and responsive layout
- `static/js/main.js` script taking care of creating the plots and gauges, requesting data from server and periodically updating the view