f8984a9eac
Implementing `impl From<SystemClock> for Hertz` is a footgun, as
SystemClock is not Copy, so the automatic conversion consumes the
owned clock.
This is visible in the example i2c.rs:
```
let mut i2c = hal::I2C::i2c1(
pac.I2C1,
sda_pin,
scl_pin, // Try `not_an_scl_pin` here
400.kHz(),
&mut pac.RESETS,
clocks.peripheral_clock,
);
```
If the user wants to use both `i2c0` and `i2c1` at the same time,
copying from this example won't work:
```
error[E0382]: use of moved value: `clocks.peripheral_clock`
--> rp2040-hal/examples/i2c.rs:106:9
|
97 | clocks.peripheral_clock,
| ----------------------- value moved here
...
106 | clocks.peripheral_clock,
| ^^^^^^^^^^^^^^^^^^^^^^^ value used here after move
|
= note: move occurs because `clocks.peripheral_clock` has type
`PeripheralClock`, which does not implement the `Copy` trait
```
As getting the frequency from a clock doesn't really need ownership,
changing it to `impl From<&SystemClock> for Hertz` is both more
logical and provides better usability.
This is, however, a breaking change: Code relying on this trait
implementation needs to be changed by adding a `&`.
|
||
|---|---|---|
| .. | ||
| examples | ||
| src | ||
| .gitignore | ||
| 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.4.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 repository and run:
rp-hal/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 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/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.
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.