Skip to main content

Python package for getting sensor values from an Ambient Air Sensor

Project description

# airsensor-py

Python package for getting sensor values from an Ambient Air Sensor such as offered by [Rehau](https://www.amazon.co.uk/Rehau-USB-Stick-Ambient-Sensor/dp/B00ZXP6EI4).

## Getting Started

This section will introduce you to airsensor-py and how to install and use it for fun and profit.

### Prerequisites

Make sure that python 3 + pip is installed.

### Installing

```
pip install airsensor-py
```

## Usage

You can either use this package as a library in your code or using the bundled CLI. You'll have to run it as root or set up a udev rule to grant r/w access to the device to the user. For more instructions on that, see [here](https://github.com/tuxedo0801/usb-sensors-linux).

### Library

```
from airsensor.core import AirSensor
airsensor = AirSensor()
voc = airsensor.get_voc()
print(voc)

> 450
```

### CLI

```
$ airsensor-py

> 450
```

## Built With

* [PyUSB](https://walac.github.io/pyusb/)

## License

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

## Contribution

Want to add a feature or report a bug? Open an issue or a pull request for me!

## Acknowledgments

* [A C implementation](https://code.google.com/archive/p/airsensor-linux-usb/) was done by Rodric Yates which I used to see how the interaction with the device works.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airsensor-py-0.0.6.tar.gz (3.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page