Include manufacturer in BSP crate name.

Avoids ambiguity.
This commit is contained in:
Jonathan Pallant 2021-12-20 21:28:00 +00:00
parent 37e7d2e7b6
commit 4959afe151
44 changed files with 221 additions and 221 deletions

View file

@ -2,15 +2,15 @@
resolver = "2"
members = [
"rp2040-hal",
"boards/feather-rp2040",
"boards/qt-py-rp2040",
"boards/itsy-bitsy-rp2040",
"boards/kb2040",
"boards/adafruit-feather-rp2040",
"boards/adafruit-qt-py-rp2040",
"boards/adafruit-itsy-bitsy-rp2040",
"boards/adafruit-kb2040",
"boards/pico",
"boards/pico-explorer",
"boards/pico-lipo-16mb",
"boards/pimoroni-pico-explorer",
"boards/pimoroni-pico-lipo-16mb",
"boards/adafruit-macropad",
"boards/pro-micro-rp2040",
"boards/sparkfun-pro-micro-rp2040",
]
[patch.'https://github.com/rp-rs/rp-hal.git']

102
README.md
View file

@ -126,18 +126,7 @@ RP2040 chip according to how it is connected up on the Pico.
[Raspberry Pi Pico]: https://www.raspberrypi.org/products/raspberry-pi-pico/
[pico]: https://github.com/rp-rs/rp-hal/tree/main/boards/pico
### [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 Macropad.
[adafruit_macropad]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_macropad
[Adafruit Macropad]: https://www.adafruit.com/product/5128
### [feather_rp2040] - Board Support for the [Adafruit Feather RP2040]
### [adafruit-feather-rp2040] - Board Support for the [Adafruit Feather RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit Feather RP2040] - a Feather form-factor RP2040 board from Adafruit.
@ -146,9 +135,51 @@ 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 RP2040.
[Adafruit Feather RP2040]: https://www.adafruit.com/product/4884
[feather_rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/feather_rp2040
[adafruit-feather-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_feather_rp2040
### [pico_explorer] - Board Support for the [Pimoroni Pico Explorer]
### [adafruit-itsy-bitsy-rp2040] - Board Support for the [Adafruit ItsyBitsy RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit ItsyBitsy RP2040] - an RP2040 board in the ItsyBitsy family.
This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the ItsyBitsy RP2040.
[Adafruit ItsyBitsy RP2040]: https://www.adafruit.com/product/4888
[adafruit-itsy-bitsy-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_itsy_bitsy_rp2040
### [adafruit-kb2040] - Board Support for the [Adafruit adafruit-kb2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit adafruit-kb2040] - an Arduino Pro Micro-shaped board for keyboards.
This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the adafruit-kb2040.
[Adafruit adafruit-kb2040]: https://www.adafruit.com/product/5302
[adafruit-kb2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-kb2040
### [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 Macropad.
[adafruit-macropad]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_macropad
[Adafruit Macropad]: https://www.adafruit.com/product/5128
### [adafruit-qt-py-rp2040] - Board Support for the [Adafruit QT Py RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit QT Py RP2040] - an extremely small form-factor RP2040 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 RP2040.
[Adafruit QT Py RP2040]: https://www.adafruit.com/product/4900
[adafruit-qt-py-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_qt_py_rp2040
### [pimoroni-pico-explorer] - Board Support for the [Pimoroni Pico Explorer]
You should include this crate if you are writing code that you want to run on
a [Pimoroni Pico Explorer] - a board featuring a small LCD screen, a
@ -157,10 +188,10 @@ breadboard and some breakout headers.
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 Explorer.
[Pimoroni Pico Explorer]: https://shop.pimoroni.com/products/pico-explorer-base
[pico_explorer]: https://github.com/rp-rs/rp-hal/tree/main/boards/pico_explorer
[Pimoroni Pico Explorer]: https://shop.pimoroni.com/products/pimoroni-pico-explorer-base
[pimoroni-pico-explorer]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni_pico_explorer
### [pico_lipo_16mb] - Board Support for the [Pimoroni Pico Lipo 16MB]
### [pimoroni-pico-lipo-16mb] - Board Support for the [Pimoroni Pico Lipo 16MB]
You should include this crate if you are writing code that you want to run on
a [Pimoroni Pico Lipo 16MB] - a board with USB-C, STEMMA QT/Qwiic connectors,
@ -173,9 +204,9 @@ Note that if you use this crate the compiler will expect the full 16MB flash
space, and so it may not work if you only have the 4MB variant.
[Pimoroni Pico Lipo 16MB]: https://shop.pimoroni.com/products/pimoroni-pico-lipo?variant=39335427080275
[pico_lipo_16mb]: https://github.com/rp-rs/rp-hal/tree/main/boards/pico_lipo_16mb
[pimoroni-pico-lipo-16mb]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni_pico_lipo_16mb
### [pro_micro_rp2040] - Board Support for the [Sparkfun Pro Micro RP2040]
### [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.
@ -184,38 +215,7 @@ 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.
[Sparkfun Pro Micro RP2040]: https://www.sparkfun.com/products/18288
[pro_micro_rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/pro_micro_rp2040
### [qt_py_rp2040] - Board Support for the [Adafruit QT Py RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit QT Py RP2040] - an extremely small form-factor RP2040 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 RP2040.
[Adafruit QT Py RP2040]: https://www.adafruit.com/product/4900
[qt_py_rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/qt_py_rp2040
### [itsy_bitsy_rp2040] - Board Support for the [Adafruit ItsyBitsy RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit ItsyBitsy RP2040] - an RP2040 board in the ItsyBitsy family.
This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the ItsyBitsy RP2040.
[Adafruit ItsyBitsy RP2040]: https://www.adafruit.com/product/4888
[itsy_bitsy_rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/itsy_bitsy_rp2040
### [kb2040] - Board Support for the [Adafruit KB2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit KB2040] - an Arduino Pro Micro-shaped board for keyboards.
This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the KB2040.
[Adafruit KB2040]: https://www.adafruit.com/product/5302
[kb2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/kb2040
[sparkfun-pro-micro-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/sparkfun_pro_micro_rp2040
<!-- PROGRAMMING -->
## Programming

View file

@ -19,5 +19,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/kb2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/kb2040-v0.1.0
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/adafruit-feather-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/adafruit-feather-rp2040-v0.1.0

View file

@ -1,9 +1,9 @@
[package]
name = "feather-rp2040"
name = "adafruit-feather-rp2040"
version = "0.1.0"
authors = ["Andrea Nall <anall@andreanal.com>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/feather-rp2040"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-feather-rp2040"
description = "Board Support Package for the Adafruit Feather RP2040"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [feather-rp2040] - Board Support for the [Adafruit Feather RP2040]
# [adafruit-feather-rp2040] - Board Support for the [Adafruit Feather RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit Feather RP2040] - a Feather form-factor RP2040 board from Adafruit.
@ -7,7 +7,7 @@ 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 Feather RP2040]: https://www.adafruit.com/product/4884
[feather-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/feather-rp2040
[adafruit-feather-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-feather-rp2040
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
@ -16,10 +16,10 @@ RP2040 chip according to how it is connected up on the Feather.
To use this crate, your `Cargo.toml` file should contain:
```toml
feather-rp2040 = "0.1.0"
adafruit-feather-rp2040 = "0.1.0"
```
In your program, you will need to call `feather_rp2040::Pins::new` to create
In your program, you will need to call `adafruit_feather_rp2040::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.
@ -30,7 +30,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/feather-rp2040 $ cargo build --release --example <name>
rp-hal/boards/adafruit-feather-rp2040 $ cargo build --release --example <name>
```
You will get an ELF file called
@ -44,7 +44,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/feather-rp2040 $ cargo run --release --example <name>
rp-hal/boards/adafruit-feather-rp2040 $ cargo run --release --example <name>
```
If you get an error about not being able to find `elf2uf2-rs`, try:
@ -53,11 +53,11 @@ 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.
```
### [feather_blinky](./examples/feather_blinky.rs)
### [adafruit_feather_blinky](./examples/adafruit_feather_blinky.rs)
Flashes the Feather's onboard LED on and off.
### [feather_neopixel_rainbow](./examples/feather_neopixel_rainbow.rs)
### [adafruit_feather_neopixel_rainbow](./examples/adafruit_feather_neopixel_rainbow.rs)
Flows smoothly through various colors on the Feather's onboard NeoPixel LED.

View file

@ -7,7 +7,7 @@
use cortex_m_rt::entry;
use embedded_hal::digital::v2::OutputPin;
use embedded_time::rate::*;
use feather_rp2040::{
use adafruit_feather_rp2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,

View file

@ -10,7 +10,7 @@ use core::iter::once;
use cortex_m_rt::entry;
use embedded_hal::timer::CountDown;
use embedded_time::duration::Extensions;
use feather_rp2040::{
use adafruit_feather_rp2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,

View file

@ -0,0 +1,23 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- None
### Changed
- None
## [0.1.0] - 2021-12-20
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/adafruit-itsy-bitsy-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/adafruit-itsy-bitsy-rp2040-v0.1.0

View file

@ -1,9 +1,9 @@
[package]
name = "itsy-bitsy-rp2040"
name = "adafruit-itsy-bitsy-rp2040"
version = "0.1.0"
authors = ["Andrew Christiansen <andrewtaylorchristiansen@gmail.com>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/itsy_bitsy_rp2040"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_itsy_bitsy_rp2040"
description = "Board Support Package for the Adafruit ItsyBitsy RP2040"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [itsy-bitsy-rp2040] - Board Support for the [Adafruit ItsyBitsy RP2040]
# [adafruit-itsy-bitsy-rp2040] - Board Support for the [Adafruit ItsyBitsy RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit ItsyBitsy RP2040] - an RP2040 board in the Itsy family from Adafruit.
@ -7,7 +7,7 @@ This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the ItsyBitsy RP2040.
[Adafruit ItsyBitsy RP2040]: https://www.adafruit.com/product/4888
[itsy-bitsy-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/itsy-bitsy-rp2040
[adafruit-itsy-bitsy-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-itsy-bitsy-rp2040
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
@ -16,10 +16,10 @@ RP2040 chip according to how it is connected up on the ItsyBitsy RP2040.
To use this crate, your `Cargo.toml` file should contain:
```toml
itsy-bitsy-rp2040 = "0.1.0"
adafruit-itsy-bitsy-rp2040 = "0.1.0"
```
In your program, you will need to call `itsy_bitsy_rp2040::Pins::new` to create
In your program, you will need to call `adafruit_itsy_bitsy_rp2040::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.
@ -30,7 +30,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/itsy-bitsy-rp2040 $ cargo build --release --example <name>
rp-hal/boards/adafruit-itsy-bitsy-rp2040 $ cargo build --release --example <name>
```
You will get an ELF file called
@ -44,7 +44,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/itsy-bitsy-rp2040 $ cargo run --release --example <name>
rp-hal/boards/adafruit-itsy-bitsy-rp2040 $ cargo run --release --example <name>
```
If you get an error about not being able to find `elf2uf2-rs`, try:
@ -53,7 +53,11 @@ 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.
```
### [itsy_bitsy_rainbow](./examples/itsy_bitsy_rainbow.rs)
### [adafruit_itsy_bitsy_blinky](./examples/adafruit_itsy_bitsy_blinky.rs)
Blink an LED on and off.
### [adafruit_itsy_bitsy_rainbow](./examples/adafruit_itsy_bitsy_rainbow.rs)
Continuously changes the color of the ItsyBitsy's onboard Neopixel.

View file

@ -20,7 +20,7 @@ use panic_halt as _;
use embedded_hal::digital::v2::OutputPin;
use embedded_time::fixed_point::FixedPoint;
use itsy_bitsy_rp2040::{
use adafruit_itsy_bitsy_rp2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,

View file

@ -11,7 +11,7 @@ use panic_halt as _;
use smart_leds::{brightness, SmartLedsWrite, RGB8};
use ws2812_pio::Ws2812;
use itsy_bitsy_rp2040::{
use adafruit_itsy_bitsy_rp2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,

View file

@ -19,5 +19,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/feather-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/feather-rp2040-v0.1.0
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/adafruit-kb2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/adafruit-kb2040-v0.1.0

View file

@ -1,10 +1,10 @@
[package]
name = "kb2040"
name = "adafruit-kb2040"
version = "0.1.0"
authors = ["Andrew Christiansen <andrewtaylorchristiansen@gmail.com>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/kb2040"
description = "Board Support Package for the Adafruit KB2040"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-kb2040"
description = "Board Support Package for the Adafruit adafruit-kb2040"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [kb2040] - Board Support for the [Adafruit KB2040]
# [adafruit-kb2040] - Board Support for the [Adafruit KB2040]
You should include this crate if you are writing code that you want to run on
a [Adafruit KB2040] - an Arduino Pro Micro-shaped board for keyboards.
@ -7,7 +7,7 @@ This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the KB2040.
[Adafruit KB2040]: https://www.adafruit.com/product/5302
[kb2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/kb2040
[adafruit-kb2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-kb2040
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
@ -16,10 +16,10 @@ RP2040 chip according to how it is connected up on the KB2040.
To use this crate, your `Cargo.toml` file should contain:
```toml
kb2040 = "0.1.0"
adafruit-kb2040 = "0.1.0"
```
In your program, you will need to call `kb2040::Pins::new` to create
In your program, you will need to call `adafruit-kb2040::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.
@ -30,7 +30,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/kb2040 $ cargo build --release --example <name>
rp-hal/boards/adafruit-kb2040 $ cargo build --release --example <name>
```
You will get an ELF file called
@ -44,7 +44,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/kb2040$ cargo run --release --example <name>
rp-hal/boards/adafruit-kb2040$ cargo run --release --example <name>
```
If you get an error about not being able to find `elf2uf2-rs`, try:
@ -53,7 +53,7 @@ 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](./examples/kb2040_rainbow.rs)
### [Rainbow](./examples/adafruit_kb2040_rainbow.rs)
This example will display a colour-wheel rainbow effect on the on-board LED.

View file

@ -14,7 +14,7 @@ use embedded_hal::timer::CountDown;
use embedded_time::duration::Extensions;
use panic_halt as _;
use kb2040::{
use adafruit_kb2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,
@ -62,7 +62,7 @@ fn main() -> ! {
let sio = Sio::new(pac.SIO);
let pins = kb2040::Pins::new(
let pins = adafruit_kb2040::Pins::new(
pac.IO_BANK0,
pac.PADS_BANK0,
sio.gpio_bank0,

View file

@ -53,10 +53,6 @@ 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.
```
### [feather_blinky](./examples/feather_blinky.rs)
Flashes the Feather's on-board LED on and off.
## Contributing
Contributions are what make the open source community such an amazing place to

View file

@ -19,5 +19,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/pico-explorer-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/pico-explorer-v0.1.0
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/adafruit-qt-py-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/adafruit-qt-py-rp2040-v0.1.0

View file

@ -1,9 +1,9 @@
[package]
name = "qt-py-rp2040"
name = "adafruit-qt-py-rp2040"
version = "0.1.0"
authors = ["Stephen Onnen <stephen.onnen@gmail.com>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/qt-py-rp2040"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-qt-py-rp2040"
description = "Board Support Package for the Adafruit QT Py RP2040"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [qt-py-rp2040] - Board Support for the [Adafruit QT Py RP2040]
# [adafruit-qt-py-rp2040] - Board Support for the [Adafruit QT Py RP2040]
You should include this crate if you are writing code that you want to run on
an [Adafruit QT Py RP2040] - an extremely small form-factor RP2040 board from Adafruit.
@ -7,7 +7,7 @@ This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the QT Py.
[Adafruit QT Py RP2040]: https://www.adafruit.com/product/4900
[qt-py-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/qt-py-rp2040
[adafruit-qt-py-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-qt-py-rp2040
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
@ -16,10 +16,10 @@ RP2040 chip according to how it is connected up on the QT Py.
To use this crate, your `Cargo.toml` file should contain:
```toml
qt-py-rp2040 = { git = "https://github.com/rp-rs/rp-hal.git" }
adafruit-qt-py-rp2040 = { git = "https://github.com/rp-rs/rp-hal.git" }
```
In your program, you will need to call `qt_py_rp2040::Pins::new` to create
In your program, you will need to call `adafruit_qt_py_rp2040::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.
@ -30,7 +30,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/qt-py-rp2040 $ cargo build --release --example <name>
rp-hal/boards/adafruit-qt-py-rp2040 $ cargo build --release --example <name>
```
You will get an ELF file called
@ -44,7 +44,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/qt-py-rp2040 $ cargo run --release --example <name>
rp-hal/boards/adafruit-qt-py-rp2040 $ cargo run --release --example <name>
```
If you get an error about not being able to find `elf2uf2-rs`, try:
@ -53,7 +53,7 @@ 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.
```
### [qt_py_rainbow](./examples/qt_py_rainbow.rs)
### [adafruit_qt_py_rp2040_rainbow](./examples/adafruit_qt_py_rp2040_rainbow.rs)
Continuously changes the color of the QT Py's onboard Neopixel.

View file

@ -11,7 +11,7 @@ use panic_halt as _;
use smart_leds::{brightness, SmartLedsWrite, RGB8};
use ws2812_pio::Ws2812;
use qt_py_rp2040::{
use adafruit_qt_py_rp2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,

View file

@ -1,23 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- None
### Changed
- None
## [0.1.0] - 2021-12-20
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/pico-lipo-16mb-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/pico-lipo-16mb-v0.1.0

View file

@ -19,5 +19,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/itsy-bitsy-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/itsy-bitsy-rp2040-v0.1.0
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/pimoroni-pico-explorer-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/pimoroni-pico-explorer-v0.1.0

View file

@ -1,9 +1,9 @@
[package]
name = "pico-explorer"
name = "pimoroni-pico-explorer"
version = "0.1.0"
authors = ["Hmvp <hmvp@users.noreply.github.com>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/pico-explorer"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-pico-explorer"
description = "Board Support Package for the Pico Explorer"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [pico-explorer] - Board Support for the [Pimoroni Pico Explorer]
# [pimoroni-pico-explorer] - Board Support for the [Pimoroni Pico Explorer]
You should include this crate if you are writing code that you want to run on
a [Pimoroni Pico Explorer] - a board featuring a small LCD screen, a
@ -7,8 +7,8 @@ breadboard and some breakout headers.
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 Explorer.
[Pimoroni Pico Explorer]: https://shop.pimoroni.com/products/pico-explorer-base
[pico-explorer]: https://github.com/rp-rs/rp-hal/tree/main/boards/pico-explorer
[Pimoroni Pico Explorer]: https://shop.pimoroni.com/products/pimoroni-pico-explorer-base
[pimoroni-pico-explorer]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-pico-explorer
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
@ -17,10 +17,10 @@ RP2040 chip according to how it is connected up on the Pico Explorer.
To use this crate, your `Cargo.toml` file should contain:
```toml
pico-explorer = "0.1.0"
pimoroni-pico-explorer = "0.1.0"
```
In your program, you will need to call `pico_explorer::Pins::new` to create
In your program, you will need to call `pimoroni_pico_explorer::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.
@ -31,7 +31,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/pico-explorer $ cargo build --release --example <name>
rp-hal/boards/pimoroni-pico-explorer $ cargo build --release --example <name>
```
You will get an ELF file called
@ -45,7 +45,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/pico-explorer $ cargo run --release --example <name>
rp-hal/boards/pimoroni-pico-explorer $ cargo run --release --example <name>
```
If you get an error about not being able to find `elf2uf2-rs`, try:
@ -54,7 +54,7 @@ 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.
```
### [pico_explorer_showcase](./examples/pico_explorer_showcase.rs)
### [pimoroni_pico_explorer_showcase](./examples/pimoroni_pico_explorer_showcase.rs)
Displays the current temperature on the Pico Explorer's on-board LCD screen.

View file

@ -14,7 +14,7 @@ use embedded_hal::digital::v2::OutputPin;
use embedded_time::rate::*;
use hal::{adc::Adc, clocks::*, watchdog::Watchdog, Sio};
use panic_halt as _;
use pico_explorer::{hal, pac, Button, PicoExplorer, XOSC_CRYSTAL_FREQ};
use pimoroni_pico_explorer::{hal, pac, Button, PicoExplorer, XOSC_CRYSTAL_FREQ};
// See 4.9.5 from RP2040 datasheet
fn calc_temp(adc_value: f32, refv: f64) -> f64 {

View file

@ -0,0 +1,23 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- None
### Changed
- None
## [0.1.0] - 2021-12-20
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/pimoroni-pico-lipo-16mb-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/pimoroni-pico-lipo-16mb-v0.1.0

View file

@ -1,9 +1,9 @@
[package]
name = "pico-lipo-16mb"
name = "pimoroni-pico-lipo-16mb"
version = "0.1.0"
authors = ["Hmvp <hmvp@users.noreply.github.com>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/pico-lipo-16mb"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-pico-lipo-16mb"
description = "Board Support Package for the Pico LiPo 16MB"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [pico-lipo-16mb] - Board Support for the [Pimoroni Pico Lipo 16MB]
# [pimoroni-pico-lipo-16mb] - Board Support for the [Pimoroni Pico Lipo 16MB]
You should include this crate if you are writing code that you want to run on
a [Pimoroni Pico Lipo 16MB] - a board with USB-C, STEMMA QT/Qwiic connectors,
@ -11,17 +11,17 @@ Note that if you use this crate the compiler will expect the full 16MB flash
space, and so it may not work if you only have the 4MB variant.
[Pimoroni Pico Lipo 16MB]: https://shop.pimoroni.com/products/pimoroni-pico-lipo?variant=39335427080275
[pico-lipo-16mb]: https://github.com/rp-rs/rp-hal/tree/main/boards/pico-lipo-16mb
[pimoroni-pico-lipo-16mb]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-pico-lipo-16mb
## Using
To use this crate, your `Cargo.toml` file should contain:
```toml
pico-lipo-16mb = { git = "https://github.com/rp-rs/rp-hal.git" }
pimoroni-pico-lipo-16mb = { git = "https://github.com/rp-rs/rp-hal.git" }
```
In your program, you will need to call `pico_lipo_16mb::Pins::new` to create
In your program, you will need to call `pimoroni_pico_lipo_16mb::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.
@ -32,7 +32,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/pico-lipo-16mb $ cargo build --release --example <name>
rp-hal/boards/pimoroni-pico-lipo-16mb $ cargo build --release --example <name>
```
You will get an ELF file called
@ -46,7 +46,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/pico-lipo-16mb $ cargo run --release --example <name>
rp-hal/boards/pimoroni-pico-lipo-16mb $ cargo run --release --example <name>
```
If you get an error about not being able to find `elf2uf2-rs`, try:
@ -55,7 +55,7 @@ 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.
```
### [pico_lipo_16mb_blinky](./examples/pico_lipo_16mb_blinky.rs)
### [pimoroni_pico_lipo_16mb_blinky](./examples/pimoroni_pico_lipo_16mb_blinky.rs)
Flashes the Pico Lipo's on-board LED on and off.

View file

@ -24,15 +24,15 @@ use embedded_time::rate::*;
use panic_halt as _;
// Pull in any important traits
use pico_lipo_16mb::hal::prelude::*;
use pimoroni_pico_lipo_16mb::hal::prelude::*;
// A shorter alias for the Peripheral Access Crate, which provides low-level
// register access
use pico_lipo_16mb::hal::pac;
use pimoroni_pico_lipo_16mb::hal::pac;
// A shorter alias for the Hardware Abstraction Layer, which provides
// higher-level drivers.
use pico_lipo_16mb::hal;
use pimoroni_pico_lipo_16mb::hal;
/// Entry point to our bare-metal application.
///
@ -54,7 +54,7 @@ fn main() -> ! {
//
// The default is to generate a 125 MHz system clock
let clocks = hal::clocks::init_clocks_and_plls(
pico_lipo_16mb::XOSC_CRYSTAL_FREQ,
pimoroni_pico_lipo_16mb::XOSC_CRYSTAL_FREQ,
pac.XOSC,
pac.CLOCKS,
pac.PLL_SYS,
@ -73,7 +73,7 @@ fn main() -> ! {
let sio = hal::Sio::new(pac.SIO);
// Set the pins up according to their function on this particular board
let pins = pico_lipo_16mb::Pins::new(
let pins = pimoroni_pico_lipo_16mb::Pins::new(
pac.IO_BANK0,
pac.PADS_BANK0,
sio.gpio_bank0,

View file

@ -1,23 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- None
### Changed
- None
## [0.1.0] - 2021-12-20
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/pro-micro-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/pro-micro-rp2040-v0.1.0

View file

@ -1,23 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- None
### Changed
- None
## [0.1.0] - 2021-12-20
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/qt-py-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/qt-py-rp2040-v0.1.0

View file

@ -0,0 +1,23 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- None
### Changed
- None
## [0.1.0] - 2021-12-20
- Initial release
[Unreleased]: https://github.com/rp-rs/rp-hal/compare/sparkfun-pro-micro-rp2040-v0.1.0...HEAD
[0.1.0]: https://github.com/rp-rs/rp-hal/releases/tag/sparkfun-pro-micro-rp2040-v0.1.0

View file

@ -1,9 +1,9 @@
[package]
name = "pro-micro-rp2040"
name = "sparkfun-pro-micro-rp2040"
version = "0.1.0"
authors = ["Wilfried Chauveau <wilfried.chauveau@ithinuel.me>"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/pro-micro-rp2040"
homepage = "https://github.com/rp-rs/rp-hal/tree/main/boards/sparkfun-pro-micro-rp2040"
description = "Board Support Package for the Sparkfun Pro Micro RP2040"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal.git"

View file

@ -1,4 +1,4 @@
# [pro-micro-rp2040] - Board Support for the [Sparkfun Pro Micro RP2040]
# [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][Raspberry Silicon RP2040]
@ -8,7 +8,7 @@ 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.
[Sparkfun Pro Micro RP2040]: https://www.sparkfun.com/products/18288
[pro-micro-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/pro-micro-rp2040
[sparkfun-pro-micro-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/sparkfun-pro-micro-rp2040
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
@ -17,10 +17,10 @@ RP2040 chip according to how it is connected up on the Pro Micro RP2040.
To use this crate, your `Cargo.toml` file should contain:
```toml
pro-micro-rp2040 = { git = "https://github.com/rp-rs/rp-hal.git" }
sparkfun-pro-micro-rp2040 = "0.1.0"
```
In your program, you will need to call `pro_micro_rp2040::Pins::new` to create
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](./examples) folder for more details.
@ -31,7 +31,7 @@ devices. See the [examples](./examples) folder for more details.
To compile an example, clone the _rp-hal_ repository and run:
```console
rp-hal/boards/pro-micro-rp2040 $ cargo build --release --example <name>
rp-hal/boards/sparkfun-pro-micro-rp2040 $ cargo build --release --example <name>
```
You will get an ELF file called
@ -45,7 +45,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:
```console
rp-hal/boards/pro-micro-rp2040 $ cargo run --release --example <name>
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:
@ -54,7 +54,7 @@ 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](./examples/pro_micro_rainbow.rs)
### [Rainbow](./examples/sparkfun_pro_micro_rainbow.rs)
This example will display a colour-wheel rainbow effect on the on-board LED.

View file

@ -14,7 +14,7 @@ use embedded_hal::timer::CountDown;
use embedded_time::duration::Extensions;
use panic_halt as _;
use pro_micro_rp2040::{
use sparkfun_pro_micro_rp2040::{
hal::{
clocks::{init_clocks_and_plls, Clock},
pac,
@ -56,7 +56,7 @@ fn main() -> ! {
let sio = Sio::new(pac.SIO);
let pins = pro_micro_rp2040::Pins::new(
let pins = sparkfun_pro_micro_rp2040::Pins::new(
pac.IO_BANK0,
pac.PADS_BANK0,
sio.gpio_bank0,

View file

@ -35,7 +35,7 @@
//! ```
//!
//! See [examples/adc.rs](https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal/examples/adc.rs) and
//! [pico_explorer_showcase.rs](https://github.com/rp-rs/rp-hal/tree/main/boards/pico_explorer/examples/pico_explorer_showcase.rs) for more complete examples
//! [pimoroni_pico_explorer_showcase.rs](https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni_pico_explorer/examples/pimoroni_pico_explorer_showcase.rs) for more complete examples
use hal::adc::{Channel, OneShot};
use pac::{ADC, RESETS};