Metadata-Version: 1.1
Name: lifx-cmd
Version: 0.1.2
Summary: LifX command line utility to change the state of your lifx bulb. Supports powering on/off, changing RGB/HSB color and temperature.
Home-page: https://github.com/MichaelAquilina/lifx-cmd
Author: Michael Aquilina
Author-email: michaelaquilina@gmail.com
License: BSD
Description: =====================
        LifX Command Utility
        =====================
        
        LifX command line utility to change the state of your lifx bulb. Essentially a wrapper for the `pylifx` python module.
        
        Supports powering on/off, changing RGB/HSB color and temperature.
        
        * Free software: BSD license
        
        Installation
        ------------
        
        The easiest way to install this utility is using pip:
        
        .. code-block:: bash
        
            $ pip install lifx-cmd
        
        Alternatively you can install by downloading this github repo and installing it manually:
        
        .. code-block:: bash
        
            $ git clone https://github.com/MichaelAquilina/lifx-cmd
            $ cd lifx-cmd
            $ python setup.py install
        
        Setup
        -----
        
        Assuming you've already connected your lifx bulb to your home network, you will now need to specify the bulb you are
        communicating with. The easiest way to do this is to add a `.lifx` file to your home directory with the bulb's MAC address:
        
        .. code-block:: bash
        
            $ echo "03-1F-7B-7B-64-F6" > "~/.lifx"
        
        The command utility will automatically search for this file on execution. Alternatively you can specify the MAC address from
        the environment variable LIFXBULB:
        
        .. code-block:: bash
        
            $ export LIFXBULB="03-1F-7B-7B-64-F6"
        
        Finally, you can simply specify the mac address as a command line parameter:
        
        .. code-block:: bash
        
            $ lifx --bulb "03-1F-7B-7B-64-F6" power on
        
        Features
        --------
        
        Power your bulb on and off:
        
        .. code-block:: bash
        
            $ lifx power on
            $ lifx power off
        
        Change its RGB state:
        
        .. code-block:: bash
        
            $ lifx rgb 1 0 0   # Red light
            $ lifx rgb 0 1 0   # Green light
            $ lifx rgb 0 0 1   # Blue light
            $ lifx rgb 1 0 1   # Magenta light
        
        etc...
        
        Same approach can be taken with HSB. For example:
        
        .. code-block:: bash
        
            $ lifx hsb 0 1 1
        
        The temperature of the bulb can also be set to yellow tinge or pure white LED:
        
        .. code-block:: bash
        
            $ lifx temperature 65535   # bright white
            $ lifx temperature 0       # classic yellow
        
        By default the bulb is set to fade in changes sent over a period of 1 second. You can change this with the -f flag:
        
        .. code-block:: bash
        
            $ lifx -f 0 rgb 0 1 0           # Immediately change to green
            $ lifx -f 10 temperature 65535  # Change to white over a period of 10 seconds
        
        
        
        
        History
        -------
        
        0.1.2 (2015-06-21)
        ---------------------
        
        * Don't fail if only ~/.lifx is available
        
        
        0.1.1 (2015-06-20)
        ---------------------
        
        * Add missing read from ~/.lifx file functionality
        
        0.1.0 (2015-06-20)
        ---------------------
        
        * First release on PyPI.
        
Keywords: lifx-cmd
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
