Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement: HID watchdog #1061

Merged
merged 6 commits into from
Dec 22, 2024
Merged

Enhancement: HID watchdog #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
85c455f
hid watchdog
regicidalplutophage Dec 18, 2024
3328cb6
Update devcontainer.json
regicidalplutophage Dec 18, 2024
e131455
better naming and neater debug
regicidalplutophage Dec 18, 2024
3a63848
generalize methods and allow ble re-pairing
regicidalplutophage Dec 19, 2024
911cd4a
separate scheduler tasks for usb and ble
regicidalplutophage Dec 22, 2024
bbd7816
remove artifacts
regicidalplutophage Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"name": "Python 3",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bookworm",
"features": {
"ghcr.io/devcontainers/features/python:1": {}
},
Expand Down
181 changes: 107 additions & 74 deletions kmk/hid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from storage import getmount

from kmk.keys import ConsumerKey, KeyboardKey, ModifierKey, MouseKey
from kmk.scheduler import cancel_task, create_task
from kmk.utils import Debug, clamp

try:
Expand Down Expand Up @@ -55,26 +56,64 @@ class HIDUsagePage:


class AbstractHID:
REPORT_BYTES = 8
report_bytes_default = 8
report_bytes_nkro = 17
REPORT_BYTES = report_bytes_default
hid_devices = {}
hid_ready = False

def __init__(self, **kwargs):
self._nkro = False
self._mouse = True
self._pan = False
self.find_devices()
self.setup_keyboard_hid()
self.setup_consumer_control()
self.setup_mouse_hid()

def show_debug(self):
if self._nkro:
debug('use NKRO')
else:
debug('use 6KRO')
if self._mouse and self._pan:
debug('enable horizontal scrolling mouse')
elif self._mouse:
debug('enable mouse')
else:
debug('disable mouse')

def find_devices(self):
self.devices = {}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This belongs in __init__()

Copy link
Member Author

@regicidalplutophage regicidalplutophage Dec 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First we blank out the dict, then we repopulate it. Blanking out might happen more than once.


for device in self.hid_devices:
if not hasattr(device, 'send_report'):
continue
us = device.usage
up = device.usage_page

if up == HIDUsagePage.CONSUMER and us == HIDUsage.CONSUMER:
self.devices[HIDReportTypes.CONSUMER] = device
elif up == HIDUsagePage.KEYBOARD and us == HIDUsage.KEYBOARD:
self.devices[HIDReportTypes.KEYBOARD] = device
elif up == HIDUsagePage.MOUSE and us == HIDUsage.MOUSE:
self.devices[HIDReportTypes.MOUSE] = device
elif up == HIDUsagePage.SYSCONTROL and us == HIDUsage.SYSCONTROL:
self.devices[HIDReportTypes.SYSCONTROL] = device

def setup_keyboard_hid(self):
self.REPORT_BYTES = self.report_bytes_default
self._evt = bytearray(self.REPORT_BYTES)
self._evt[0] = HIDReportTypes.KEYBOARD
self._nkro = False

# bodgy NKRO autodetect
try:
self.hid_send(self._evt)
if debug.enabled:
debug('use 6KRO')
except ValueError:
self.REPORT_BYTES = 17
self.REPORT_BYTES = self.report_bytes_nkro
self._evt = bytearray(self.REPORT_BYTES)
self._evt[0] = HIDReportTypes.KEYBOARD
self._nkro = True
if debug.enabled:
debug('use NKRO')

self._prev_evt = bytearray(self.REPORT_BYTES)

Expand All @@ -87,27 +126,25 @@ def __init__(self, **kwargs):
self.report_mods = memoryview(self._evt)[1:2]
self.report_non_mods = memoryview(self._evt)[3:]

def setup_consumer_control(self):
self._cc_report = bytearray(HID_REPORT_SIZES[HIDReportTypes.CONSUMER] + 1)
self._cc_report[0] = HIDReportTypes.CONSUMER
self._cc_pending = False

def setup_mouse_hid(self):
self._pd_report = bytearray(HID_REPORT_SIZES[HIDReportTypes.MOUSE] + 1)
self._pd_report[0] = HIDReportTypes.MOUSE
self._pd_pending = False

# bodgy pointing device panning autodetect
try:
self.hid_send(self._pd_report)
if debug.enabled:
debug('use no pan')
except ValueError:
self._pd_report = bytearray(6)
self._pd_report[0] = HIDReportTypes.MOUSE
if debug.enabled:
debug('use pan')
self._pan = True
except KeyError:
if debug.enabled:
debug('mouse disabled')
self._mouse = False

