HackBerry

Portable keyboard and macropad based on MicroPython.

This project is under development.

Prerequisites

Setup virtual environment

python3 -m venv venv
source venv/bin/activate
python3 -m pip install -r requirements.txt

Development

Run on unix port

make toolchain          # Setup mpy-cross and micropython
make build              # Cross-compile, create build artifacts
make test-unix          # Run functional tests on the unix port

Deploy to a device

make toolchain          # Setup mpy-cross and micropython
make build              # Cross-compile, create build artifacts
make deploy             # Upload build artifacts to device using mpremote
make run-device         # Optional: Reset the device and connect through REPL

deploy and run-device uses the DEVICE argument set to u0 (/dev/ttyUSB0) by default, passed to mpremote.

Override the DEVICE argument to select a different device, e.g. make DEVICE=a0 run-device for /dev/ttyACM0. Check mpremote --help for additional shortcuts.

Redeploy

When changing the source code, run the below rule for redeploying to the device.

make redeploy           # Will run the following rules: clean build clean-device deploy

Unit tests, pylint, functional tests

make static-checkers    # Run static checkers (Pylint, black formatter)
make unit-test          # Run unit tests
make test-unix          # Run functional tests on the unix port