Skip to content

dtrochow/3-key

Repository files navigation

3-key

This project is focused on the 3-Key Development Board from Waveshare.

It introduces the base firmware written in C++ using the Pico-SDK.

Version v0.0.2 of the firmware adds CTRL+C/CTRL+V capabilities and simple RGB color support (each button has its own color).

The build.py script can be used only with the FW versions grater than v0.1.0. All previous versions require the manual firmware update process.

3-key hardware

Serial Terminal

To connect to the Serial Terminal the connect_serial.py script can be used.

python3 connect_serial.py

It finds the RPi Pico serial device name and connects to it using picocom tool.

All requirements are listed in requirements.txt file.

Documentation

The detailed documentation is available here: 3-key Project Documentation

How to run documentation locally

  1. Run docker container with the -d parameter (documentation)
python3 run_docker.py -d
  1. The documentation will be available on http://127.0.0.1:8000 address in any browser

Support

If you would like to contribute to the project or have any questions, please do not hesitate to create an issue or send an email to dominik.trochowski@gmail.com