pimoroni-tufty2040

Crates.iopimoroni-tufty2040
lib.rspimoroni-tufty2040
version0.1.0
sourcesrc
created_at2024-04-07 11:14:21.797152
updated_at2024-04-07 11:14:21.797152
descriptionBoard Support Package for the Pimoroni Tufty2040
homepagehttps://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni-tufty2040
repositoryhttps://github.com/rp-rs/rp-hal-boards.git
max_upload_size
id1199057
size53,989
Jan Niehusmann (jannic)

documentation

README

pimoroni-tufty2040 - Board Support for the Pimoroni Tufty2040

You should include this crate if you are writing code that you want to run on a Pimoroni Tufty2040 - a hackable, programmable badge with a LCD colour display, powered by a Raspberry Pi RP2040.

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

Using

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

pimoroni_tufty2040 = "0.1.0"

In your program, you will need to call pimoroni_tufty2040::Board::take().unwrap() to create a new Boards structure. This will set up all the GPIOs for any on-board devices and configure common clocks. 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/pimoroni-tufty2040 $ 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/pimoroni-tufty2040 $ cargo run --release --example <name>

If you get an error about not being able to find elf2uf2-rs, try:

$ cargo install elf2uf2-rs

then try repeating the cargo run command above.

tufty_demo

Flashes the Tufty2040's LED and draws a circle on the screen.

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 chose either the MIT licence or the Apache-2.0 licence when you re-use this code. See MIT or APACHE2.0 for more information on each specific licence.

Any submissions to this project (e.g. as Pull Requests) must be made available under these terms.

Commit count: 876

cargo fmt