diff --git a/Cargo.toml b/Cargo.toml index c624c96..670ef91 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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'] diff --git a/README.md b/README.md index d1f79dc..5cd7674 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/boards/kb2040/CHANGELOG.md b/boards/adafruit-feather-rp2040/CHANGELOG.md similarity index 66% rename from boards/kb2040/CHANGELOG.md rename to boards/adafruit-feather-rp2040/CHANGELOG.md index 1df8cdb..25f2848 100644 --- a/boards/kb2040/CHANGELOG.md +++ b/boards/adafruit-feather-rp2040/CHANGELOG.md @@ -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 diff --git a/boards/feather-rp2040/Cargo.toml b/boards/adafruit-feather-rp2040/Cargo.toml similarity index 88% rename from boards/feather-rp2040/Cargo.toml rename to boards/adafruit-feather-rp2040/Cargo.toml index 8746bda..0f3b6a3 100644 --- a/boards/feather-rp2040/Cargo.toml +++ b/boards/adafruit-feather-rp2040/Cargo.toml @@ -1,9 +1,9 @@ [package] -name = "feather-rp2040" +name = "adafruit-feather-rp2040" version = "0.1.0" authors = ["Andrea Nall "] 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" diff --git a/boards/feather-rp2040/README.md b/boards/adafruit-feather-rp2040/README.md similarity index 83% rename from boards/feather-rp2040/README.md rename to boards/adafruit-feather-rp2040/README.md index 8b8e5d7..9aabfce 100644 --- a/boards/feather-rp2040/README.md +++ b/boards/adafruit-feather-rp2040/README.md @@ -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 +rp-hal/boards/adafruit-feather-rp2040 $ cargo build --release --example ``` 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 +rp-hal/boards/adafruit-feather-rp2040 $ cargo run --release --example ``` 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. diff --git a/boards/feather-rp2040/examples/feather_blinky.rs b/boards/adafruit-feather-rp2040/examples/adafruit_feather_blinky.rs similarity index 97% rename from boards/feather-rp2040/examples/feather_blinky.rs rename to boards/adafruit-feather-rp2040/examples/adafruit_feather_blinky.rs index 1bd1516..762e78e 100644 --- a/boards/feather-rp2040/examples/feather_blinky.rs +++ b/boards/adafruit-feather-rp2040/examples/adafruit_feather_blinky.rs @@ -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, diff --git a/boards/feather-rp2040/examples/feather_neopixel_rainbow.rs b/boards/adafruit-feather-rp2040/examples/adafruit_feather_neopixel_rainbow.rs similarity index 98% rename from boards/feather-rp2040/examples/feather_neopixel_rainbow.rs rename to boards/adafruit-feather-rp2040/examples/adafruit_feather_neopixel_rainbow.rs index 0d0bc45..a56ba9a 100644 --- a/boards/feather-rp2040/examples/feather_neopixel_rainbow.rs +++ b/boards/adafruit-feather-rp2040/examples/adafruit_feather_neopixel_rainbow.rs @@ -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, diff --git a/boards/feather-rp2040/src/lib.rs b/boards/adafruit-feather-rp2040/src/lib.rs similarity index 100% rename from boards/feather-rp2040/src/lib.rs rename to boards/adafruit-feather-rp2040/src/lib.rs diff --git a/boards/adafruit-itsy-bitsy-rp2040/CHANGELOG.md b/boards/adafruit-itsy-bitsy-rp2040/CHANGELOG.md new file mode 100644 index 0000000..b54a3e8 --- /dev/null +++ b/boards/adafruit-itsy-bitsy-rp2040/CHANGELOG.md @@ -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 diff --git a/boards/itsy-bitsy-rp2040/Cargo.toml b/boards/adafruit-itsy-bitsy-rp2040/Cargo.toml similarity index 88% rename from boards/itsy-bitsy-rp2040/Cargo.toml rename to boards/adafruit-itsy-bitsy-rp2040/Cargo.toml index 99887c2..2304182 100644 --- a/boards/itsy-bitsy-rp2040/Cargo.toml +++ b/boards/adafruit-itsy-bitsy-rp2040/Cargo.toml @@ -1,9 +1,9 @@ [package] -name = "itsy-bitsy-rp2040" +name = "adafruit-itsy-bitsy-rp2040" version = "0.1.0" authors = ["Andrew Christiansen "] 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" diff --git a/boards/itsy-bitsy-rp2040/README.md b/boards/adafruit-itsy-bitsy-rp2040/README.md similarity index 82% rename from boards/itsy-bitsy-rp2040/README.md rename to boards/adafruit-itsy-bitsy-rp2040/README.md index 0212304..5d16b42 100644 --- a/boards/itsy-bitsy-rp2040/README.md +++ b/boards/adafruit-itsy-bitsy-rp2040/README.md @@ -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 +rp-hal/boards/adafruit-itsy-bitsy-rp2040 $ cargo build --release --example ``` 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 +rp-hal/boards/adafruit-itsy-bitsy-rp2040 $ cargo run --release --example ``` 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. diff --git a/boards/itsy-bitsy-rp2040/examples/itsy_bitsy_blinky.rs b/boards/adafruit-itsy-bitsy-rp2040/examples/adafruit_itsy_bitsy_blinky.rs similarity index 98% rename from boards/itsy-bitsy-rp2040/examples/itsy_bitsy_blinky.rs rename to boards/adafruit-itsy-bitsy-rp2040/examples/adafruit_itsy_bitsy_blinky.rs index 9f0ff70..5350994 100644 --- a/boards/itsy-bitsy-rp2040/examples/itsy_bitsy_blinky.rs +++ b/boards/adafruit-itsy-bitsy-rp2040/examples/adafruit_itsy_bitsy_blinky.rs @@ -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, diff --git a/boards/itsy-bitsy-rp2040/examples/itsy_bitsy_rainbow.rs b/boards/adafruit-itsy-bitsy-rp2040/examples/adafruit_itsy_bitsy_rainbow.rs similarity index 98% rename from boards/itsy-bitsy-rp2040/examples/itsy_bitsy_rainbow.rs rename to boards/adafruit-itsy-bitsy-rp2040/examples/adafruit_itsy_bitsy_rainbow.rs index 59d8cec..f9f71ae 100644 --- a/boards/itsy-bitsy-rp2040/examples/itsy_bitsy_rainbow.rs +++ b/boards/adafruit-itsy-bitsy-rp2040/examples/adafruit_itsy_bitsy_rainbow.rs @@ -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, diff --git a/boards/itsy-bitsy-rp2040/src/lib.rs b/boards/adafruit-itsy-bitsy-rp2040/src/lib.rs similarity index 100% rename from boards/itsy-bitsy-rp2040/src/lib.rs rename to boards/adafruit-itsy-bitsy-rp2040/src/lib.rs diff --git a/boards/feather-rp2040/CHANGELOG.md b/boards/adafruit-kb2040/CHANGELOG.md similarity index 68% rename from boards/feather-rp2040/CHANGELOG.md rename to boards/adafruit-kb2040/CHANGELOG.md index e47afdb..24cd4ec 100644 --- a/boards/feather-rp2040/CHANGELOG.md +++ b/boards/adafruit-kb2040/CHANGELOG.md @@ -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 diff --git a/boards/kb2040/Cargo.toml b/boards/adafruit-kb2040/Cargo.toml similarity index 82% rename from boards/kb2040/Cargo.toml rename to boards/adafruit-kb2040/Cargo.toml index 814a548..dcb29f4 100644 --- a/boards/kb2040/Cargo.toml +++ b/boards/adafruit-kb2040/Cargo.toml @@ -1,10 +1,10 @@ [package] -name = "kb2040" +name = "adafruit-kb2040" version = "0.1.0" authors = ["Andrew Christiansen "] 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" diff --git a/boards/kb2040/README.md b/boards/adafruit-kb2040/README.md similarity index 87% rename from boards/kb2040/README.md rename to boards/adafruit-kb2040/README.md index 1214629..808cb42 100644 --- a/boards/kb2040/README.md +++ b/boards/adafruit-kb2040/README.md @@ -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 +rp-hal/boards/adafruit-kb2040 $ cargo build --release --example ``` 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 +rp-hal/boards/adafruit-kb2040$ cargo run --release --example ``` 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. diff --git a/boards/kb2040/examples/kb2040_rainbow.rs b/boards/adafruit-kb2040/examples/adafruit_kb2040_rainbow.rs similarity index 97% rename from boards/kb2040/examples/kb2040_rainbow.rs rename to boards/adafruit-kb2040/examples/adafruit_kb2040_rainbow.rs index f62e1c5..d64dc39 100644 --- a/boards/kb2040/examples/kb2040_rainbow.rs +++ b/boards/adafruit-kb2040/examples/adafruit_kb2040_rainbow.rs @@ -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, diff --git a/boards/kb2040/src/lib.rs b/boards/adafruit-kb2040/src/lib.rs similarity index 100% rename from boards/kb2040/src/lib.rs rename to boards/adafruit-kb2040/src/lib.rs diff --git a/boards/adafruit-macropad/README.md b/boards/adafruit-macropad/README.md index 73af932..f4912da 100644 --- a/boards/adafruit-macropad/README.md +++ b/boards/adafruit-macropad/README.md @@ -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 diff --git a/boards/pico-explorer/CHANGELOG.md b/boards/adafruit-qt-py-rp2040/CHANGELOG.md similarity index 67% rename from boards/pico-explorer/CHANGELOG.md rename to boards/adafruit-qt-py-rp2040/CHANGELOG.md index d504396..799f4a7 100644 --- a/boards/pico-explorer/CHANGELOG.md +++ b/boards/adafruit-qt-py-rp2040/CHANGELOG.md @@ -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 diff --git a/boards/qt-py-rp2040/Cargo.toml b/boards/adafruit-qt-py-rp2040/Cargo.toml similarity index 88% rename from boards/qt-py-rp2040/Cargo.toml rename to boards/adafruit-qt-py-rp2040/Cargo.toml index 24a70aa..9acaef9 100644 --- a/boards/qt-py-rp2040/Cargo.toml +++ b/boards/adafruit-qt-py-rp2040/Cargo.toml @@ -1,9 +1,9 @@ [package] -name = "qt-py-rp2040" +name = "adafruit-qt-py-rp2040" version = "0.1.0" authors = ["Stephen Onnen "] 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" diff --git a/boards/qt-py-rp2040/README.md b/boards/adafruit-qt-py-rp2040/README.md similarity index 84% rename from boards/qt-py-rp2040/README.md rename to boards/adafruit-qt-py-rp2040/README.md index 5f27773..c3250d4 100644 --- a/boards/qt-py-rp2040/README.md +++ b/boards/adafruit-qt-py-rp2040/README.md @@ -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 +rp-hal/boards/adafruit-qt-py-rp2040 $ cargo build --release --example ``` 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 +rp-hal/boards/adafruit-qt-py-rp2040 $ cargo run --release --example ``` 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. diff --git a/boards/qt-py-rp2040/examples/qt_py_rainbow.rs b/boards/adafruit-qt-py-rp2040/examples/adafruit_qt_py_rp2040_rainbow.rs similarity index 98% rename from boards/qt-py-rp2040/examples/qt_py_rainbow.rs rename to boards/adafruit-qt-py-rp2040/examples/adafruit_qt_py_rp2040_rainbow.rs index f6d881f..e445d7e 100644 --- a/boards/qt-py-rp2040/examples/qt_py_rainbow.rs +++ b/boards/adafruit-qt-py-rp2040/examples/adafruit_qt_py_rp2040_rainbow.rs @@ -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, diff --git a/boards/qt-py-rp2040/src/lib.rs b/boards/adafruit-qt-py-rp2040/src/lib.rs similarity index 100% rename from boards/qt-py-rp2040/src/lib.rs rename to boards/adafruit-qt-py-rp2040/src/lib.rs diff --git a/boards/pico-lipo-16mb/CHANGELOG.md b/boards/pico-lipo-16mb/CHANGELOG.md deleted file mode 100644 index 28845e4..0000000 --- a/boards/pico-lipo-16mb/CHANGELOG.md +++ /dev/null @@ -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 diff --git a/boards/itsy-bitsy-rp2040/CHANGELOG.md b/boards/pimoroni-pico-explorer/CHANGELOG.md similarity index 66% rename from boards/itsy-bitsy-rp2040/CHANGELOG.md rename to boards/pimoroni-pico-explorer/CHANGELOG.md index 6945e08..e2e2069 100644 --- a/boards/itsy-bitsy-rp2040/CHANGELOG.md +++ b/boards/pimoroni-pico-explorer/CHANGELOG.md @@ -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 diff --git a/boards/pico-explorer/Cargo.toml b/boards/pimoroni-pico-explorer/Cargo.toml similarity index 88% rename from boards/pico-explorer/Cargo.toml rename to boards/pimoroni-pico-explorer/Cargo.toml index 3574405..b53f79f 100644 --- a/boards/pico-explorer/Cargo.toml +++ b/boards/pimoroni-pico-explorer/Cargo.toml @@ -1,9 +1,9 @@ [package] -name = "pico-explorer" +name = "pimoroni-pico-explorer" version = "0.1.0" authors = ["Hmvp "] 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" diff --git a/boards/pico-explorer/README.md b/boards/pimoroni-pico-explorer/README.md similarity index 83% rename from boards/pico-explorer/README.md rename to boards/pimoroni-pico-explorer/README.md index aa6ed50..7e96a36 100644 --- a/boards/pico-explorer/README.md +++ b/boards/pimoroni-pico-explorer/README.md @@ -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 +rp-hal/boards/pimoroni-pico-explorer $ cargo build --release --example ``` 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 +rp-hal/boards/pimoroni-pico-explorer $ cargo run --release --example ``` 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. diff --git a/boards/pico-explorer/examples/pico_explorer_showcase.rs b/boards/pimoroni-pico-explorer/examples/pimoroni_pico_explorer_showcase.rs similarity index 97% rename from boards/pico-explorer/examples/pico_explorer_showcase.rs rename to boards/pimoroni-pico-explorer/examples/pimoroni_pico_explorer_showcase.rs index 21dd0ce..72b2009 100644 --- a/boards/pico-explorer/examples/pico_explorer_showcase.rs +++ b/boards/pimoroni-pico-explorer/examples/pimoroni_pico_explorer_showcase.rs @@ -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 { diff --git a/boards/pico-explorer/src/lib.rs b/boards/pimoroni-pico-explorer/src/lib.rs similarity index 100% rename from boards/pico-explorer/src/lib.rs rename to boards/pimoroni-pico-explorer/src/lib.rs diff --git a/boards/pimoroni-pico-lipo-16mb/CHANGELOG.md b/boards/pimoroni-pico-lipo-16mb/CHANGELOG.md new file mode 100644 index 0000000..8ccb686 --- /dev/null +++ b/boards/pimoroni-pico-lipo-16mb/CHANGELOG.md @@ -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 diff --git a/boards/pico-lipo-16mb/Cargo.toml b/boards/pimoroni-pico-lipo-16mb/Cargo.toml similarity index 86% rename from boards/pico-lipo-16mb/Cargo.toml rename to boards/pimoroni-pico-lipo-16mb/Cargo.toml index ac688b9..d248a52 100644 --- a/boards/pico-lipo-16mb/Cargo.toml +++ b/boards/pimoroni-pico-lipo-16mb/Cargo.toml @@ -1,9 +1,9 @@ [package] -name = "pico-lipo-16mb" +name = "pimoroni-pico-lipo-16mb" version = "0.1.0" authors = ["Hmvp "] 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" diff --git a/boards/pico-lipo-16mb/README.md b/boards/pimoroni-pico-lipo-16mb/README.md similarity index 84% rename from boards/pico-lipo-16mb/README.md rename to boards/pimoroni-pico-lipo-16mb/README.md index e3f709d..0c8055d 100644 --- a/boards/pico-lipo-16mb/README.md +++ b/boards/pimoroni-pico-lipo-16mb/README.md @@ -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 +rp-hal/boards/pimoroni-pico-lipo-16mb $ cargo build --release --example ``` 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 +rp-hal/boards/pimoroni-pico-lipo-16mb $ cargo run --release --example ``` 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. diff --git a/boards/pico-lipo-16mb/examples/pico_lipo_16mb_blinky.rs b/boards/pimoroni-pico-lipo-16mb/examples/pimoroni_pico_lipo_16mb_blinky.rs similarity index 91% rename from boards/pico-lipo-16mb/examples/pico_lipo_16mb_blinky.rs rename to boards/pimoroni-pico-lipo-16mb/examples/pimoroni_pico_lipo_16mb_blinky.rs index 48a1059..9674e9d 100644 --- a/boards/pico-lipo-16mb/examples/pico_lipo_16mb_blinky.rs +++ b/boards/pimoroni-pico-lipo-16mb/examples/pimoroni_pico_lipo_16mb_blinky.rs @@ -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, diff --git a/boards/pico-lipo-16mb/src/lib.rs b/boards/pimoroni-pico-lipo-16mb/src/lib.rs similarity index 100% rename from boards/pico-lipo-16mb/src/lib.rs rename to boards/pimoroni-pico-lipo-16mb/src/lib.rs diff --git a/boards/pro-micro-rp2040/CHANGELOG.md b/boards/pro-micro-rp2040/CHANGELOG.md deleted file mode 100644 index b7babda..0000000 --- a/boards/pro-micro-rp2040/CHANGELOG.md +++ /dev/null @@ -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 diff --git a/boards/qt-py-rp2040/CHANGELOG.md b/boards/qt-py-rp2040/CHANGELOG.md deleted file mode 100644 index 230354d..0000000 --- a/boards/qt-py-rp2040/CHANGELOG.md +++ /dev/null @@ -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 diff --git a/boards/sparkfun-pro-micro-rp2040/CHANGELOG.md b/boards/sparkfun-pro-micro-rp2040/CHANGELOG.md new file mode 100644 index 0000000..04fbbeb --- /dev/null +++ b/boards/sparkfun-pro-micro-rp2040/CHANGELOG.md @@ -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 diff --git a/boards/pro-micro-rp2040/Cargo.toml b/boards/sparkfun-pro-micro-rp2040/Cargo.toml similarity index 88% rename from boards/pro-micro-rp2040/Cargo.toml rename to boards/sparkfun-pro-micro-rp2040/Cargo.toml index e719053..fbfb776 100644 --- a/boards/pro-micro-rp2040/Cargo.toml +++ b/boards/sparkfun-pro-micro-rp2040/Cargo.toml @@ -1,9 +1,9 @@ [package] -name = "pro-micro-rp2040" +name = "sparkfun-pro-micro-rp2040" version = "0.1.0" authors = ["Wilfried Chauveau "] 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" diff --git a/boards/pro-micro-rp2040/README.md b/boards/sparkfun-pro-micro-rp2040/README.md similarity index 85% rename from boards/pro-micro-rp2040/README.md rename to boards/sparkfun-pro-micro-rp2040/README.md index 3682245..a1d57d6 100644 --- a/boards/pro-micro-rp2040/README.md +++ b/boards/sparkfun-pro-micro-rp2040/README.md @@ -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 +rp-hal/boards/sparkfun-pro-micro-rp2040 $ cargo build --release --example ``` 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 +rp-hal/boards/sparkfun-pro-micro-rp2040 $ cargo run --release --example ``` 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. diff --git a/boards/pro-micro-rp2040/examples/pro_micro_rainbow.rs b/boards/sparkfun-pro-micro-rp2040/examples/sparkfun_pro_micro_rainbow.rs similarity index 97% rename from boards/pro-micro-rp2040/examples/pro_micro_rainbow.rs rename to boards/sparkfun-pro-micro-rp2040/examples/sparkfun_pro_micro_rainbow.rs index 55f1c37..5318de5 100644 --- a/boards/pro-micro-rp2040/examples/pro_micro_rainbow.rs +++ b/boards/sparkfun-pro-micro-rp2040/examples/sparkfun_pro_micro_rainbow.rs @@ -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, diff --git a/boards/pro-micro-rp2040/src/lib.rs b/boards/sparkfun-pro-micro-rp2040/src/lib.rs similarity index 100% rename from boards/pro-micro-rp2040/src/lib.rs rename to boards/sparkfun-pro-micro-rp2040/src/lib.rs diff --git a/rp2040-hal/src/adc.rs b/rp2040-hal/src/adc.rs index 54804c2..cb9fbae 100644 --- a/rp2040-hal/src/adc.rs +++ b/rp2040-hal/src/adc.rs @@ -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};