1.0.4 • Published 7 months ago
netatmo-weather-server v1.0.4
NETATMO WEATHER SERVER
This project is a little NodeJS server exposing public weather datas through a rest api
How to start
Installation
Two options are available.
- Use the docker image (recommended)
docker run -p 3000:3000 GHN_PORT=3000 --name netatmo-weather-server -d rtrompier/netatmo-weather-server:latest
- Use the npm package
$ sudo npm install -g netatmo-weather-server
Or update to latest version when already installed:
$ sudo npm update -g netatmo-weather-server
How to start (for NPM only)
$ netatmo-weather-server
You can pass the parameters through the node api. Execute this command to show all available parameters, or see Parameters section :
$ netatmo-weather-server --help
Parameters
You can pass the following params by environment variables :
- NWS_VERBOSE Run with verbose mode
- NWS_PORT Http server port
- NWS_LATITUDE Latitude to search nearby
- NWS_LONGITUDE Longitude to search nearby
- NWS_DISTANCE Distance to search nearby (in KM)
How to use
A REST Api is available to get weathers data.
- You juste have to execute a web request
GET http://YOUR_SERVER_IP:3000/weather
- You will receive a response with the following values :
Parameter | Description |
---|---|
temperature | The average of the temperature values from all stations around your position |
humidity | The average of the humidity values from all stations around your position |
pressure | The average of the pressure values from all stations around your position |
rain_60min | Quantity of rain during the last 60 min (in mm) |
rain_24h | Quantity of rain during the last 24 hours (in mm) |
rain_live | Is currently rainning (1 : yes, 0 : false) |
rain_timeutc | Last time raining (timestamp) |
wind_strength | Wind strength |
wind_angle | Wind angle |
gust_strength | Gust strength |
gust_angle | Gust angle |
wind_timeutc | Wind timestamp |