sbrl-github/Air-Quality-Web
1
0
Fork 0
mirror of https://github.com/ConnectedHumber/Air-Quality-Web synced 2024-11-21 06:22:59 +00:00
Code Issues Releases Wiki Activity
*** Backup Mirror *** The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project. https://github.com/ConnectedHumber/Air-Quality-Web
466 commits 12 branches 0 tags 2 MiB
JavaScript 46.1%
PHP 43.1%
Shell 7.6%
CSS 2.6%
HTML 0.6%
Find a file
Starbeamrainbowlabs 9aa450f61e
Merge pull request #65 from bsimmo/patch-2 
updated aq. to sensors.
2021-02-12 22:49:03 +00:00
.github Bugfix: typo 2019-02-23 20:03:12 +00:00
client_src properly handle switching to a reading type that doesn't have any readings at all 2021-01-30 21:40:07 +00:00
design Add application structure SVG diagram 2019-03-01 17:46:06 +00:00
docs docs: update welcome page 2020-12-12 13:19:38 +00:00
lantern-build-engine@aaa2463547 Bugfix: Correct and document GenerateCSSGradient(). 2019-05-09 11:41:35 +01:00
lib/SBRL Drastically optimise the queries behind fetch-data and device-data. 2019-06-22 21:08:12 +01:00
logic api/device-info: drastically optimise by removing a redundant JOIN 2021-01-30 21:33:28 +00:00
test Add heatmap guage to right-hand-side (part of #31) 2019-05-09 13:32:01 +01:00
.gitignore Update db connection info 2019-11-07 18:43:01 +00:00
.gitmodules Remove webgl heatmap, as it doesn't work right. 2019-01-18 19:45:28 +00:00
api.php Add CORS header support 2020-05-21 19:16:30 +01:00
beta Add beta version symlink 2019-08-01 18:47:19 +01:00
build api/list-reading-types: optimise 2021-01-30 18:26:50 +00:00
Changelog.md updated aq. to sensors. 2021-02-12 13:41:17 +00:00
composer.json Add list-devices-near action with appropriate API documentation 2019-06-21 22:05:13 +01:00
composer.lock Add list-devices-near action with appropriate API documentation 2019-06-21 22:05:13 +01:00
di_config.php Bugfix new device sensor list 2019-07-18 22:18:30 +01:00
index.php Add premanent redirect from root to app/ 2019-04-12 23:15:42 +01:00
LICENSE Initial commit 2019-01-12 23:22:42 +00:00
nightdocs.toml Use nightdocs to generate documentation 2019-03-17 13:21:14 +00:00
package-lock.json Colour the markers instead of having a heatmap 2021-01-30 21:10:53 +00:00
package.json Colour the markers instead of having a heatmap 2021-01-30 21:10:53 +00:00
README.md Add disclaimer to README 2020-04-27 18:59:07 +01:00
rollup.config.js Colour the markers instead of having a heatmap 2021-01-30 21:10:53 +00:00
settings.default.toml Add CORS header support 2020-05-21 19:16:30 +01:00
version api/list-reading-types: optimise 2021-01-30 18:26:50 +00:00

README.md

ConnectedHumber-Air-Quality-Interface

The web interface and JSON API for the ConnectedHumber Air Quality Monitoring Project.

This project contains the web interface for the ConnectedHumber sensor system. Despite being called Air Quality Web, it is designed to display any kind of sensor data - not just air quality sensor readings.

It is composed of 2 parts:

  • A PHP-based JSON API server (entry point: api.php) that's backed by a MariaDB server
  • A Javascript client application that runs in the browser

The client-side browser application is powered by Leaflet.

Note that this project is not responsible for entering data into the database. This project's purpose is simply to display the data.

Documentation

Documentation has moved! You can view it here:

Branches

  • master
    • The default branch
    • Should always be stable
  • dev
    • The development branch
    • May not always be stable.

Notes

  • Readings are taken every 6 minutes as standard.

Contributing

Contributions are welcome - feel free to open an issue or (even better) a pull request.

The issue tracker is the place where all the tasks relating to the project are kept.

Please remember: All pull requests should be made against the dev branch, not master! The master branch is the stable version that automatically gets pushed to production.

Disclaimer

This website displays sensor reading from devices created by individuals with an interest in monitoring their environment and is not endorsed or funded in any way by UK government supported bodies such as DEFRA. It is , however, hoped that this work may be useful in educational applications.

The sensors, on the map, are installed in different ways, in different enclosures, at different heights and with different exposures to sunlight and wind . This means that, although individual sensors may use the same detectors, those detectors could produce varying results due to the above and also due to component tolerance spread.

No attempt has been made, by us, to calibrate the sensor readings in any way though the visual representation will include some aggregation of readings.

If you wish to create a device to display data on this map please register with mattermost.connectedhumber.org and we will provide you with direction and designs to build your own sensor device.

Credits

License

This project is licensed under the Mozilla Public License 2.0. The full text of this license can be found in the LICENSE file of this repository, along with a helpful summary of what you can and can't do provided by GitHub.