AnalogSensePy 1.0.5__tar.gz → 1.0.7__tar.gz

analogsensepy-1.0.7/AnalogSensePy.egg-info/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: AnalogSensePy
+Version: 1.0.7
+License: MIT
+Project-URL: Homepage, https://github.com/girlglock/AnalogSense-Python-SDK
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hid; sys_platform == "linux"
+Requires-Dist: hidapi; sys_platform != "linux"
+Dynamic: license-file
+
+# AnalogSense Python SDK
+Python port of [AnalogSense.js](https://github.com/AnalogSense/JavaScript-SDK/) for analog keyboard input.
+## Supported Keyboards/Devices
+- Everything by Wooting<sup>T</sup>
+- Everything by NuPhy
+- Everything by DrunkDeer
+- Razer Huntsman V2 Analog<sup>R</sup>
+- Razer Huntsman Mini Analog<sup>R</sup>
+- Razer Huntsman V3 Pro<sup>R</sup>
+- Razer Huntsman V3 Pro Mini<sup>R</sup>
+- Razer Huntsman V3 Pro Tenkeyless<sup>R</sup>
+- Keychron Q1 HE<sup>P, F</sup>
+- Keychron Q3 HE<sup>P, F</sup>
+- Keychron Q5 HE<sup>P, F</sup>
+- Keychron K2 HE<sup>P, F</sup>
+- Lemokey P1 HE<sup>P, F</sup>
+- Madlions MAD60HE<sup>P</sup>
+- Madlions MAD68HE<sup>P</sup>
+- Madlions MAD68R<sup>P</sup>
+- Redragon K709HE<sup>P, T</sup>
+
+<sup>T</sup> Tested and should work. Feel free to open issues/prs about boards not being picked up properly  
+<sup>R</sup> Razer Synapse needs to be installed and running for analogue inputs to be received from this keyboard.  
+<sup>P</sup> The official firmware only supports polling, which can lead to lag and missed inputs.  
+<sup>F</sup> [Custom firmware with full analog report functionality is available](https://analogsense.org/firmware/).
+
+## Installation
+```bash
+pip install AnalogSensePy
+```
+
+On Linux you may need udev rules or `sudo` for hid
+```bash
+printf '%s\n' \
+  'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="31e3", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="03eb", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="1532", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="19f5", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="352d", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="3434", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="362d", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="373b", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="372e", MODE="0660", GROUP="input"' \
+  | sudo tee /etc/udev/rules.d/99-analogsense.rules
+
+sudo udevadm control --reload-rules && sudo udevadm trigger
+```
+## Usage
+```python
+from analogsense import AnalogSense
+
+as_ = AnalogSense()
+devices = as_.get_devices()
+
+if not devices:
+    print("no supported analog keyboards found.")
+    exit()
+
+if len(devices) == 1:
+    dev = devices[0]
+else:
+    for i, d in enumerate(devices):
+        print(f"  [{i}] {d.product_name}")
+    dev = devices[int(input("select device index: "))]
+
+def on_keys(active_keys):
+    for k in active_keys:
+        # converting the scancode to a nice readable string
+        name = as_.scancode_to_string(k["scancode"])
+        
+        # some providers can return the digital state of the key
+        # (what the system perceives the key as pressed or not)
+        # other providers that do not support this will return None
+        if k["digital"] is not None:
+            digital = " [down]" if k["digital"] else " [up]"
+        else:
+            digital = ""
+
+        print(f"{name:20s} {k['value']:.4f}{digital}")
+
+dev.start_listening(on_keys)
+input("press keys... enter to stop.\n")
+dev.stop_listening()
+```
+
+The following functions are available on `AnalogSense`:
+- `get_devices() -> list[Device]`
+- `open_device(vendor_id, product_id) -> Device | None`
+- `scancode_to_string(scancode: int) -> str`
+
+A device instance has the following members:
+- `start_listening(handler: Callable[[list[{"scancode": int, "value": float}]], None])`
+- `stop_listening()`
+- `product_name: str`
+- `forget()`
+- `dev: DeviceHandle`
+
+### Scancodes
+The scancodes provided by this library are primarily HID scancodes; most keys are mapped as seen on usage page 0x07 (A = 0x04, B = 0x05, ...).
+
+Control keys (usage page 0x0C) are mapped in the `0x3__` range, modulo 0x100:
+- `0x3B5` = Next Track
+- `0x3B6` = Previous Track
+- `0x3B7` = Stop Media
+- `0x3CD` = Play/Pause
+- `0x394` = Open File Explorer
+- `0x323` = Open Browser Home Page
+
+OEM-specific keys are mapped in the `0x4__` range:
+- `0x401` = Brightness Up
+- `0x402` = Brightness Down
+- `0x403` = Profile 1
+- `0x404` = Profile 2
+- `0x405` = Profile 3
+- `0x408` = Profile Switch
+- `0x409` = Function Key (Fn)

analogsensepy-1.0.7/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: AnalogSensePy
+Version: 1.0.7
+License: MIT
+Project-URL: Homepage, https://github.com/girlglock/AnalogSense-Python-SDK
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hid; sys_platform == "linux"
+Requires-Dist: hidapi; sys_platform != "linux"
+Dynamic: license-file
+
+# AnalogSense Python SDK
+Python port of [AnalogSense.js](https://github.com/AnalogSense/JavaScript-SDK/) for analog keyboard input.
+## Supported Keyboards/Devices
+- Everything by Wooting<sup>T</sup>
+- Everything by NuPhy
+- Everything by DrunkDeer
+- Razer Huntsman V2 Analog<sup>R</sup>
+- Razer Huntsman Mini Analog<sup>R</sup>
+- Razer Huntsman V3 Pro<sup>R</sup>
+- Razer Huntsman V3 Pro Mini<sup>R</sup>
+- Razer Huntsman V3 Pro Tenkeyless<sup>R</sup>
+- Keychron Q1 HE<sup>P, F</sup>
+- Keychron Q3 HE<sup>P, F</sup>
+- Keychron Q5 HE<sup>P, F</sup>
+- Keychron K2 HE<sup>P, F</sup>
+- Lemokey P1 HE<sup>P, F</sup>
+- Madlions MAD60HE<sup>P</sup>
+- Madlions MAD68HE<sup>P</sup>
+- Madlions MAD68R<sup>P</sup>
+- Redragon K709HE<sup>P, T</sup>
+
+<sup>T</sup> Tested and should work. Feel free to open issues/prs about boards not being picked up properly  
+<sup>R</sup> Razer Synapse needs to be installed and running for analogue inputs to be received from this keyboard.  
+<sup>P</sup> The official firmware only supports polling, which can lead to lag and missed inputs.  
+<sup>F</sup> [Custom firmware with full analog report functionality is available](https://analogsense.org/firmware/).
+
+## Installation
+```bash
+pip install AnalogSensePy
+```
+
+On Linux you may need udev rules or `sudo` for hid
+```bash
+printf '%s\n' \
+  'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="31e3", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="03eb", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="1532", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="19f5", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="352d", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="3434", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="362d", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="373b", MODE="0660", GROUP="input"' \
+  'SUBSYSTEM=="usb", ATTRS{idVendor}=="372e", MODE="0660", GROUP="input"' \
+  | sudo tee /etc/udev/rules.d/99-analogsense.rules
+
+sudo udevadm control --reload-rules && sudo udevadm trigger
+```
+## Usage
+```python
+from analogsense import AnalogSense
+
+as_ = AnalogSense()
+devices = as_.get_devices()
+
+if not devices:
+    print("no supported analog keyboards found.")
+    exit()
+
+if len(devices) == 1:
+    dev = devices[0]
+else:
+    for i, d in enumerate(devices):
+        print(f"  [{i}] {d.product_name}")
+    dev = devices[int(input("select device index: "))]
+
+def on_keys(active_keys):
+    for k in active_keys:
+        # converting the scancode to a nice readable string
+        name = as_.scancode_to_string(k["scancode"])
+        
+        # some providers can return the digital state of the key
+        # (what the system perceives the key as pressed or not)
+        # other providers that do not support this will return None
+        if k["digital"] is not None:
+            digital = " [down]" if k["digital"] else " [up]"
+        else:
+            digital = ""
+
+        print(f"{name:20s} {k['value']:.4f}{digital}")
+
+dev.start_listening(on_keys)
+input("press keys... enter to stop.\n")
+dev.stop_listening()
+```
+
+The following functions are available on `AnalogSense`:
+- `get_devices() -> list[Device]`
+- `open_device(vendor_id, product_id) -> Device | None`
+- `scancode_to_string(scancode: int) -> str`
+
+A device instance has the following members:
+- `start_listening(handler: Callable[[list[{"scancode": int, "value": float}]], None])`
+- `stop_listening()`
+- `product_name: str`
+- `forget()`
+- `dev: DeviceHandle`
+
+### Scancodes
+The scancodes provided by this library are primarily HID scancodes; most keys are mapped as seen on usage page 0x07 (A = 0x04, B = 0x05, ...).
+
+Control keys (usage page 0x0C) are mapped in the `0x3__` range, modulo 0x100:
+- `0x3B5` = Next Track
+- `0x3B6` = Previous Track
+- `0x3B7` = Stop Media
+- `0x3CD` = Play/Pause
+- `0x394` = Open File Explorer
+- `0x323` = Open Browser Home Page
+
+OEM-specific keys are mapped in the `0x4__` range:
+- `0x401` = Brightness Up
+- `0x402` = Brightness Down
+- `0x403` = Profile 1
+- `0x404` = Profile 2
+- `0x405` = Profile 3
+- `0x408` = Profile Switch
+- `0x409` = Function Key (Fn)

{analogsensepy-1.0.5 → analogsensepy-1.0.7}/README.md

@@ -1,7 +1,7 @@
 # AnalogSense Python SDK
 Python port of [AnalogSense.js](https://github.com/AnalogSense/JavaScript-SDK/) for analog keyboard input.
 ## Supported Keyboards/Devices
-- Everything by Wooting
+- Everything by Wooting<sup>T</sup>
 - Everything by NuPhy
 - Everything by DrunkDeer
 - Razer Huntsman V2 Analog<sup>R</sup>
@@ -17,8 +17,9 @@ Python port of [AnalogSense.js](https://github.com/AnalogSense/JavaScript-SDK/)
 - Madlions MAD60HE<sup>P</sup>
 - Madlions MAD68HE<sup>P</sup>
 - Madlions MAD68R<sup>P</sup>
-- Redragon K709HE<sup>P</sup>
+- Redragon K709HE<sup>P, T</sup>
 
+<sup>T</sup> Tested and should work. Feel free to open issues/prs about boards not being picked up properly  
 <sup>R</sup> Razer Synapse needs to be installed and running for analogue inputs to be received from this keyboard.  
 <sup>P</sup> The official firmware only supports polling, which can lead to lag and missed inputs.  
 <sup>F</sup> [Custom firmware with full analog report functionality is available](https://analogsense.org/firmware/).

{analogsensepy-1.0.5 → analogsensepy-1.0.7}/analogsense/analogsense.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 import sys
+import threading
 import warnings
 
 from .providers import ALL_PROVIDERS, AsProvider
@@ -51,10 +52,26 @@ class AnalogSense:
                 try:
                     vendor_id  = f.get("vendor_id", 0)
                     product_id = f.get("product_id", 0)
-                    for info in _hid.enumerate(vendor_id, product_id):
+                    result = []
+                    exc = []
+                    def _enumerate(v=vendor_id, p=product_id):
+                        try:
+                            result.extend(_hid.enumerate(v, p))
+                        except Exception as e:
+                            exc.append(e)
+                    t = threading.Thread(target=_enumerate, daemon=True)
+                    t.start()
+                    t.join(timeout=3.0)
+                    if exc:
+                        raise exc[0]
+                    if t.is_alive():
+                        warnings.warn(f"HID enumeration timed out for {vendor_id:#06x}:{product_id:#06x}, device may be in a bad state, try reconnecting")
+                        continue
+                    for info in result:
                         dedup_key = (info["vendor_id"], info["product_id"], info.get("usage_page", 0), info.get("usage", 0))
                         if dedup_key in seen: continue
                         if "usage_page" in f and info.get("usage_page") != f["usage_page"]: continue
+                        if "usage" in f and info.get("usage") != f["usage"]: continue
                         seen.add(dedup_key)
                         candidates.append((info, provider_cls))
                 except Exception as e:

{analogsensepy-1.0.5 → analogsensepy-1.0.7}/analogsense/providers.py

@@ -133,10 +133,12 @@ class AsProviderWootingV2(AsProvider):
 
 class AsProviderRazerHuntsman(AsProvider):
     FILTERS = [
-        {"vendor_id": 0x1532, "product_id": 0x0266},
-        {"vendor_id": 0x1532, "product_id": 0x0282},
+        {"vendor_id": 0x1532, "product_id": 0x0266, "usage_page": 0x0001},  #Razer Huntsman V2
+        {"vendor_id": 0x1532, "product_id": 0x0282, "usage_page": 0x0001},  #Razer Huntsman Mini
     ]
 
+    _REPORT_ID = 7
+
     def start_listening(self, handler: Handler):
         self._running = True
         self._prev_scancodes: set[int] = set()
@@ -144,7 +146,10 @@ class AsProviderRazerHuntsman(AsProvider):
         self._thread.start()
 
     def _handle_report(self, data: bytes, handler: Handler):
-        if data[0] != 7: return
+        if data[0] == self._REPORT_ID:
+            data = data[1:]
+        elif len(data) > 1 and data[0] != 0:
+            return
         active_keys = []
         current_scancodes = set()
         i = 1
@@ -164,10 +169,11 @@ class AsProviderRazerHuntsman(AsProvider):
 
 class AsProviderRazerHuntsmanV3(AsProvider):
     FILTERS = [
-        {"vendor_id": 0x1532, "product_id": 0x02A6},
-        {"vendor_id": 0x1532, "product_id": 0x02A7},
-        {"vendor_id": 0x1532, "product_id": 0x02B0},
+        {"vendor_id": 0x1532, "product_id": 0x02A6, "usage_page": 0x0001},  #Razer Huntsman V3 Pro
+        {"vendor_id": 0x1532, "product_id": 0x02A7, "usage_page": 0x0001},  #Razer Huntsman V3 Pro Tenkeyless
+        {"vendor_id": 0x1532, "product_id": 0x02B0, "usage_page": 0x0001},  #Razer Huntsman V3 Pro Mini
     ]
+    _REPORT_ID = 11
 
     def start_listening(self, handler: Handler):
         self._running = True
@@ -176,7 +182,10 @@ class AsProviderRazerHuntsmanV3(AsProvider):
         self._thread.start()
 
     def _handle_report(self, data: bytes, handler: Handler):
-        if data[0] != 11: return
+        if data[0] == self._REPORT_ID:
+            data = data[1:]
+        elif len(data) > 1 and data[0] != 0:
+            return
         active_keys = []
         current_scancodes = set()
         i = 1
@@ -194,10 +203,10 @@ class AsProviderRazerHuntsmanV3(AsProvider):
         self._prev_scancodes = current_scancodes
         handler(active_keys)
 
-
+#this one needs testing
 class AsProviderNuphy(AsProvider):
     FILTERS = [
-        {"vendor_id": 0x19F5},
+        {"vendor_id": 0x19F5, "usage_page": 0x0001, "usage": 0x0000},
     ]
 
     def start_listening(self, handler: Handler):
@@ -264,15 +273,15 @@ class AsProviderDrunkdeer(AsProvider):
 
 class AsProviderKeychron(AsProvider):
     FILTERS = [
-        {"vendor_id": 0x3434, "product_id": 0x0B10},
-        {"vendor_id": 0x3434, "product_id": 0x0B11},
-        {"vendor_id": 0x3434, "product_id": 0x0B12},
-        {"vendor_id": 0x3434, "product_id": 0x0B30},
-        {"vendor_id": 0x3434, "product_id": 0x0B50},
-        {"vendor_id": 0x3434, "product_id": 0x0E20},
-        {"vendor_id": 0x3434, "product_id": 0x0E21},
-        {"vendor_id": 0x3434, "product_id": 0x0E22},
-        {"vendor_id": 0x362D, "product_id": 0x0610},
+        {"vendor_id": 0x3434, "product_id": 0x0B10, "usage_page": 0xFF60, "usage": 0x61},  #Q1 HE ANSI
+        {"vendor_id": 0x3434, "product_id": 0x0B11, "usage_page": 0xFF60, "usage": 0x61},  #Q1 HE ISO
+        {"vendor_id": 0x3434, "product_id": 0x0B12, "usage_page": 0xFF60, "usage": 0x61},  #Q1 HE JIS
+        {"vendor_id": 0x3434, "product_id": 0x0B30, "usage_page": 0xFF60, "usage": 0x61},  #Q3 HE ANSI
+        {"vendor_id": 0x3434, "product_id": 0x0B50, "usage_page": 0xFF60, "usage": 0x61},  #Q5 HE ANSI
+        {"vendor_id": 0x3434, "product_id": 0x0E20, "usage_page": 0xFF60, "usage": 0x61},  #K2 HE ANSI
+        {"vendor_id": 0x3434, "product_id": 0x0E21, "usage_page": 0xFF60, "usage": 0x61},  #K2 HE ISO
+        {"vendor_id": 0x3434, "product_id": 0x0E22, "usage_page": 0xFF60, "usage": 0x61},  #K2 HE JIS
+        {"vendor_id": 0x362D, "product_id": 0x0610, "usage_page": 0xFF60, "usage": 0x61},  #Lemokey P1 HE ANSI
     ]
 
     _INIT_PAYLOAD = bytes([
@@ -373,15 +382,19 @@ class AsProviderKeychron(AsProvider):
 
 class AsProviderMadlions(AsProvider):
     FILTERS = [
-        {"vendor_id": 0x373B, "product_id": 0x1053},
-        {"vendor_id": 0x373B, "product_id": 0x1055},
-        {"vendor_id": 0x373B, "product_id": 0x1056},
-        {"vendor_id": 0x373B, "product_id": 0x105D},
-        {"vendor_id": 0x373B, "product_id": 0x1058},
-        {"vendor_id": 0x373B, "product_id": 0x1059},
-        {"vendor_id": 0x373B, "product_id": 0x105A},
-        {"vendor_id": 0x373B, "product_id": 0x105C},
-        {"vendor_id": 0x373B, "product_id": 0x10A7},
+        #MAD60HE
+        {"vendor_id": 0x373B, "product_id": 0x1053, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x1054, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x1055, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x1056, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x105D, "usage_page": 0xFF60, "usage": 0x61},
+        #MAD68HE
+        {"vendor_id": 0x373B, "product_id": 0x1058, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x1059, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x105A, "usage_page": 0xFF60, "usage": 0x61},
+        {"vendor_id": 0x373B, "product_id": 0x105C, "usage_page": 0xFF60, "usage": 0x61},
+        #MAD68R
+        {"vendor_id": 0x373B, "product_id": 0x10A7, "usage_page": 0xFF60, "usage": 0x61},
     ]
 
     _INIT_PAYLOAD = bytes([
@@ -391,7 +404,7 @@ class AsProviderMadlions(AsProvider):
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     ])
 
-    _MAD60HE_PIDS = {0x1053, 0x1055, 0x1056, 0x105D}
+    _MAD60HE_PIDS = {0x1053, 0x1054, 0x1055, 0x1056, 0x105D}
 
     def start_listening(self, handler: Handler):
         pid = self.dev.product_id
@@ -426,7 +439,7 @@ class AsProviderMadlions(AsProvider):
 
 class AsProviderBytech(AsProvider):
     FILTERS = [
-        {"vendor_id": 0x372E, "product_id": 0x105B},
+        {"vendor_id": 0x372E, "product_id": 0x105B, "usage_page": 0xFF00},  #Redragon K709 HE
     ]
 
     def _build_payload(self, cmd, sub):

{analogsensepy-1.0.5 → analogsensepy-1.0.7}/pyproject.toml

@@ -4,9 +4,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "AnalogSensePy"
-version = "1.0.5"
+version = "1.0.7"
+readme = "README.md"
+license = { text = "MIT" }
 requires-python = ">=3.10"
 dependencies = [
     "hid; sys_platform == 'linux'",
     "hidapi; sys_platform != 'linux'",
-]
+]
+
+[project.urls]
+Homepage = "https://github.com/girlglock/AnalogSense-Python-SDK"

analogsensepy-1.0.5/AnalogSensePy.egg-info/PKG-INFO

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: AnalogSensePy
-Version: 1.0.5
-Requires-Python: >=3.10
-License-File: LICENSE
-Requires-Dist: hid; sys_platform == "linux"
-Requires-Dist: hidapi; sys_platform != "linux"
-Dynamic: license-file

analogsensepy-1.0.5/PKG-INFO

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: AnalogSensePy
-Version: 1.0.5
-Requires-Python: >=3.10
-License-File: LICENSE
-Requires-Dist: hid; sys_platform == "linux"
-Requires-Dist: hidapi; sys_platform != "linux"
-Dynamic: license-file