https://github.com/dfederschmidt/airsensor-py
Python package for getting sensor values from an Ambient Air Sensor
https://github.com/dfederschmidt/airsensor-py
airquality home-automation python3 pyusb
Last synced: 26 days ago
JSON representation
Python package for getting sensor values from an Ambient Air Sensor
- Host: GitHub
- URL: https://github.com/dfederschmidt/airsensor-py
- Owner: dfederschmidt
- License: mit
- Created: 2017-10-06T21:52:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-07T09:40:41.000Z (over 4 years ago)
- Last Synced: 2025-01-20T12:47:17.121Z (4 months ago)
- Topics: airquality, home-automation, python3, pyusb
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# airsensor-py
[](https://badge.fury.io/py/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).
## About VOC sensors
VOC (**V**olatile **O**rganic **C**ompounds) potentially contribute to long-term health issues when exposed to them over a long time period [1].
The sensor outputs numerical values typically in the 450-2000 range. According to the internet [2]:
* **450-1000** Good air quality
* **1000-1500** Medium air quality
* **1500-** Bad air quality, consider opening a window for fresh air.
## 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
This package is published on pip from time to time.
```
pip install airsensor-py
```
To get the most recent version, clone this repository and install locally.
```
git clone https://github.com/dfederschmidt/airsensor-py
cd airsensor-py
pip install -r requirements.txt
pip install -e .
```
## 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
```
or
```
$ airsensor-py --json
> {"timestamp": "2017-05-05 10:30:05", "voc": 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.
## References
* [1] https://toxtown.nlm.nih.gov/text_version/chemicals.php?id=31
* [2] http://nicht-traeumen-sondern-machen.de/RaspberryPi_Basteleien/Code_Luftqualitaet.php?anker=a7