Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aiolifx/aiolifx
Python async library used by Home Assistant to control LIFX bulbs using LAN protocol
https://github.com/aiolifx/aiolifx
async-await asyncio home-assistant homeassistant iot lifx lifx-api lifx-bulbs lifx-lan-protocol lifx-lights
Last synced: 1 day ago
JSON representation
Python async library used by Home Assistant to control LIFX bulbs using LAN protocol
- Host: GitHub
- URL: https://github.com/aiolifx/aiolifx
- Owner: aiolifx
- License: mit
- Created: 2017-02-20T09:23:13.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T09:53:47.000Z (10 days ago)
- Last Synced: 2025-01-22T02:08:52.738Z (9 days ago)
- Topics: async-await, asyncio, home-assistant, homeassistant, iot, lifx, lifx-api, lifx-bulbs, lifx-lan-protocol, lifx-lights
- Language: Python
- Homepage:
- Size: 299 KB
- Stars: 22
- Watchers: 7
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# aiolifx
aiolifx is a Python 3/asyncio library to control Lifx LED lightbulbs over your LAN.
[](https://pypi.python.org/pypi/aiolifx)
[](https://lbesson.mit-licen)
[](https://github.com/psf/black)
[](https://pepy.tech/project/aiolifx)
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`
```bash
pip3 install . && aiolifx
```
# Thanks
Thanks to Anders Melchiorsen and Avi Miller for their essential contributions