AirGradient Test API App v2.3.0-rc.2
Pre-releaseAirGradient Test API App v2.3.0-rc.2
Release candidate — for testing and demonstration. The Python + localhost app remains the main product. This update adds compact parameter/value lists to map popups and device cards in both editions.
Install and run
- Install Python from python.org. Python 3.9+ is the compatibility minimum; use a currently supported stable version for a new setup. Windows setup · macOS downloads · Linux guidance.
- Connect to the internet to fetch live API readings and load online map/library resources.
- Download AirGradient-Test-API-App-v2.3.0-rc.2.zip from this release's Assets and extract it.
- Open a terminal in the extracted folder. Run
py serve.pyon Windows orpython3 serve.pyon macOS/Linux. - Open the exact local URL printed by Python. Leave the terminal open; stop it with Ctrl+C.
No extra Python packages are needed. Do not open the HTML directly.
Short setup guide ·
Full user guide
Supplementary web preview
The Python + localhost app remains the main product. For convenient viewing
without installing Python, open the supplementary GitHub Pages preview.
Use the main app for the fuller experience and better results when testing the API:
on-demand upstream requests, configurable devices, correction selection, and
permission-based hourly access. It does not improve underlying sensor accuracy.
| Main local app (recommended) | Supplementary website |
|---|---|
Install Python, run serve.py, open the printed local URL |
Open the website; visitors need only internet and a browser |
| Requests data on demand, subject to API cadence/cache | Displays snapshots collected on a nominal 15-minute GitHub schedule |
| Device controls, corrected/raw selection, illustrative AQI, authorized hourly history | Five fixed devices, raw PM2.5, returned fields, world map, and published JSON |
| Tokens stay in your local server's memory | No token entry or private/authenticated data |
The page labels itself as supplementary and links back to the main download.
Reload published data only reloads the latest published snapshot; it does not
trigger AirGradient collection. GitHub scheduling/deployment delays add latency.
Measurement time and per-device collection time are displayed separately in UTC.
Failures may retain earlier readings with explicit errors and original timestamps;
missing readings remain unavailable. The browser checks for published updates every
five minutes while visible. Readings older than 20 minutes and collection gaps over
45 minutes are flagged. These are demo thresholds, not a service guarantee.
GitHub may disable scheduled collection after 60 days without repository activity.
If updates stop, check the Pages workflow
or use the main local app. Full supplementary guide.
Air Quality Data: changes in this release candidate
- Click a map location to inspect PM1/2.5/10, particle count, CO2, NO2, O3, temperature, RH, pressure and all additional returned measurements in small rows.
- Show the same parameter/value list on every device card. Keep PM2.5/AQI prominent; NO2/O3 now use the same styling as other parameters.
- Explain N/A (known unsupported), N/D (expected or returned field without data), and — (not reported, support unknown), without guessing capability from absence.
- Preserve zeros, negative-value warnings, field units, timestamps and unknown fields. Original JSON remains available.
- Fix main-map marker clicks so the popup remains open after selecting a device; constrain popup height for scrolling on smaller screens.
- Update guides and local/published wiki. Device order and saved preferences remain unchanged.
- Use “Air Quality Data” in relevant app, documentation and wiki headings.
Optional project support
https://ko-fi.com/s/3f1e7ff9a0 · Gadash on Ko-fi.
Support is voluntary; the app remains free under MIT-0. The repository's Sponsor section offers the same links.
License
MIT No Attribution (MIT-0). Freely use, change, share, and sell the original
code and documentation. Attribution is not required; optional credit to Akila DJ
is welcome. No requirement to publish changes or use the same license. Provided
as is, without warranty. Third-party data, libraries, and maps keep their own terms.
Full project license ·
Official MIT-0 license ·
Third-party notices
Testing scope and limitations
Validation covers Python/JavaScript syntax, release ZIP integrity, data handling
and cross-edition parameter-list consistency, including absence notation, unknown
fields, zero/negative values and units. Browser checks exercise clicked popups,
card values, mobile overflow and the main app's correction selector. Authenticated
hourly history requires an authorized token and was not live-tested. This is a
release candidate, not an accuracy certification or an official AirGradient app.
The ZIP distributes the main local app plus the supplementary website source.
Generated live snapshots are not bundled. GitHub also provides source ZIP/tar
downloads; the named app ZIP includes an additional per-file checksum manifest.
The supplementary hosted page is available separately at the link above.