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.
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 details)
File details
Details for the file airsensor-py-0.0.6.tar.gz
.
File metadata
- Download URL: airsensor-py-0.0.6.tar.gz
- Upload date:
- Size: 3.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6da416b28c9e797141cf5efd412e070f7ad3b8c1a68b71a1753a6d71cce11c06 |
|
MD5 | 1e7792cf9858dae57493a7ace3a1509d |
|
BLAKE2b-256 | 877bd6be6b36b5bff81919d66ebad2f8448ab131df5b2a8939ca471df183bdaa |