blueweather/README.md

66 lines
1.5 KiB
Markdown

# BlueWeather
A (hopefully soon) fully featured selft-hosted web interface and server-backend to store weather data (comparable to opensensemap.org)
# State of development
- interface and backend planned
- readonly dashboard is working
# API docs
## get locations
triggered by setting no GET parameter at all
### Parameters
no parameters
### Tags
- id
- locationname
- latitude
- longitude
- countryname
## get location data
triggered by setting GET parameter 'locId' to a vaild location id
### Parameters
- locId: id of the location to display
- range: range of the data to display in unix time
- from
- to
- max vals: maximum measvals to be transmitted; if more are present in the timespan, the avarage will be calculated
### Tags
- id
- locationname
- latitude
- longitude
- countryname
- measvalues
- measvalue
- sensorid
- timestamp
- sensors
- id
- added
- userid
- sensorname
- property ('indoor' || 'sunny' || 'shadow' )
- valuetypeid
- valuetypes
- id
- valuetype ('temperature' || 'humidity')
- valueunit (html coding)
- displayproperty
- widget (properties for small widget)
- type ('doughnut' || 'text')
- properties (chartjs dataset properties if type is a chartjs type)
- chart (properties for large chart)
- type ('scatter')
- properties (chartjs dataset properties)
- range (actual range of present measvalues)
- from
- to