Introduction¶
Mouse cursor for interaction with CircuitPython UI elements such as buttons.
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
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-cursorcontrol
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-cursorcontrol
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-cursorcontrol
Usage Example¶
See examples in examples/ folder.
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.
Table of Contents¶
Examples
API Reference
adafruit_cursorcontrol.cursorcontrol
Cursor
adafruit_cursorcontrol.cursorcontrol_cursormanager
CursorManager
DebouncedCursorManager
DebouncedCursorManager.alt_held
DebouncedCursorManager.alt_released
DebouncedCursorManager.held
DebouncedCursorManager.is_alt_clicked
DebouncedCursorManager.is_clicked
DebouncedCursorManager.is_select_clicked
DebouncedCursorManager.is_start_clicked
DebouncedCursorManager.released
DebouncedCursorManager.select_held
DebouncedCursorManager.select_released
DebouncedCursorManager.start_held
DebouncedCursorManager.start_released
DebouncedCursorManager.update()