Skip to main content

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

Metadata

Release files for aiolifx 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiolifx 1.0.4
File Size Uploaded Provenance Actions
aiolifx-1.0.4.tar.gz 42.9 kB Without provenance Details for aiolifx-1.0.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aiolifx 1.0.4
File Interpreter ABI Platform Actions
aiolifx-1.0.4-py3-none-any.whl Python 3 none any Details for aiolifx-1.0.4-py3-none-any.whl

Total release size: 87.5 kB

Release files / aiolifx-1.0.4.tar.gz

Download URL aiolifx-1.0.4.tar.gz
Size 42.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f048e6ce275cc483a81fef3ca4452e48999ba54df807c760cfd72cbe541ff0ab
BLAKE2b-256 checksum
How to use checksums
21bec3e3f41d39b73806d6cee7eb382e5f27c4ca18b7ffad13ca25417897c207
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.1

Release files / aiolifx-1.0.4-py3-none-any.whl

Download URL aiolifx-1.0.4-py3-none-any.whl
Size 44.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
185cb3a5cb568491f7cc7e13767220be57f44483c43f63807821ec2f1b00615e
BLAKE2b-256 checksum
How to use checksums
cb849afbfaff7002bc06dd8d2a61b5090f568e250e7f0c13931ed6dfb03cd368
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.1

Security for aiolifx 1.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page