Skip to content

docs improvements #1

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

Merged
merged 1 commit into from
May 7, 2025
Merged

docs improvements #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions adafruit_usb_host_mouse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@


def find_and_init_boot_mouse():
"""
Scan for an attached boot mouse connected via USB host.
If one is found initialize an instance of BootMouse class
and return it.
:return: The BootMouse instance or None if no mouse was found.
"""
mouse_interface_index, mouse_endpoint_address = None, None
mouse_device = None

Expand Down Expand Up @@ -96,6 +102,17 @@ def find_and_init_boot_mouse():


class BootMouse:
"""
Helpler class that encapsulates the objects needed to interact with a boot
mouse, show a visible cursor on the display, and determine when buttons
were pressed.

:param device: The usb device instance for the mouse
:param endpoint_address: The address of the mouse endpoint
:param tilegrid: The TileGrid that holds the visible mouse cursor
:param was_attached: Whether the usb device was attached to the kernel
"""

def __init__(self, device, endpoint_address, tilegrid, was_attached):
self.device = device
self.tilegrid = tilegrid
Expand All @@ -107,17 +124,34 @@ def __init__(self, device, endpoint_address, tilegrid, was_attached):

@property
def x(self):
"""
The x coordinate of the mouse cursor
"""
return self.tilegrid.x

@property
def y(self):
"""
The y coordinate of the mouse cursor
"""
return self.tilegrid.y

def release(self):
"""
Release the mouse cursor and re-attach it to the kernel
if it was attached previously.
"""
if self.was_attached and not self.device.is_kernel_driver_active(0):
self.device.attach_kernel_driver(0)

def update(self):
"""
Read data from the USB mouse and update the location of the visible cursor
and check if any buttons are pressed.

:return: a List containing one or more of the strings "left", "right", "middle"
indicating which buttons are pressed.
"""
try:
# attempt to read data from the mouse
# 20ms timeout, so we don't block long if there
Expand Down