ajazz-rgb-cli 1.0.0__tar.gz

ajazz_rgb_cli-1.0.0/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: ajazz-rgb-cli
+Version: 1.0.0
+Summary: A terminal app to configure Ajazz AK820 Pro RGB on Linux
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: hidapi>=0.14.0

ajazz_rgb_cli-1.0.0/ajazz_cli/Device.py

@@ -0,0 +1,150 @@
+import hid
+import time
+
+CONTROL_INTERFACE = 3
+PACKET_LENGTH = 64
+
+# Command Codes (Preamble packet byte 1)
+CMD_SAVE = 0x02
+CMD_MODE = 0x13
+
+MAX_BRIGHTNESS = 5
+MAX_SPEED = 3
+DEFAULT_DIRECTION = 0
+
+
+LIGHTING_MODES = {
+    'Off': 0x00,
+    'Static': 0x01,
+    'Single On': 0x02,
+    'Single Off': 0x03,
+    'Glittering': 0x04,
+    'Falling': 0x05,
+    'Colourful': 0x06,
+    'Breath': 0x07,
+    'Spectrum': 0x08,
+    'Outward': 0x09,
+    'Scrolling': 0x0a,
+    'Rolling': 0x0b,
+    'Rotating': 0x0c,
+    'Explode': 0x0d,
+    'Launch': 0x0e,
+    'Ripples': 0x0f,
+    'Flowing': 0x10,
+    'Pulsating': 0x11,
+    'Tilt': 0x12,
+    'Shuttle': 0x13,
+}
+
+DIRECTIONS = {'Left': 0, 'Down': 1, 'Up': 2, 'Right': 3}
+SLEEP_TIMERS = {'Never': 0, '1 minute': 1, '5 minutes': 2, '30 minutes': 3}
+
+class Device:
+    def __init__(self, vendor_id, product_id):
+        self.vendor_id = vendor_id
+        self.product_id = product_id
+        self.device = None
+        
+
+    def print_device_info(self):
+         print("Manufacturer: %s" % self.device.get_manufacturer_string())
+         print("Product: %s" % self.device.get_product_string())
+         print("Serial No: %s" % self.device.get_serial_number_string())
+    
+    def print_connected_interfaces(self):
+        devices = hid.enumerate(self.vendor_id, self.product_id)
+        for d in devices:
+            print(f"Path: {d['path']}")
+            print(f"Interface Number: {d['interface_number']}")
+            print(f"Usage Page: {hex(d['usage_page'])} | Usage: {hex(d['usage'])}")
+            print("-" * 35)
+
+
+    def connect(self):
+        try:
+            devices = hid.enumerate(self.vendor_id, self.product_id)
+            target_path = None
+            for d in devices:
+                if d['interface_number'] == CONTROL_INTERFACE:
+                    target_path = d['path']
+                    break
+            if target_path:
+                self.device = hid.device()
+                self.device.open_path(target_path)
+                # Set non-blocking to 0 so reads wait for the hardware handshake
+                self.device.set_nonblocking(0)
+                print("Connected to Ajazz AK820 Pro Control Interface!")
+                return True
+            print("Interface 3 not found.")
+            return False
+        except Exception as e:
+            print(f"Connection failed: {e}")
+            return False
+
+    def _handshake(self):
+        try:
+            # Read 64 bytes from the feature report stream (with a 500ms timeout)
+            response = self.device.get_feature_report(0x00, 65)
+            return response
+        except Exception:
+            # If it times out or skips, clear the buffer safely
+            pass
+
+    def set_static_color(self, r, g, b, mode=LIGHTING_MODES['Static'], rainbow=False, brightness=MAX_BRIGHTNESS, speed=MAX_SPEED, direction=DEFAULT_DIRECTION):
+        if not self.device: 
+            print("Device offline.")
+            return
+
+        try:
+            # --- 1. RESET STATE PACKET ---
+            reset = [0x00] * 64
+            reset[0] = 0x04
+            reset[1] = 0x18
+            self.device.send_feature_report([0x00] + reset)
+            time.sleep(0.02) # Short pause for hardware processing
+
+            # --- 2. CONFIGURE LIGHTING PACKET ---
+            preamble = [0x00] * 64
+            preamble[0] = 0x04  
+            preamble[1] = 0x13  
+            preamble[8] = 0x01  
+            self.device.send_feature_report([0x00] + preamble)
+
+            # --- 3. FIRST HANDSHAKE ---
+            self._handshake()
+
+            # --- 4. LIGHTING DATA PACKET ---
+            data = [0x00] * 64
+            data[0] = mode
+            data[1] = r     
+            data[2] = g     
+            data[3] = b     
+            data[8] = rainbow     
+            data[9] = brightness     
+            data[10] = speed   
+            data[11] = direction    
+            data[14] = 0x55 # Magic validation footprint
+            data[15] = 0xAA # Magic validation footprint
+            self.device.send_feature_report([0x00] + data)
+            time.sleep(0.02)
+
+            # --- 5. SAVE PACKET ---
+            save = [0x00] * 64
+            save[0] = 0x04  
+            save[1] = 0x02  
+            self.device.send_feature_report([0x00] + save)
+
+            # --- 6. SECOND HANDSHAKE ---
+            self._handshake()
+            
+            print(f"SetLightingMode sequence executed successfully! RGB({r}, {g}, {b})")
+
+        except Exception as e:
+            print(f"Protocol execution failed: {e}")
+    
+    def close(self):
+        try:
+            self.device.close()
+        except Exception as e:
+            print(e)
+            print("Could not close device")

