Metadata-Version: 1.0
Name: airsensor-py
Version: 0.0.2
Summary: Python package for getting sensor values from an Ambient Air Sensor
Home-page: https://github.com/dfederschmidt/airsensor-py
Author: Daniel Federschmidt
Author-email: daniel@federschmidt.xyz
License: Copyright 2017 Daniel Federschmidt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Description-Content-Type: UNKNOWN
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.md](LICENSE.md) 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.
Platform: UNKNOWN
