Introduction¶

A big list of all HID consumer controls

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.

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 circuitpython-consumer-control-extended

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

sudo pip3 install circuitpython-consumer-control-extended

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-consumer-control-extended

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 consumer_control_extended

Or the following command to update an existing version:

circup update

Usage Example¶

import time
import board
import digitalio
import usb_hid
from adafruit_hid.consumer_control import ConsumerControl
from consumer_control_extended import AL_TEXT_EDITOR, AL_CALCULATOR

cc = ConsumerControl(usb_hid.devices)

# define buttons. these can be any physical switches/buttons, but the values
# here work out-of-the-box with a FunHouse UP and DOWN buttons.
button_up = digitalio.DigitalInOut(board.BUTTON_UP)
button_up.switch_to_input(pull=digitalio.Pull.DOWN)

button_down = digitalio.DigitalInOut(board.BUTTON_DOWN)
button_down.switch_to_input(pull=digitalio.Pull.DOWN)

while True:
    if button_up.value:
        print("Button up pressed!")
        # open the system text editor
        cc.send(AL_TEXT_EDITOR)

    if button_down.value:
        print("Button down pressed!")
        # open the calculator
        cc.send(AL_CALCULATOR)

    time.sleep(0.2)

Contributing¶

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

Documentation¶

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

Table of Contents¶

Examples

Simple test

API Reference

consumer_control_extended
- Implementation Notes