mirror of
https://github.com/italicsjenga/rp-hal-boards.git
synced 2024-12-24 05:01:31 +11:00
91 lines
3.4 KiB
Markdown
91 lines
3.4 KiB
Markdown
# [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.
|
|
|
|
[adafruit-macropad]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/adafruit-macropad
|
|
[Adafruit Macropad]: https://www.adafruit.com/product/5128
|
|
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
|
|
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
|
|
|
|
## Using
|
|
|
|
To use this crate, your `Cargo.toml` file should contain:
|
|
|
|
```toml
|
|
adafruit-macropad = "0.6.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](./examples) folder for more details.
|
|
|
|
## Examples
|
|
|
|
### General Instructions
|
|
|
|
To compile an example, clone the _rp-hal-boards_ repository and run:
|
|
|
|
```console
|
|
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:
|
|
|
|
```console
|
|
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:
|
|
|
|
```console
|
|
$ 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:
|
|
|
|
1. Fork the Project by clicking the 'Fork' button at the top of the page.
|
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
|
3. Make some changes to the code or documentation.
|
|
4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
|
5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)
|
|
6. Create a [New Pull Request](https://github.com/rp-rs/rp-hal-boards/pulls)
|
|
7. An admin will review the Pull Request and discuss any changes that may be required.
|
|
8. 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][CoC], and the maintainer of this crate, the [rp-rs team], promises
|
|
to intervene to uphold that code of conduct.
|
|
|
|
[CoC]: CODE_OF_CONDUCT.md
|
|
[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs
|
|
|
|
## 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.
|