alex/rp-hal-boards
1
0
Fork 0
mirror of https://github.com/italicsjenga/rp-hal-boards.git synced 2024-12-24 05:01:31 +11:00
Code Issues Packages Projects Releases Wiki Activity
rp-hal-boards/boards/sparkfun-pro-micro-rp2040/README.md

3.6 KiB
Raw Blame History

sparkfun-pro-micro-rp2040 - Board Support for the Sparkfun Pro Micro RP2040

You should include this crate if you are writing code that you want to run on a Sparkfun Pro Micro RP2040 - a smaller RP2040 board with USB-C and a WS2812B addressable LED.

This crate includes the rp2040-hal, but also configures each pin of the RP2040 chip according to how it is connected up on the Pro Micro RP2040.

Using

To use this crate, your Cargo.toml file should contain:

sparkfun-pro-micro-rp2040 = "0.2.0"

In your program, you will need to call sparkfun_pro_micro_rp2040::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 repository and run:

rp-hal/boards/sparkfun-pro-micro-rp2040 $ 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 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/sparkfun-pro-micro-rp2040 $ 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.

Rainbow

This example will display a colour-wheel rainbow effect on the on-board LED.

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
  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, 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.