Python package for getting sensor values from an Ambient Air Sensor
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
airsensor
bin
.gitignore
LICENSE.txt
MANIFEST.in
README.md
requirements.txt
setup.py

README.md

airsensor-py

PyPI version

Python package for getting sensor values from an Ambient Air Sensor such as offered by Rehau.

About VOC sensors

VOC (Volatile Organic Compounds) 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.

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

License

This project is licensed under the MIT License - see the 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 was done by Rodric Yates which I used to see how the interaction with the device works.

References