alex-arzner-pro / luxafor-python

Python Script Interface For Luxafor

Luxafor Python Script

Script written to modify the Luxafor USB LED indicator via command line using python.

Any and all improvements welcome and appreciated.

Credit to gist by dave-irvine for pyusb code.

Requirements

Linux

1. Luxafor LED Indicator
2. Python 2.7+
3. PyUSB (installable via pip)

Windows

1. Luxafor LED Indicator
2. Luxafor Software
3. Python 2.7+
4. PyWinUSB (installable via pip)

Confirmed Working Operating Systems

• Windows 10
• Ubuntu 15.10/17.10/18.10/20.04

Known/Possible Issues

Linux

• Sometimes first run doesn't work, have to run command a second time

Avoid Sudo Prompt

By default python will not let use usb libs and you will need to run command with sudo everytime. To prevent this you will need to do the following:

1: Create a file, /lib/udev/rules.d/50-luxafor.rules with the following contents:

# Allow Luxafor USB control
ACTION=="add", SUBSYSTEMS=="usb", ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="f372", MODE="660", GROUP="plugdev"

2: Reload the udevadm using the following commands:
sudo udevadm control --reload
sudo udevadm trigger

3: Unplug and reinsert your Luxafor device

Windows

• Seems the Luxafor app has to be at least running in the tray for commands to persist
• Opening the Luxafor app switches the color to Green/Red (depeding on last used?)
• Seems that it doesn't always return to the exact same state it was in before a strobe or pattern is ran

Parameters

-d = Device - 1-n for USB device. 0 for all devices (default)
-l = LED - 1-6 for specific LED, 65 for front, 66 for back, 0 for all, 255 for all one color
-r = RED value (0-255)
-g = GREEN value (0-255)
-b = BLUE value (0-255)
-s = Speed value - Determines speed of strobe or fade (0-255)
-t = Repeat value - Determines the frequency of strobe or wave (0-255)
-w = Wave value - 5 Different Patterns available (1-5)
-p = Built In Patterns - 8 built in patterns -x = Hex color value - ("#RRGGBB")

Bluetooth Model

-l LED parameters work differently for the Bluetooth Flag:

• -l 1 = Left LEDs (dongle + flag)
• -l 2 = Right LEDs (dongle + flag)
• -l 3 = Left LED (dongle only)
• -l 4 = Right LED (dongle only)
• -l 0 and -l 255 work the same way
• -l 65 and -l 66 are not compatible

Actions

Color

Set the specified LED to the specified color

luxafor-linux.py color -l 255 -r 255 -g 0 -b 0

Multiple Luxafor Devices

Tested with a Luxafor Flag + Luxafor Bluetooth on the same system. Non-solid color commmands not tested.

# First USB device to color red:
luxafor-linux.py -d 1 color -l 255 -r 255 -g 0 -b 0

# Second USB device to color blue:
luxafor-linux.py -d 2 color -l 255 -r 0 -g 0 -b 255

# All USB devices to color green:
luxafor-linux.py color -l 255 -r 0 -g 255 -b 0
# or with explicit parameter:
luxafor-linux.py color -d 0 -l 255 -r 0 -g 255 -b 0

Hex Color (Linux)

luxafor-linux.py color -x "#F22613"

Fade

luxafor-linux.py fade -l 255 -r 0 -g 255 -b 0

Strobe

luxafor-linux.py strobe -l 255 -r 0 -g 0 -b 255 -s 20 -t 5

Wave

luxafor-linux.py wave -w 4 -r 0 -g 0 -b 255 -s 20 -t 3 

Pattern

luxafor-linux.py pattern -p 2 -r 3

Raw Values

Solid Color

Raw data array posisitions as follows:

0. Always 0
1. 1
2. 1-6 for specific LED, 65 for front, 66 for back, 0 for all, 255 for all one color
3. RED Value 0-255
4. GREEN Value 0-255
5. BLUE Value 0-255
6. N/A
7. N/A
8. N/A

Fade Color

Raw data array posisitions as follows:

0. Always 0
1. 2
2. 1-6 for specific LED, 65 for front, 66 for back, 0 for all, 255 for all one color
3. RED Value 0-255
4. GREEN Value 0-255
5. BLUE Value 0-255
6. Changing Time (Duration)
7. N/A
8. N/A

Strobe Color

Raw data array posisitions as follows:

0. Always 0
1. 3
2. 1-6 for specific LED, 65 for front, 66 for back, 0 for all, 255 for all one color
3. RED Value 0-255
4. GREEN Value 0-255
5. BLUE Value 0-255
6. Speed (30-40 is a fairly calm value)
7. N/A
8. N/A

Wave Color

0. Always 0
1. 4
2. Wave Type
3. RED Value 0-255
4. GREEN Value 0-255
5. BLUE Value 0-255
6. N/A
7. Repeat (0-255)
8. Speed (10 is a fairly good value)

Built In Patterns

0. Always 0
1. 6
2. Pattern Number (1-8)
3. Repeat (0-255)
4. N/A
5. N/A
6. N/A
7. N/A
8. N/A