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

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-0.8.8.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiolifx-0.8.8-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiolifx-0.8.8.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.6

File hashes

Hashes for aiolifx-0.8.8.tar.gz
Algorithm Hash digest
SHA256 795e9707c879539cc085c074ba61801416e75863406c586c497ad460e77303ca
MD5 e64bd6058678f3681d45b7a210c3c3fe
BLAKE2b-256 124e19d1ea8765e877ef14624f5d14ed0343ddd6d68a6903aef49f057ead97f9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiolifx-0.8.8-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.6

File hashes

Hashes for aiolifx-0.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f13159a86c262c0978b672e060ab619edd9b41ad018caba715d6f9c7a64eaa3a
MD5 340f7cec5b79a3357e885b99eb0294c5
BLAKE2b-256 c25b27a92d26ea1fc9f0a4245b6ac5fc7a2b802242114db7cf70fd43104016c2

See more details on using hashes here.

Supported by

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