def __repr__(self):
return f'{self.__class__.__name__}(REPORT_BYTES={self.REPORT_BYTES})'
Expand Down Expand Up @@ -254,29 +291,39 @@ def has_key(self, key):


class USBHID(AbstractHID):
REPORT_BYTES = 9
report_bytes_default = 9
REPORT_BYTES = report_bytes_default

def __init__(self, **kwargs):

self.devices = {}

for device in usb_hid.devices:
us = device.usage
up = device.usage_page

if up == HIDUsagePage.CONSUMER and us == HIDUsage.CONSUMER:
self.devices[HIDReportTypes.CONSUMER] = device
elif up == HIDUsagePage.KEYBOARD and us == HIDUsage.KEYBOARD:
self.devices[HIDReportTypes.KEYBOARD] = device
elif up == HIDUsagePage.MOUSE and us == HIDUsage.MOUSE:
self.devices[HIDReportTypes.MOUSE] = device
elif up == HIDUsagePage.SYSCONTROL and us == HIDUsage.SYSCONTROL:
self.devices[HIDReportTypes.SYSCONTROL] = device

self.hid = usb_hid
self.hid_devices = self.hid.devices
super().__init__(**kwargs)
self._setup_task = self.wait_until_connected()

def test_reports(self):
if self._connected():
try:
self.hid_ready = True
self.setup_keyboard_hid()
self.setup_consumer_control()
self.setup_mouse_hid()
cancel_task(self._setup_task)
self._setup_task = None
if debug.enabled:
self.show_debug()
self.hid_ready = True
except OSError as e:
if debug.enabled:
debug(type(e), ':', e)

def wait_until_connected(self, period_ms=200):
return create_task(self.test_reports, period_ms=period_ms)

def _connected(self):
return supervisor.runtime.usb_connected

def hid_send(self, evt):
if not supervisor.runtime.usb_connected:
if not self.hid_ready or not self._connected():
return

# int, can be looked up in HIDReportTypes
Expand All @@ -289,59 +336,45 @@ class BLEHID(AbstractHID):
BLE_APPEARANCE_HID_KEYBOARD = const(961)
# Hardcoded in CPy
MAX_CONNECTIONS = const(2)
ble_connected = False

def __init__(self, ble_name=str(getmount('/').label), **kwargs):

self.ble_name = ble_name
self.ble = BLERadio()
self.ble.name = self.ble_name
self.hid = HIDService()
self.hid_devices = self.hid.devices
self.hid.protocol_mode = 0 # Boot protocol
super().__init__(**kwargs)

# Security-wise this is not right. While you're away someone turns
# on your keyboard and they can pair with it nice and clean and then
# listen to keystrokes.
# On the other hand we don't have LESC so it's like shouting your
# keystrokes in the air
if not self.ble.connected or not self.hid.devices:
self.start_advertising()

@property
def devices(self):
'''Search through the provided list of devices to find the ones with the
send_report attribute.'''
if not self.ble.connected:
return {}

result = {}

for device in self.hid.devices:
if not hasattr(device, 'send_report'):
continue
us = device.usage
up = device.usage_page

if up == HIDUsagePage.CONSUMER and us == HIDUsage.CONSUMER:
result[HIDReportTypes.CONSUMER] = device
continue

if up == HIDUsagePage.KEYBOARD and us == HIDUsage.KEYBOARD:
result[HIDReportTypes.KEYBOARD] = device
continue

if up == HIDUsagePage.MOUSE and us == HIDUsage.MOUSE:
result[HIDReportTypes.MOUSE] = device
continue

if up == HIDUsagePage.SYSCONTROL and us == HIDUsage.SYSCONTROL:
result[HIDReportTypes.SYSCONTROL] = device
continue

return result
self.start_ble_monitor()

def _connected(self):
return self.ble.connected

def ble_monitor(self):
if self.ble_connected != self._connected():
self.ble_connected = self._connected()
if self._connected():
self.find_devices()
self.hid_ready = True
if debug.enabled:
debug('BLE connected')
else:
self.hid_ready = False
# Security-wise this is not right. While you're away someone turns
# on your keyboard and they can pair with it nice and clean and then
# listen to keystrokes.
# On the other hand we don't have LESC so it's like shouting your
# keystrokes in the air
self.start_advertising()
if debug.enabled:
debug('BLE disconnected')

def start_ble_monitor(self, period_ms=200):
return create_task(self.setup, period_ms=period_ms)

def hid_send(self, evt):
if not self.ble.connected:
if not self.hid_ready or not self._connected():
return

# int, can be looked up in HIDReportTypes
Expand Down
Loading