Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inputlabs/alpakka_firmware
https://github.com/inputlabs/alpakka_firmware
Last synced: about 8 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/inputlabs/alpakka_firmware
- Owner: inputlabs
- License: gpl-2.0
- Created: 2022-11-23T19:14:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T15:51:01.000Z (4 months ago)
- Last Synced: 2024-08-03T09:02:02.874Z (4 months ago)
- Language: C
- Size: 620 KB
- Stars: 101
- Watchers: 5
- Forks: 21
- Open Issues: 28
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license.md
Awesome Lists containing this project
README
# Alpakka Firmware
*Alpakka controller reference firmware (for Raspberry Pi Pico)*
## Project links
- [Alpakka Manual](https://inputlabs.io/devices/alpakka/manual).
- [Alpakka Firmware](https://github.com/inputlabs/alpakka_firmware). _(you are here)_
- [Alpakka PCB](https://github.com/inputlabs/alpakka_pcb).
- [Alpakka 3D-print](https://github.com/inputlabs/alpakka_case).
- [Input Labs Roadmap](https://github.com/orgs/inputlabs/projects/2/views/2).## Supported developer operative systems
- GNU/Linux (and MacOS) - See [Development in Linux](https://inputlabs.io/devices/alpakka/manual/dev_unix).
- Windows - See [Development in Windows](https://inputlabs.io/devices/alpakka/manual/dev_windows).## System dependencies
With `apt`, `rpm`, `pacman`, `brew`, or the equivalent package manager of your system, install:
- **gcc**
- **git**
- **cmake**## Project dependencies
- `make install`: Download and configure dependencies automatically.## Development commands
- `make`: Build compilation environment and build executables.
- `make rebuild`: Build executables again using cache (faster).
- `make load`: Load built .uf2 file into the Pico (requires bootsel mode or active session).
- `make reload`: Do both `rebuild` and `load` commands (for dev convenience).
- `make clean`: Delete previous build files.
- `make session`: Connect to UART serial stdio, and display controller log.While having an active session:
- `make restart`: Restart the controller.
- `make bootsel`: Put the controller in bootsel mode.
- `make calibrate`: Calibrate thumbstick and IMUs.
- `make format`: Format NVM sector and reset to initial values.
- `make test`: Start a semi-manual testing procedure for the buttons and axis.## Devkit button
- Single press: Restart the controller.
- Double press: Put the controller in bootsel mode.Read the [Alpakka developer manual](https://inputlabs.io/devices/alpakka/manual/dev) for details about the **devkit** and more.