inenvmon_server/webapp/README.md
2020-06-22 17:41:39 +02:00

23 lines
1.0 KiB
Markdown

# webapp
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 functions are:
- /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
- /api/heartbeat
- Method: GET
- Returns json with status info and last received message timestamp
- Method: POST
- Reserved for internal use in reporting sensor status. Requires a secret to be set.
The client side comprises of several parts:
- `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