Metadata-Version: 1.2
Name: pyzerproc
Version: 0.2.1
Summary: Library to control Zerproc Bluetooth LED smart string lights
Home-page: https://github.com/emlove/pyzerproc
Author: Emily Mills
Author-email: emily@emlove.me
License: Apache Software License 2.0
Description: =========
        pyzerproc
        =========
        
        
        .. image:: https://img.shields.io/pypi/v/pyzerproc.svg
                :target: https://pypi.python.org/pypi/pyzerproc
        
        .. image:: https://img.shields.io/travis/emlove/pyzerproc.svg
                :target: https://travis-ci.org/emlove/pyzerproc
        
        .. image:: https://coveralls.io/repos/emlove/pyzerproc/badge.svg
                :target: https://coveralls.io/r/emlove/pyzerproc
        
        
        Library to control Zerproc Bluetooth LED smart string lights
        
        * Free software: Apache Software License 2.0
        
        
        Features
        --------
        
        * Discover nearby devices
        * Turn lights on and off
        * Set light color
        * Get light status
        
        
        Command line usage
        ------------------
        pyzerproc ships with a command line tool that exposes the features of the library.
        
        .. code-block:: console
        
            $ pyzerproc discover
            INFO:pyzerproc.discovery:Starting scan for local devices
            INFO:pyzerproc.discovery:Discovered AA:BB:CC:00:11:22: LEDBlue-CC001122
            INFO:pyzerproc.discovery:Discovered AA:BB:CC:33:44:55: LEDBlue-CC334455
            INFO:pyzerproc.discovery:Scan complete
            AA:BB:CC:00:11:22
            AA:BB:CC:33:44:55
        
            $ pyzerproc turn-on AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Connecting to AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Turning on AA:BB:CC:00:11:22
        
            $ pyzerproc turn-off AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Connecting to AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Turning off AA:BB:CC:00:11:22
        
            $ pyzerproc set-color AA:BB:CC:00:11:22 ff0000
            INFO:pyzerproc.light:Connecting to AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Changing color of AA:BB:CC:00:11:22 to #ff0000
        
            $ pyzerproc set-color AA:BB:CC:00:11:22 00ff00
            INFO:pyzerproc.light:Connecting to AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Changing color of AA:BB:CC:00:11:22 to #00ff00
        
            $ pyzerproc is-on AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Connecting to AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Got state of AA:BB:CC:00:11:22: <LightState is_on='True' color='(255, 0, 0)'>
            True
        
            $ pyzerproc get-color AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Connecting to AA:BB:CC:00:11:22
            INFO:pyzerproc.light:Got state of AA:BB:CC:00:11:22: <LightState is_on='True' color='(255, 0, 0)'>
            ff0000
        
        
        Usage
        -----
        
        Discover nearby devices
        
        .. code-block:: python
        
            import pyzerproc
        
            lights = pyzerproc.discover(timeout=30)
        
            for light in lights:
                print("Address: {} Name: {}".format(light.address, light.name))
        
        
        Turn a light on and off
        
        .. code-block:: python
        
            import pyzerproc
            import time
        
            address = "AA:BB:CC:00:11:22"
        
            light = pyzerproc.Light(address)
        
            try:
                light.connect(auto_reconnect=True)
                light.turn_on()
        
                time.sleep(5)
        
                light.turn_off()
            finally:
                light.disconnect()
        
        
        Change the light color
        
        .. code-block:: python
        
            import pyzerproc
            import time
        
            address = "AA:BB:CC:00:11:22"
        
            light = pyzerproc.Light(address)
        
            try:
                light.connect()
        
                while True:
                    light.set_color(255, 0, 0) # Red
                    time.sleep(1)
                    light.set_color(0, 255, 0) # Green
                    time.sleep(1)
            finally:
                light.disconnect()
        
        
        Get the light state
        
        .. code-block:: python
        
            import pyzerproc
            import time
        
            address = "AA:BB:CC:00:11:22"
        
            light = pyzerproc.Light(address)
        
            try:
                light.connect()
        
                state = light.get_state()
        
                if state.is_on:
                    print(state.color)
                else:
                    print("Off")
            finally:
                light.disconnect()
        
        
        Changelog
        ---------
        0.2.1 (2020-05-09)
        ~~~~~~~~~~~~~~~~~~
        - Wrap upstream exceptions
        
        0.2.0 (2020-05-09)
        ~~~~~~~~~~~~~~~~~~
        - Expose exception objects
        - Expose light address and name on discovery
        
        0.1.1 (2020-05-08)
        ~~~~~~~~~~~~~~~~~~
        - Expose auto reconnect
        
        0.1.0 (2020-05-07)
        ~~~~~~~~~~~~~~~~~~
        - Discover nearby devices
        
        0.0.2 (2020-05-05)
        ~~~~~~~~~~~~~~~~~~
        - Get the current light state
        
        0.0.1 (2020-05-04)
        ~~~~~~~~~~~~~~~~~~
        - Initial release
        
        
        Credits
        -------
        
        - Thanks to `Uri Shaked`_ for an incredible guide to `Reverse Engineering a Bluetooth Lightbulb`_.
        
        - This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _`Uri Shaked`: https://medium.com/@urish
        .. _`Reverse Engineering a Bluetooth Lightbulb`: https://medium.com/@urish/reverse-engineering-a-bluetooth-lightbulb-56580fcb7546
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
Keywords: pyzerproc
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
