Skip to content

USB HID Mouse

Overview

The USB HID Mouse sample demonstrates using the USB Human Interface Device (HID) module to implement a mouse input device that you can connect to your computer.

This sample code enumerates the iMX RT1011 Nano Kit into a HID mouse that has a left button connected to the USR/BT button.

Tip

adafruit_hid is pre-built into CircuitPython as a frozen module, so that it can be imported in the code directly.

Requirements

Before you start, check that you have the required hardware and software:

Running the code

To run the code, complete the following steps:

  1. Connect iMX RT1011 Nano Kit to your computer using the USB-C Cable.
  2. Start Mu Editor, click Load to open code.py in the CIRCUITPY drive.

  3. Copy and paste the following code into code.py and click Save:

    CIRCUITPY/code.py
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    import time
import board
import digitalio
import usb_hid
from adafruit_hid.mouse import Mouse

mouse = Mouse(usb_hid.devices)

left_button = digitalio.DigitalInOut(board.USR_BTN)
left_button.direction = digitalio.Direction.INPUT
left_button.pull = digitalio.Pull.DOWN

while True:
    if left_button.value is False:
        mouse.click(Mouse.LEFT_BUTTON)
        time.sleep(0.2)  # Debounce delay

  4. Your code will run as soon as the file is done saving. The board will enumerate as a HID mouse. Press USR/BT button on the board, and observe that a left mouse click is activated.