https://github.com/facelessuser/pyluxa4
Luxafor flag controller
https://github.com/facelessuser/pyluxa4
Last synced: about 1 year ago
JSON representation
Luxafor flag controller
- Host: GitHub
- URL: https://github.com/facelessuser/pyluxa4
- Owner: facelessuser
- License: mit
- Created: 2019-09-10T15:58:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-16T19:45:45.000Z (over 2 years ago)
- Last Synced: 2025-03-27T08:01:50.720Z (over 1 year ago)
- Language: Python
- Homepage: https://facelessuser.github.io/pyluxa4/
- Size: 1.84 MB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Python Luxafor
> **warning**
> This library has only been tested on the [Luxafor Flag](https://luxafor.com/product/flag/). It may or may not work on
> other devices.
`pyluxa4` is a Python library for controlling [Luxafor](https://luxafor.com/) devices. You can set colors, blink them,
fade them, apply a wave effect, and even run its built-in patterns. All of this is done by running a small server that
is accessed locally on port 5000 (the port can be changed). Once running, you can issue commands from the CLI tool,
which in turns communicates with the server using a REST API.
Since the server uses a REST API, you could easily write scripts in other languages to control the device once running.
If desired, you can import the `pyluxa4.usb` library in a script and control the device directly without running a
server. Or you could import `pyluxa4.client` and write your own application that uses the REST API to control the device
through the server.
`pyluxa4` requires [libusb/hidapi](https://github.com/libusb/hidapi) to be installed in order for the controller portion
of the library to be functional.
## Documentation
Documentation is found here: https://facelessuser.github.io/pyluxa4/
## License
MIT License