Introduction

Helper class that encapsulates the objects needed for user code to interact with a USB mouse, draw a visible cursor, and determine when buttons are pressed.

Dependencies

This driver depends on:

Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

USB Wired Mouse - Two Buttons plus Wheel

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-usb-host-mouse

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-usb-host-mouse

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-usb-host-mouse

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_usb_host_mouse

Or the following command to update an existing version:

circup update

Usage Example

import supervisor
import terminalio
from adafruit_display_text.bitmap_label import Label
from displayio import Group
from adafruit_usb_host_mouse import find_and_init_boot_mouse
display = supervisor.runtime.display
# group to hold visual elements
main_group = Group()
# make the group visible on the display
display.root_group = main_group
mouse = find_and_init_boot_mouse()
if mouse is None:
    raise RuntimeError("No mouse found connected to USB Host")
# text label to show the x, y coordinates on the screen
output_lbl = Label(terminalio.FONT, text=f"{mouse.x},{mouse.y}", color=0xFFFFFF, scale=1)
# move it to the upper left corner
output_lbl.anchor_point = (0, 0)
output_lbl.anchored_position = (1, 1)
# add it to the main group
main_group.append(output_lbl)
# add the mouse tile grid to the main group
main_group.append(mouse.tilegrid)
# main loop
while True:
    # update mouse
    pressed_btns = mouse.update()
    # string with updated coordinates for the text label
    out_str = f"{mouse.x},{mouse.y}"
    # add pressed buttons to out str
    if pressed_btns is not None and len(pressed_btns) > 0:
        out_str += f" {" ".join(pressed_btns)}"
    # update the text label with the new coordinates
    # and buttons being pressed
    output_lbl.text = out_str

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.