/buttons

push it

Primary LanguagePython

BUTTONS

This project is the starting point for making USB HID buttons with circuitpython, beyond the easy stuff. The use cases are specific and personal.

NOTE:
there is a branch called fixitup that I am using to rename things so they don't reference joystick things. Once I am happy with that I will merge it into main. Also, if you make big changes to the codebase, you will need to delete the boot_out.txt file from the root of the CIRCUITPYTHON volume, as it caches information about the board and the code. this is created in hid.py and called in joystick.py

This first commit aims to make a button that acts as a Call Control device for Google Meet The code is ripped off from the incredible JoystickXL Project because it was the most complete and thought out project I could find that extends the CircutPython usb_hid device reports. It does it with the Generic Desktop usage_page and the Joystick usage, but we need to use the Telephony usage page and the headset usage.

Currently Mute is implemented but there is cruft all over the place and most of the classes and variables are still using joystick and gamepad nameing conventions.

TODO:

  • make mute work
  • instantiate a public repo
  • add and document yeet
  • refactor, clean up and streamline
  • add additional functionality like hang up and mute status led

I am standing on the shoulders of giants, namely:

and they have my gratitude.

This codebase is extremely unstable, and if I stick with it, will change constantly.

Helpful tools:

IDE: Thonny

HID I/O debugging: hidviz

https://docs.kernel.org/hid/hidintro.html

A couple of notes:

boot.py is a blessed filename that runs very early in the boot process. This is used to do lower level things like setting the USB modes etc. our boot.py gets all of the things in place to have this run as a USB HID with the correct report descriptor for telephony thing.py is a development kludge. Typically, the auto-executing script would go in a blessed file calle code.py (main.py also works) but I don't want the script to auto-exec because REPL. There is probably a better/more correct way to do this but this is what is working for me

REF: circuitpythondocs

This boot.py file sets 2 buttons. JoystickXL automatically sets up the report descriptors based on the number of buttons your device has. The actual digital pins are then setup in input.py, in this case GP4 & GP5. Each board names their pins slightly differently. I am using a Waveshare RP2040 Zero. If you are using a different board, you can get your pin's names via the board module. e.g.

>>> import board
>>> dir(board)
['__class__', '__name__', 'A0', 'A1', 'A2', 'A3', 'GP0', 'GP1', 'GP10', 'GP11', 'GP12', 'GP13', 'GP14', 'GP15', 'GP16', 'GP17', 'GP18', 'GP19', 'GP2', 'GP20', 'GP21', 'GP22', 'GP23', 'GP24', 'GP25', 'GP26', 'GP26_A0', 'GP27', 'GP27_A1', 'GP28', 'GP28_A2', 'GP29', 'GP29_A3', 'GP3', 'GP4', 'GP5', 'GP6', 'GP7', 'GP8', 'GP9', 'NEOPIXEL', 'RX', 'TX', 'UART', '__dict__', 'board_id']
>>>