Luftdaten/irceline viewer

Luftdaten/irceline viewer is an app to display air quality sensors registered by luftdaten or irceline accross Belgium. Sensors can contain information about fine particulate matter, temperature and humidity. This app is built with react/redux.

User guide

Users can select one or more stations and view the linked sensor information in the sidebar. Information includes sensor manufacturer, data source (luftdaten or irceline), geolocation, last reading by the sensor, and a mean of readings by all selected sensors. The url is constantly updated with geolocation data and the current zoom level, so that users may share the map at the current location with others. Users may also share a single selected sensor by selecting a sensor in the sidebar, and then clicking the lat/long location value. The url should be updated with the current sensor's ID.

Data source can be enabled or disabled in the filter options. By default, both data sources are enabled. A checkmark in front of a data source means that the app has successfully retrieved sensors registered with this data source. An hourglass icon means that this data source is currently being polled for sensor updates. A cross means that this data source was unreachable. Luftdaten sensor data updates every minute. Irceline sensor data updates every 10 minutes (needs to do a lot more API calls to retrieve all sensors). Luftdaten sensors are prefixed with "L-" and Irceline sensors are prefixed with "I-".

Users may select a phenomenon (PM2.5 by default) to show color coded markers for every sensor that has a reading for this phenomenon The color coded legend displays all the colors associated with the currently selected phenomenon. A red bar indicates the threshold of dangerous levels for human exposure to the currently selected phenomenon.

Contributing

Users may contribute by making a new issue about bugs they find or features they think should be implemented in this app. Volunteer translators are also welcome. Right now this app has very few lines of text, making it easy to add support for another language you are proficient at. New languages can be added in /src/lang/. New translations should be a .json file named as the ISO 639-1 language code of the relevant language.

configuration and deployment

Important: This app uses openstreets map tiles, which require an API token. If you want to deploy this app, you will need to create and use your own token for map tile access. Without such a token, the app will not run.

• There are two places where you can set this token:

  1. Before building the project, rename src/config.js.dist to src/config.js, and set the value of tilesAccessToken to your own token. You can also configure other settings in this config.js file
  2. Your second option is to set the environment variable TILES_ACCESS_TOKEN when running the server or docker image. Note that even if you set this environment variable, if config.js exists, its tilesAccessToken will be used instead, even if it is not set.

• (optional) To configure various settings, copy src/config.js.dist to src/config.js, and edit the copy for your needs. If you dont create a config.js, default settings will be used instead, but you will need to set the environment variable TILES_ACCESS_TOKEN for the app to run (see previous point).

• Enable https with letsencrypt (a free certificate authority) on docker cloud services

  1. build the docker image
  2. Set the environment variable SSL_DOMAINS to a comma-separated list of domain names you wish to register. ex: "www.domain1.com,pictures.domain1.com,www.domain2.com",
  3. Set the environment variable SSL_EMAIL to a valid email address to get updates about the status of your SSL certificate.
  4. Set NODE_ENV to production
  5. spin up the container as a service
  6. to prevent losing your certificates on a redeploy, add a volume for the path /etc/greenlock/acme/

• With docker:

  1. cd to the project directory
  2. docker build . -t luftdaten_irceline_viewer
  3. docker run -p 80:80 -p 443:443 luftdaten_irceline_viewer

• Without docker:

  1. npm install
  2. sudo node server.js