The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project.
This project contains the web interface for the ConnectedHumber air Quality Monitoring system. It is composed of 2 parts:
- A PHP-based JSON API server (entry point: api.php) that's backed by a MariaDB server
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.
In order to run this program, you'll need the following:
- Bash (if on Windows, try Git Bash) - the build script is written in Bash
- composer - For the server-side packages
- npm - comes with Node.JS - used for building the client-side code
- A MariaDB server with a database already setup with the schema data in it. Please get in contact with ConnectedHumber for information about the database schema and structure.
The client-side code requires building. Currently, no pre-built versions are available (though these can be provided upon request), so this must be done from source. A build script is available, however, which automates the process - as explained below.
Building From Source
The build script ensures that everything it does will not go outside the current directory (i.e. all dependencies are installed locally).
To build from source, start off by cloning this repository.
Then run the
setup-dev build commands from the root of the repository like this:
./build setup setup-dev
This will initialise any git submodules and install both the server-side and client-side dependencies. Once done, all you need to do is build the client-side code:
For development purposes, the
client-watch command is available.
In production, you probably want to do this instead:
NODE_ENV=production ./build client
This will take longer, as it causes the build system to additionally minify the client code, saving a significant amount of bandwidth and speeding up loading times.
Some configuration must be done before the application is ready for use. The first time
api.php is called from a browser, it will create a new blank configuration file at
data/settings.toml, if it doesn't already exist. See the
settings.default.toml file in this repository for a list of configurable settings, but do not edit
settings.default.toml! Instead, enter your configuration details into
data/settings.toml, which overrides
settings.default.toml. In particular, you'll probably want to change the settings under the
[database] header - but ensure you give the entire file a careful read.
The server-side API is accessed through
api.php, and supports a number of GET parameters. The most important of these is the
action parameter, Which determines what the API will do. The following values are supported:
Fetches air quality data from the system for a specific data type at a specific date and time.
||date/time||Required. Specifies the date and time for which readings are desired.|
||string||Required. Specifies the type of reading desired.|
Fetches a list of devices currently in the system.
||bool||Optional. If present only devices with a defined location will be returned. Useful for getting a list of devices to place on a map.|
Gets (lots of) information about a single device.
||int||Required. The id of the device to get extended information for. See the
Lists the different types of readings that can be specified.
||int||Optional. If specified, this filters the list of measurement types to list only those reported by the device with the specified id.|
https://example.com/path/to/api.php?action=list-reading-types https://example.com/path/to/api.php?action=list-reading-types&device-id=22 https://example.com/path/to/api.php?action=list-reading-types&device-id=54
Gets the start and end DateTime bounds for the data recorded for a specific device.
||int||Required. The id of the device to get the data DateTime bounds for.|
Gets data by device given a start and end time.
||int||The id of the device to get data for.|
||string||The type of reading to obtain data for.|
||datetime||The starting datetime.|
||datetime||The ending datetime.|
||int||Optional. If specified, readings will be grouped into lumps of this many seconds and averaged. For example a value of 3600 (1 hour) will return 1 data point per hour, with the value of each point an average of all the readings for that hour.|
Gets the changelog as a fragment of HTML.
No parameters are currently supported by this action.
- Readings are taken every 6 minutes as standard.
The issue tracker is the place where all the tasks relating to the project are kept.
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.