Metadata-Version: 1.0
Name: Airer
Version: 0.1.1.dev0
Summary: UNKNOWN
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: BSD 3-Clause
Description: # Airer
        
        Airer is a utility designed to read the Nova SDS011 particulate matter sensor.
        
        ## Vision
        
        While at the moment Airer only supports the SDS011 sensor, the vision is to
        grow Airer to include support for other air quality sensors, enabling anyone to
        rapidly produce applications to monitor air quality.
        
        If you are interested in helping bring this vision closer to reality, please
        consider [contributing](CONTRIBUTING.md)!
        
        ## Usage
        
        ### SDS011
        
        The SDS011 particulate matter sensor is supported through the `sds011` module.
        This module acts as both a library for interfacing with your application, but
        a command-line interface is also provided to manually manage your sensor.
        
        Once installed, the CLI can rapidly be used:
        
        ```bash
        $ python -m airer.sds011
        usage: sds011.py [-h] [-d DEVICE] [-s SPEED] {read,mode} ...
        ```
        
        Factory-shipped, the SDS011 will run in the `active` mode, where it will
        frequently take readings when powered, regardless of anything receiving or
        using these. This, together with the limited lifetime of the laser (around
        8,000 hours), may make it desirable to take readings on demand using `query`
        mode.
        
        To check what mode your SDS011 is currently set to using the CLI:
        
        ```bash
        $ python -m airer.sds011 mode
        Device ID: 61697
        Reporting Mode: active
        ```
        
        To put the SDS011 into `query` mode, and persist this change between power
        cycles:
        
        ```bash
        $ python -m airer.sds011 mode query
        Device ID: 61697
        Reporting Mode: query
        ```
        
        To take a reading of the sensor with the CLI while in `query` mode:
        
        ```bash
        $ python -m airer.sds011 read --query
        Device ID: 61697
        PM2.5 (µg/m³): 1.5
        PM10 (µg/m³): 1.7
        ```
        
        In `active` mode, omitting `--query` is all that is required.
        
Platform: UNKNOWN
