Require devices to be passed in so that they can be from USB or BLE.

Author: tannewt

adafruit_hid/__init__.py

@@ -39,3 +39,15 @@
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HID.git"
+
+def find_device(devices, *, usage_page, usage):
+    """Search through the provided list of devices to find the one with the matching usage_page and
+       usage."""
+    if hasattr(devices, "send_report"):
+        devices = [devices]
+    for device in devices:
+        if (device.usage_page == usage_page and
+                device.usage == usage and
+                hasattr(device, "send_report")):
+            return device
+    raise ValueError("Could not find matching HID device.")

adafruit_hid/consumer_control.py

@@ -35,27 +35,20 @@
 # pylint: disable=wrong-import-position
 import struct
 import time
+from . import find_device
 
 class ConsumerControl:
     """Send ConsumerControl code reports, used by multimedia keyboards, remote controls, etc.
     """
 
-    def __init__(self, consumer_device=None):
+    def __init__(self, devices):
         """Create a ConsumerControl object that will send Consumer Control Device HID reports.
-        If consumer_device is None (the default), find a usb_hid device to use.
-        But an equivalent device can be supplied instead for other kinds of consumer devices,
-        such as BLE.
-        It only needs to implement ``send_report()``.
+
+        Devices can be a list of devices that includes a Consumer Control device or a CC device
+        itself. A device is any object that implements ``send_report()``, ``usage_page`` and
+        ``usage``.
         """
-        self._consumer_device = consumer_device
-        if not self._consumer_device:
-            import usb_hid
-            for device in usb_hid.devices:
-                if device.usage_page == 0x0C and device.usage == 0x01:
-                    self._consumer_device = device
-                    break
-            if not self._consumer_device:
-                raise IOError("Could not find an HID Consumer device.")
+        self._consumer_device = find_device(devices, usage_page=0x0C, usage=0x01)
 
         # Reuse this bytearray to send consumer reports.
         self._report = bytearray(2)

adafruit_hid/gamepad.py

@@ -31,6 +31,8 @@
 import struct
 import time
 
+from . import find_device
+
 class Gamepad:
     """Emulate a generic gamepad controller with 16 buttons,
     numbered 1-16, and two joysticks, one controlling
@@ -42,22 +44,14 @@ class Gamepad:
     The joystick values are in the range -127 to 127.
 """
 
-    def __init__(self, gamepad_device=None):
+    def __init__(self, devices):
         """Create a Gamepad object that will send USB gamepad HID reports.
-        If gamepad_device is None (the default), find a usb_hid device to use.
-        But an equivalent device can be supplied instead for other kinds of gamepads,
-        such as BLE.
-        It only needs to implement ``send_report()``.
+
+        Devices can be a list of devices that includes a gamepad device or a gamepad device
+        itself. A device is any object that implements ``send_report()``, ``usage_page`` and
+        ``usage``.
         """
-        self._gamepad_device = gamepad_device
-        if self._gamepad_device is None:
-            import usb_hid
-            for device in usb_hid.devices:
-                if device.usage_page == 0x1 and device.usage == 0x05:
-                    self._gamepad_device = device
-                    break
-            if not self._gamepad_device:
-                raise IOError("Could not find an HID gamepad device.")
+        self._gamepad_device = find_device(devices, usage_page=0x1, usage=0x05)
 
         # Reuse this bytearray to send mouse reports.
         # Typically controllers start numbering buttons at 1 rather than 0.

adafruit_hid/keyboard.py

@@ -33,29 +33,23 @@
 
 from .keycode import Keycode
 
+from . import find_device
+
 _MAX_KEYPRESSES = const(6)
 
 class Keyboard:
     """Send HID keyboard reports."""
 
     # No more than _MAX_KEYPRESSES regular keys may be pressed at once.
 
-    def __init__(self, keyboard_device=None):
+    def __init__(self, devices):
         """Create a Keyboard object that will send keyboard HID reports.
-        If keyboard_device is None (the default), find a usb_hid device to use.
-        But an equivalent device can be supplied instead for other kinds of keyboards,
-        such as BLE.
-        It only needs to implement `send_report()`.
+
+        Devices can be a list of devices that includes a keyboard device or a keyboard device
+        itself. A device is any object that implements ``send_report()``, ``usage_page`` and
+        ``usage``.
         """
