Python: AirGradient

Asynchronous Python client for the legacy and versioned AirGradient Local APIs.

About

This package allows you to fetch data from AirGradient.

Installation

pip install airgradient

Usage

import asyncio

from airgradient import AirGradientClient


async def main() -> None:
    """Show example of fetching measurement."""
    async with AirGradientClient("10.0.0.123") as client:
        measurements = await client.get_current_measures()
        print(measurements)


if __name__ == "__main__":
    asyncio.run(main())

The client probes the Local API once, when the first device operation is made. An optional ApiVersion hint changes which route is tried first, but the version is selected only after a measures response succeeds and parses. The selected version is available through the read-only api_version property and does not change for that client instance.

from airgradient import AirGradientClient, ApiVersion

client = AirGradientClient("10.0.0.123", api_version=ApiVersion.V1)

Public measures, config, and correction models are normalized plain dataclasses. To normalize a raw payload whose Local API version is already known, use the versioned parsing helpers:

from airgradient import ApiVersion, parse_config_json, parse_measures_json

measures = parse_measures_json(payload, api_version=ApiVersion.V1)
config = parse_config_json(config_payload, api_version=ApiVersion.V1)

The API version is required because isolated config payloads cannot always be distinguished by their fields. Public normalized models do not expose wire serialization methods such as from_json() or to_json().

Configuration setters return when the device admits the request: legacy devices respond with 200, while V1 devices respond with 202. Admission does not guarantee that an asynchronous update has already been persisted or activated. The library does not retry busy requests or poll for convergence. Callers should handle AirGradientBusyError, AirGradientForbiddenError, and AirGradientNotSupportedError as appropriate.

When a caller provides an aiohttp.ClientSession, the caller retains ownership and must close it. A session created internally by AirGradientClient is closed by close() or on async context-manager exit.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.11+
• Poetry
• NodeJS 12+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The content is by Joost Lekkerkerker.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2024 AirGradient

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.