8b7c67ee47
This removes the hard-coded XTAL_FREQ_HZ variable from the rp-pico UART examples as it's already defined in this library as XOSC_CRYSTAL_FREQ. I noticed this as I was looking thru the examples and it seems like most of them use the rp_pico::XOSC_CRYSTAL_FREQ value instead. I'm new to embedded so please let me know if I got something wrong here. Thanks! |
||
---|---|---|
.. | ||
examples | ||
src | ||
.gitignore | ||
build.rs | ||
Cargo.toml | ||
CHANGELOG.md | ||
README.md |
rp-pico - Board Support for the Raspberry Pi Pico
You should include this crate if you are writing code that you want to run on a Raspberry Pi Pico - the original launch PCB for the RP2040 chip.
This crate includes the rp2040-hal, but also configures each pin of the RP2040 chip according to how it is connected up on the Pico.
Using
To use this crate, your Cargo.toml
file should contain:
rp-pico = "0.7.0"
In your program, you will need to call rp_pico::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/rp-pico $ 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/rp-pico $ 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.
From Scratch
To start a basic project from scratch, create a project using cargo new project-name
. Within the
project directory, run cargo add rp-pico
, cargo add cortex-m-rt
, and cargo add panic-halt
. The
first command will this HAL (Hardware Abstraction Layer), the second is required for the #[entry]
macro, and panic-halt creates a simple panic function, which just halts.
You'll also need to copy the cargo config file from the repo. It specifies the target and optimizing flags to the linker. You'll also need to copy memory.x to your project root. This file tells the linker the flash and RAM layout, so it won't clobber the bootloader or write to an out of bounds memory address.
The simplest working example, which does nothing except loop forever, is:
#![no_std]
#![no_main]
use rp_pico::entry;
use panic_halt as _;
#[entry]
fn see_doesnt_have_to_be_called_main() -> ! {
loop {}
}
It can be placed in /src/main.rs.
You can use cargo run
to compile and install it.
Note: You won't see any activity since this program does nothing. You can use the examples provided
to add more functionality.
pico_blinky
Flashes the Pico's on-board LED on and off.
pico_gpio_in_out
Reads a push button attached to GPIO 15 and drives the on-board LED to match it (i.e. on when pressed, off when not pressed).
pico_rtic
Demonstrates the use of the Real-Time Interrupt-driven Concurrency Framework on the Raspberry Pi Pico.
pico_countdown_blinky
Another LED blinking example, but using a Timer in count-down mode.
pico_pwm_blink
Puts out an analog 'triangle wave' on GPIO 25, using the PWM hardware.
pico_pwm_servo
Demonstrates handling a micro servo, using the PWM hardware.
pico_usb_serial
Creates a USB Serial device on a Pico board.
The USB Serial device will print HelloWorld
on start-up, and then echo any
incoming characters - except that any lower-case ASCII characters are
converted to the upper-case equivalent.
pico_usb_serial_interrupt
Creates a USB Serial device on a Pico board, but demonstrating handling interrupts when USB data arrives.
pico_usb_twitchy_mouse
Demonstrates emulating a USB Human Input Device (HID) Mouse. The mouse cursor will jiggle up and down.
pico_spi_sd_card
Example that shows how to use the embedded_sdmmc crate with the Raspberry Pi Pico.
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.