Skip to main content

API for local communication with LIFX devices over a LAN with asyncio.

Project description

aiolifx

aiolifx is a Python 3/asyncio library to control Lifx LED lightbulbs over your LAN.

PyPI version fury.io MIT license GITHUB-BADGE Downloads

Most of it was taken from Meghan Clarkk lifxlan package (https://github.com/mclarkk) and adapted to Python 3 (and asyncio obviously)

Installation

We are on PyPi so

 pip3 install aiolifx

or python3 -m pip install aiolifx

After installation, the utility

aiolifx

can be used to test/control devices.

NOTE: When installing with Python 3.4, the installation produce an error message (syntax error). This can be safely ignored.

How to use

Essentially, you create an object with at least 2 methods:

- register
- unregister

You then start the LifxDiscovery task in asyncio. It will register any new light it finds. All the method communicating with the bulb can be passed a callback function to react to the bulb response. The callback should take 2 parameters:

- a light object
- the response message

The easiest way is to look at the file in the examples directory. "Wifi" and "Uptime" use a callback to print the info when it is returned.

In essence, the test program is this

class bulbs():
""" A simple class with a register and unregister methods
"""
    def __init__(self):
        self.bulbs=[]

    def register(self,bulb):
        self.bulbs.append(bulb)

    def unregister(self,bulb):
        idx=0
        for x in list([ y.mac_addr for y in self.bulbs]):
            if x == bulb.mac_addr:
                del(self.bulbs[idx])
                break
            idx+=1

def readin():
"""Reading from stdin and displaying menu"""

    selection = sys.stdin.readline().strip("\n")
    DoSomething()

MyBulbs = bulbs()
loop = aio.get_event_loop()
discovery = alix.LifxDiscovery(loop, MyBulbs)
try:
    loop.add_reader(sys.stdin, readin)
    discovery.start()
    loop.run_forever()
except:
    pass
finally:
    discovery.cleanup()
    loop.remove_reader(sys.stdin)
    loop.close()

Other things worth noting:

-  Whilst LifxDiscovery uses UDP broadcast, the bulbs are
   connected with Unicast UDP

- The socket connecting to a bulb is not closed unless the bulb is deemed to have
  gone the way of the Dodo. I've been using that for days with no problem

- You can select to used IPv6 connection to the bulbs by passing an
  IPv6 prefix to LifxDiscovery. It's only been tried with /64 prefix.
  If you want to use a /48 prefix, add ":" (colon) at the end of the
  prefix and pray. (This means 2 colons at the end!)

- I only have Original 1000, so I could not test with other types
  of bulbs

- Unlike in lifxlan, set_waveform takes a dictionary with the right
  keys instead of all those parameters

Development

Running locally

Run this command each time you make changes to the project. It enters at __main__.py

pip3 install . && aiolifx

Thanks

Thanks to Anders Melchiorsen and Avi Miller for their essential contributions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiolifx-1.1.1.tar.gz (43.6 kB view details)

Uploaded Source

Built Distribution

aiolifx-1.1.1-py3-none-any.whl (45.4 kB view details)

Uploaded Python 3

File details

Details for the file aiolifx-1.1.1.tar.gz.

File metadata

  • Download URL: aiolifx-1.1.1.tar.gz
  • Upload date:
  • Size: 43.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for aiolifx-1.1.1.tar.gz
Algorithm Hash digest
SHA256 a19a6adaa500b6a0da461816f526db418f73f3556aaea5e144b9a968fb68f7e0
MD5 f966c35f59e4551b9986f395b239598c
BLAKE2b-256 de37c0bd69db50408c384e570ca3dcec019219c5da428ff4e30d8ba51e6a5c8f

See more details on using hashes here.

File details

Details for the file aiolifx-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: aiolifx-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 45.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for aiolifx-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b6ad157f5890ab5af5962c54f3044e63a71d9232c19fe3638e1eeb8d9d17c5b3
MD5 67452ddbf5f62da1fa0d5f80190a1633
BLAKE2b-256 fe081f9e79a5b3ec48bc3ba10f7c5aa4127a7e3f2fa0b0618c3a1afb48a2562a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page