Metadata-Version: 2.1
Name: pyseneye
Version: 0.0.1
Summary: A module for interacting with the Seneye range or aquarium and pond sensors
Home-page: http://github.com/mcclown/pyseneye/
Author: Stephen Mc Gowan
Author-email: mcclown@gmail.com
License: Apache Software License
Description: pyseneye
        ========
        
        |Build Status| |Coverage Status|
        
        A module for working with the Seneye range of aquarium and pond sensors.
        Support is provided for the HID/USB driver for the device although it is
        intended to add support for their API later.
        
        When using this, readings will not be synced to the Seneye.me cloud
        service. This module is in no way endorsed by Seneye and you use it at
        your own risk.
        
        Generated documentation can be found
        `here <http://pyseneye.readthedocs.io/en/latest/>`__
        
        Quickstart
        ----------
        
        Install pyseneye using ``pip``: ``$ pip install pyseneye``. Once that is
        complete you can import the SUDevice class and connect to your device.
        
        .. code:: python
        
            >>> from pyseneye.sud import SUDDevice, Action
            >>> d = SUDevice()
        
        Once the class is initialised you can put the Seneye into interactive
        mode and then retrieve sensor readings.
        
        .. code:: python
        
            >>> d.action(Action.ENTER_INTERACTIVE_MODE)
            >>> s = d.action(Action.SENSOR_READING)
            >>> s.ph
            8.16
            >>> s.nh3
            0.007
            >>> s.temperature
            25.125
            >>> d.action(Action.LEAVE_INTERACTIVE_MODE)
            >>> d.close()
        
        You need access to the USB device, so these calls may require elevated
        privileges.
        
        Issues & Questions
        ------------------
        
        If you have any issues, or questions, please feel free to contact me, or
        open an issue on GitHub
        
        .. |Build Status| image:: https://travis-ci.org/mcclown/pyseneye.svg?branch=master
           :target: https://travis-ci.org/mcclown/pyseneye
        .. |Coverage Status| image:: https://coveralls.io/repos/mcclown/pyseneye/badge.svg?branch=master&service=github
           :target: https://coveralls.io/github/mcclown/pyseneye?branch=master
        
Platform: any
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Hardware
Provides-Extra: testing
