Metadata-Version: 2.4
Name: airthings-ble
Version: 1.2.0
Summary: Manage Airthings BLE devices
License-File: LICENSE
Author: Vincent Giorgi
Requires-Python: >=3.11
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: async-interrupt (>=1.2.2)
Requires-Dist: bleak (>=1.0.1) ; python_version < "3.14"
Requires-Dist: bleak-retry-connector (>=4.4.3)
Requires-Dist: cbor2 (>=5.6.5)
Project-URL: Bug Reports, https://github.com/Airthings/airthings-ble/issues
Project-URL: Homepage, https://www.airthings.com
Project-URL: Source, https://github.com/Airthings/airthings-ble
Description-Content-Type: text/markdown

# airthings-ble

Library to control Airthings devices through BLE, primarily meant to be used in
the [Home Assistant integration](https://www.home-assistant.io/integrations/airthings_ble/).

## Supported devices

This library supports the following Airthings devices:

- [Corentium Home 2](https://www.airthings.com/products/corentium-home-2)
- [Wave Enhance](https://www.airthings.com/wave-enhance)
- Wave Gen 1
- [Wave Mini](https://www.airthings.com/wave-mini)
- [Wave Plus](https://www.airthings.com/wave-plus)
- [Wave Radon](https://www.airthings.com/wave-radon)

## Unsupported devices
Although some other devices have BLE capabilities, they use BLE only for onboarding and configuration. It is **not** possible to fetch sensor data using this library from, for example:

-	Hub
-	[Renew](https://www.airthings.com/renew)
-	[View Plus](https://www.airthings.com/view-plus)
-	View Pollution
-	[View Radon](https://www.airthings.com/view-radon)

## Getting Started

Prerequisites:

- [Python](https://www.python.org/downloads/) with version 3.12 that is required by Home Assistant ([docs](https://developers.home-assistant.io/docs/development_environment?_highlight=python&_highlight=versi#manual-environment) or [reference](https://github.com/home-assistant/architecture/blob/master/adr/0002-minimum-supported-python-version.md))
- [Poetry](https://python-poetry.org/docs/#installation)

Install dependencies:

```bash
poetry install
```

Run tests:

```bash
poetry run pytest
```

See [this wiki page](https://github.com/Airthings/airthings-ble/wiki/Testing-with-Home-Assistant) for more details
on how to test the library with HA.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.