-        self._keyboard_device = keyboard_device
-        if not self._keyboard_device:
-            import usb_hid
-            for device in usb_hid.devices:
-                if device.usage_page == 0x1 and device.usage == 0x06:
-                    self._keyboard_device = device
-                    break
-            if not self._keyboard_device:
-                raise IOError("Could not find an HID keyboard device.")
+        self._keyboard_device = find_device(devices, usage_page=0x1, usage=0x06)
 
         # Reuse this bytearray to send keyboard reports.
         self.report = bytearray(8)

adafruit_hid/mouse.py

@@ -29,6 +29,8 @@
 """
 import time
 
+from . import find_device
+
 class Mouse:
     """Send USB HID mouse reports."""
 
@@ -39,22 +41,14 @@ class Mouse:
     MIDDLE_BUTTON = 4
     """Middle mouse button."""
 
-    def __init__(self, mouse_device=None):
+    def __init__(self, devices):
         """Create a Mouse object that will send USB mouse HID reports.
-        If mouse_device is None (the default), find a usb_hid device to use.
-        But an equivalent device can be supplied instead for other kinds of nice,
-        such as BLE.
-        It only needs to implement ``send_report()``.
+
+        Devices can be a list of devices that includes a keyboard device or a keyboard device
+        itself. A device is any object that implements ``send_report()``, ``usage_page`` and
+        ``usage``.
         """
-        self._mouse_device = mouse_device
-        if not self._mouse_device:
-            import usb_hid
-            for device in usb_hid.devices:
-                if device.usage_page == 0x1 and device.usage == 0x02:
-                    self._mouse_device = device
-                    break
-            if not self._mouse_device:
-                raise IOError("Could not find an HID mouse device.")
+        self._mouse_device = find_device(devices, usage_page=0x1, usage=0x02)
 
         # Reuse this bytearray to send mouse reports.
         # report[0] buttons pressed (LEFT, MIDDLE, RIGHT)

examples/hid_joywing_gamepad.py

@@ -7,6 +7,7 @@
 from micropython import const
 import adafruit_seesaw
 from adafruit_hid.gamepad import Gamepad
+import usb_hid
 
 def range_map(value, in_min, in_max, out_min, out_max):
     return (value - in_min) * (out_max - out_min) // (in_max - in_min) + out_min
@@ -31,7 +32,7 @@ def range_map(value, in_min, in_max, out_min, out_max):
 last_game_x = 0
 last_game_y = 0
 
-g = Gamepad()
+g = Gamepad(usb_hid.devices)
 
 while True:
     x = ss.analog_read(2)

examples/hid_keyboard_shortcuts.py

@@ -3,8 +3,9 @@
 import digitalio
 from adafruit_hid.keyboard import Keyboard
 from adafruit_hid.keycode import Keycode
+import usb_hid
 
-kbd = Keyboard()
+kbd = Keyboard(usb_hid.devices)
 
 # define buttons. these can be any physical switches/buttons, but the values
 # here work out-of-the-box with a CircuitPlayground Express' A and B buttons.

examples/hid_simple_gamepad.py

@@ -1,10 +1,11 @@
 import board
 import digitalio
 import analogio
+import usb_hid
 
 from adafruit_hid.gamepad import Gamepad
 
-gp = Gamepad()
+gp = Gamepad(usb_hid.devices)
 
 # Create some buttons. The physical buttons are connected
 # to ground on one side and these and these pins on the other.

examples/hid_simpletest.py

@@ -1,9 +1,10 @@
 import time
 import board
 import digitalio
+import usb_hid
 from adafruit_hid.mouse import Mouse
 
-mouse = Mouse()
+mouse = Mouse(usb_hid.devices)
 
 # define buttons. these can be any physical switches/buttons, but the values
 # here work out-of-the-box with a CircuitPlayground Express' A and B buttons.