ajazz_rgb_cli-1.0.0/ajazz_cli/Device_Mapper.py

@@ -0,0 +1,6 @@
+device_mapper = {
+    "Microdia AK820": {
+        "VID": 0x0c45,
+        "PID": 0x8009
+    },
+}

ajazz_rgb_cli-1.0.0/ajazz_cli/main.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+import argparse
+import sys
+import time
+
+from .Device_Mapper import device_mapper
+from .Device import Device
+from .utils import hex_to_rgb
+
+def main():
+    parser = argparse.ArgumentParser(description="Control Ajazz AK820 Pro RGB lighting.",formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+
+    parser.add_argument(
+        '-c', '--color', 
+        type=hex_to_rgb, 
+        default=(0, 255, 255),
+        help="Hex color code to apply (e.g., FF0000 for Red, 00FFFF for Cyan)"
+    )
+    
+    parser.add_argument(
+        '-m', '--mode', 
+        type=int, 
+        default=1, 
+        choices=range(0, 20),
+        help="Lighting mode ID (0: Off, 1: Static, 2: Single On, 6: Colourful, 7: Breath, 8: Spectrum, 9: Outward, 10: Scrolling, 11: Rolling, 12: Rotating, 13: Explode, 14: Launch, 15: Ripples, 16: Flowing, 17: Pulsating, 18: Tilt, 19: Shuttle)"
+    )
+
+    parser.add_argument(
+        '-b', '--brightness', 
+        type=int, 
+        default=5, 
+        choices=range(0, 6),
+        help="LED Brightness level scale (0 to 5)"
+    )
+
+    parser.add_argument(
+        '-s', '--speed', 
+        type=int, 
+        default=3, 
+        choices=range(0, 6),
+        help="Animation effect speed (0 to 5)"
+    )
+
+    parser.add_argument(
+        '-d', '--direction', 
+        type=int, 
+        default=0, 
+        choices=range(0, 4),
+        help="Animation effect direction (0 to 3)"
+    )
+
+    parser.add_argument(
+        '-r', '--rainbow', 
+        action='store_true',
+        help="Enable rainbow effect"
+    )
+
+    parser.add_argument('--vid', type=lambda x: int(x, 16), default=device_mapper["Microdia AK820"]["VID"], help="Vendor ID in Hex")
+    parser.add_argument('--pid', type=lambda x: int(x, 16), default=device_mapper["Microdia AK820"]["PID"], help="Product ID in Hex")
+
+    args = parser.parse_args()
+
+    r, g, b = args.color
+
+    dev = Device(args.vid, args.pid)
+
+    if not dev.connect():
+        print("Error: Could not establish communication with the keyboard control endpoint.", file=sys.stderr)
+        sys.exit(1)
+
+    try:
+        dev.set_static_color(r, g, b, args.mode, args.rainbow, args.brightness, args.speed, args.direction)
+    except Exception as e:
+        print(f"Error: {e}", file=sys.stderr)
+        sys.exit(1)
+    finally:
+        dev.close()
+
+if __name__ == "__main__":
+    main()

ajazz_rgb_cli-1.0.0/ajazz_cli/utils.py

@@ -0,0 +1,11 @@
+import argparse
+
+def hex_to_rgb(hex_str):
+    hex_str = hex_str.lstrip('#').strip()
+    if len(hex_str) != 6:
+        raise argparse.ArgumentTypeError("Hex color must be exactly 6 hex characters (e.g., FF00FF).")
+    try:
+        val = int(hex_str, 16)
+        return (val >> 16) & 0xff, (val >> 8) & 0xff, val & 0xff
+    except ValueError:
+        raise argparse.ArgumentTypeError("Invalid hex characters.")

ajazz_rgb_cli-1.0.0/ajazz_rgb_cli.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: ajazz-rgb-cli
+Version: 1.0.0
+Summary: A terminal app to configure Ajazz AK820 Pro RGB on Linux
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: hidapi>=0.14.0

ajazz_rgb_cli-1.0.0/ajazz_rgb_cli.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+ajazz_cli/Device.py
+ajazz_cli/Device_Mapper.py
+ajazz_cli/__init__.py
+ajazz_cli/main.py
+ajazz_cli/utils.py
+ajazz_rgb_cli.egg-info/PKG-INFO
+ajazz_rgb_cli.egg-info/SOURCES.txt
+ajazz_rgb_cli.egg-info/dependency_links.txt
+ajazz_rgb_cli.egg-info/entry_points.txt
+ajazz_rgb_cli.egg-info/requires.txt
+ajazz_rgb_cli.egg-info/top_level.txt

ajazz_rgb_cli-1.0.0/ajazz_rgb_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ajazz_rgb_cli-1.0.0/ajazz_rgb_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ajazz_cli = ajazz_cli.main:main

ajazz_rgb_cli-1.0.0/ajazz_rgb_cli.egg-info/requires.txt

@@ -0,0 +1 @@
+hidapi>=0.14.0

ajazz_rgb_cli-1.0.0/ajazz_rgb_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+ajazz_cli

ajazz_rgb_cli-1.0.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ajazz-rgb-cli"
+version = "1.0.0"
+description = "A terminal app to configure Ajazz AK820 Pro RGB on Linux"
+readme = "README.md"
+requires-python = ">=3.7"
+dependencies = [
+    "hidapi>=0.14.0",
+]
+
+[project.scripts]
+ajazz_cli = "ajazz_cli.main:main"

ajazz_rgb_cli-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+