Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helloimalemur/air-quality

Notifications and Web Interface to notify subscribers of questionable/hazardous air quality in their area, using data from https://www.iqair.com/
https://github.com/helloimalemur/air-quality

Last synced: 5 days ago
JSON representation

Notifications and Web Interface to notify subscribers of questionable/hazardous air quality in their area, using data from https://www.iqair.com/

Host: GitHub
URL: https://github.com/helloimalemur/air-quality
Owner: helloimalemur
License: gpl-3.0
Created: 2023-07-29T13:04:52.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-12-16T00:52:37.000Z (11 months ago)
Last Synced: 2023-12-16T01:53:06.305Z (11 months ago)
Language: Rust
Size: 285 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# air-quality
### WORK IN PROGRESS
#### Notifications and Web Interface to notify subscribers of questionable/hazardous air quality in their area, using data from https://www.iqair.com/
###### Project uses IQair's Community tier API.

### To Do
[x] Add sub \
[x] Fetch & store air quality reading \
[x] Loop on subs and send alerts \
[x] Alerts for discord \
[ ] web interface \
[ ] email alerts \
[ ] fetch per specified location \
[ ] mobile app?

## Create ./config/Settings.toml
```toml
database_url = "mysql://user:[email protected]:3306/database"
database_name = "database"
api_key = "yourapikey"
iqair_key = ""
port = 8080
```

## database user
CREATE USER 'dev'@'%' IDENTIFIED WITH sha256_password BY 'password';
CREATE USER 'dev'@'%' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON database.* TO 'dev'@'%';
FLUSH PRIVILEGES;

## database tables
```mysql
CREATE TABLE `readings` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`city` varchar(255) NOT NULL,
`state` varchar(255) NOT NULL,
`temp` varchar(255) NOT NULL,
`pressure` varchar(255) NOT NULL,
`humidity` varchar(255) NOT NULL,
`wind_speed` varchar(255) NOT NULL,
`current_pollution_aqius` varchar(255) NOT NULL,
`main_pollutant` varchar(255) NOT NULL,
PRIMARY KEY (`id`));

CREATE TABLE `subs` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`email` varchar(255) NOT NULL,
`discord` varchar(255) NOT NULL,
`ip` varchar(255) NOT NULL,
`location` varchar(255) NOT NULL,
`additional_details` varchar(255) NOT NULL,
`max_aqi` varchar(255) NOT NULL,
PRIMARY KEY (`id`));
```

### Function tests
```shell
# Add Subscriber;
curl -XPOST -H 'Content-Type:application/json' -H 'x-api-key:YOURAPIKEY' http://127.0.0.1:7080/api/addsub -d '{"email": "test","discord": "test","additional_details": "test","max_aqi":3}'
```
```shell
# Add Air Quality reading;
curl -XPOST -H 'Content-Type:application/json' -H 'x-api-key:YOURAPIKEY' http://127.0.0.1:7080/api/addaq -d ''
```

## Example IQAPI response
```json
{
"status": "success",
"data": {
"city": "Port Harcourt",
"state": "Rivers",
"country": "Nigeria",
"location": {
"type": "Point",
"coordinates": [
7.048623,
4.854166
]
},
"forecasts": [
{
"ts": "2019-08-15T12:00:00.000Z",
"aqius": 137,
"aqicn": 69,
"tp": 23,
"tp_min": 23,
"pr": 996,
"hu": 100,
"ws": 2,
"wd": 225,
"ic": "10d"
},
{
"ts": "2019-08-18T09:00:00.000Z",
"aqius": 158,
"aqicn": 94,
"tp": 24,
"tp_min": 24,
"pr": 995,
"hu": 100,
"ws": 2,
"wd": 182,
"ic": "10d"
}
],
"current": {
"weather": {
"ts": "2019-08-15T09:00:00.000Z",
"tp": 23,
"pr": 997,
"hu": 100,
"ws": 1,
"wd": 216,
"ic": "10d"
},
"pollution": {
"ts": "2019-08-15T10:00:00.000Z",
"aqius": 83,
"mainus": "p2",
"aqicn": 39,
"maincn": "p2",
"p2": {
"conc": 27.2,
"aqius": 83,
"aqicn": 39
}
}
},
"history": {
"weather": [
{
"ts": "2019-08-15T09:00:00.000Z",
"tp": 23,
"pr": 997,
"hu": 100,
"ws": 1,
"wd": 216,
"ic": "10d"
},
{
"ts": "2019-08-15T08:00:00.000Z",
"tp": 23,
"pr": 997,
"hu": 100,
"ws": 1,
"wd": 216,
"ic": "10d"
},
{
"ts": "2019-08-13T09:00:00.000Z",
"tp": 22,
"pr": 996,
"hu": 100,
"ws": 2,
"wd": 227,
"ic": "10d"
}
],
"pollution": [
{
"ts": "2019-08-15T10:00:00.000Z",
"aqius": 83,
"mainus": "p2",
"aqicn": 39,
"maincn": "p2",
"p2": {
"conc": 27.2,
"aqius": 83,
"aqicn": 39
}
},
{
"ts": "2019-08-15T07:00:00.000Z",
"aqius": 102,
"mainus": "p2",
"aqicn": 51,
"maincn": "p2",
"p2": {
"conc": 36,
"aqius": 102,
"aqicn": 51
}
}
]
}
}
}
```

### resources
https://api-docs.iqair.com/
https://create-react-app.dev/docs/getting-started
https://react-bootstrap.netlify.app/docs/getting-started/introduction