9 releases (breaking)
0.8.0 | Apr 7, 2024 |
---|---|
0.7.0 | Sep 2, 2023 |
0.6.0 | Feb 18, 2023 |
0.5.0 | Dec 11, 2022 |
0.1.0 | Dec 24, 2021 |
#973 in Hardware support
9KB
65 lines
adafruit-macropad - Board Support for the Adafruit Macropad
You should include this crate if you are writing code that you want to run on an Adafruit Macropad - a 3x4 keyboard and OLED combo board from Adafruit.
This crate includes the rp2040-hal, but also configures each pin of the RP2040 chip according to how it is connected up on the Feather.
Using
To use this crate, your Cargo.toml
file should contain:
adafruit-macropad = "0.8.0"
In your program, you will need to call adafruit_macropad::Pins::new
to create
a new Pins
structure. This will set up all the GPIOs for any on-board
devices. See the examples folder for more details.
Examples
General Instructions
To compile an example, clone the rp-hal-boards repository and run:
rp-hal-boards/boards/adafruit-macropad $ cargo build --release --example <name>
You will get an ELF file called
./target/thumbv6m-none-eabi/release/examples/<name>
, where the target
folder is located at the top of the rp-hal-boards repository checkout. Normally
you would also need to specify --target=thumbv6m-none-eabi
but when
building examples from this git repository, that is set as the default.
If you want to convert the ELF file to a UF2 and automatically copy it to the USB drive exported by the RP2040 bootloader, simply boot your board into bootloader mode and run:
rp-hal-boards/boards/adafruit-macropad $ cargo run --release --example <name>
If you get an error about not being able to find elf2uf2-rs
, try:
$ cargo install elf2uf2-rs, then repeating the `cargo run` command above.
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
The steps are:
- Fork the Project by clicking the 'Fork' button at the top of the page.
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Make some changes to the code or documentation.
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Feature Branch (
git push origin feature/AmazingFeature
) - Create a New Pull Request
- An admin will review the Pull Request and discuss any changes that may be required.
- Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!
Code of Conduct
Contribution to this crate is organized under the terms of the Rust Code of Conduct, and the maintainer of this crate, the rp-rs team, promises to intervene to uphold that code of conduct.
License
The contents of this repository are dual-licensed under the MIT OR Apache
2.0 License. That means you can choose either the MIT license or the
Apache-2.0 license when you re-use this code. See MIT
or APACHE2.0
for more
information on each specific license.
Any submissions to this project (e.g. as Pull Requests) must be made available under these terms.
Dependencies
~9MB
~178K SLoC