Metadata-Version: 1.1
Name: sainsmart
Version: 0.2.0
Summary: sainsmart contains code for working with sainsmart products.
Home-page: https://github.com/vicyap/sainsmart
Author: Victor Yap
Author-email: victor@vicyap.com
License: MIT license
Description: =========
        sainsmart
        =========
        
        
        .. image:: https://img.shields.io/pypi/v/sainsmart.svg
                :target: https://pypi.python.org/pypi/sainsmart
                :alt: PyPi
        
        .. image:: https://img.shields.io/travis/vicyap/sainsmart.svg
                :target: https://travis-ci.org/vicyap/sainsmart
                :alt: Travis Build
        
        .. image:: https://readthedocs.org/projects/sainsmart/badge/?version=latest
                :target: https://sainsmart.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://pyup.io/repos/github/vicyap/sainsmart/shield.svg
                :target: https://pyup.io/repos/github/vicyap/sainsmart/
                :alt: Updates
        
        .. image:: https://coveralls.io/repos/github/vicyap/sainsmart/badge.svg?branch=master
        	    :target: https://coveralls.io/github/vicyap/sainsmart?branch=master
                :alt: Coverage
        
        .. image:: https://ci.appveyor.com/api/projects/status/q1p33rqk0ewcwm29?svg=true
                :target: https://ci.appveyor.com/project/victor/sainsmart/branch/master
                :alt: Windows Build
        
        
        sainsmart contains code for working with sainsmart products.
        
        Usage
        -----
        To use EthernetRelay in a project::
        
            from sainsmart import devices
        
            relay = devices.EthernetRelay()
        
            # Access the state of the relays
            # relay.state() is a list of bools
            relay_state = relay.state()
        
            # Turn on the relay at index 0.
            relay.turn_on(0)
        
            # Turn off the relay at index 0.
            relay.turn_off(0)
        
            # Toggle the state of relay 0.
            relay.toggle(0)
        
            # Turn on all relays.
            relay.all_on()
        
            # Turn off all relays.
            relay.all_off()
        
        The SainSmart Ethernet Relay defaults ip address: 192.168.1.4/30000.
        This can be changed through their web interface.
        
        To use EthernetRelay with a different IP address::
        
            from sainsmart import devices
        
            relay = devices.EthernetRelay('http://192.168.44.100/30000')
        
        
        Example
        -------
        Here is an example with a real device::
        
           >>> from sainsmart import devices
           >>> relay = devices.EthernetRelay()
           >>> relay.state()
           [False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
           >>> relay.turn_on(0)
           >>> relay.state()
           [True, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
           >>> relay.toggle(0)
           >>> relay.state()
           [False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
           >>> relay.all_on()
           >>> relay.state()
           [True, True, True, True, True, True, True, True, True, True, True, True, True, True, True, True]
           >>> relay.turn_off(0)
           >>> relay.state()
           [False, True, True, True, True, True, True, True, True, True, True, True, True, True, True, True]
           >>> relay.all_off()
           >>> relay.state()
           [False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False] 
        
        
        * Free software: MIT license
        * Documentation: https://sainsmart.readthedocs.io.
        
        
        Credits
        ---------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        
        =======
        History
        =======
        
        0.1.0 (2017-06-12)
        -------------------
        
        * First release on PyPI.
        
        0.1.1 (2017-06-12)
        ------------------
        
        * Update usage and docs
        
        0.2.0 (2017-06-12)
        ------------------
        
        * python2.7 support
        * renamed sainsmart.py to devices.py
        
        
Keywords: sainsmart
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
