Skip to content

Commit

Permalink
Merge pull request #517 from jannic/move-boards
Browse files Browse the repository at this point in the history 
Move boards
  • Loading branch information
@jannic
jannic authored Dec 10, 2022
2 parents 06a6e18 + 69f34e8 commit 18ee0ed
Show file tree
Hide file tree
Showing 145 changed files with 12 additions and 15,995 deletions.
22 changes: 0 additions & 22 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,10 @@ resolver = "2"
members = [
"rp2040-hal",
"rp2040-hal-macros",
"boards/adafruit-feather-rp2040",
"boards/adafruit-itsy-bitsy-rp2040",
"boards/adafruit-kb2040",
"boards/adafruit-macropad",
"boards/adafruit-qt-py-rp2040",
"boards/adafruit-trinkey-qt2040",
"boards/arduino_nano_connect",
"boards/pimoroni-badger2040",
"boards/pimoroni-pico-explorer",
"boards/pimoroni-pico-lipo-16mb",
"boards/pimoroni-plasma-2040",
"boards/pimoroni-servo2040",
"boards/pimoroni-tiny2040",
"boards/rp-pico",
"boards/seeeduino-xiao-rp2040",
"boards/solderparty-rp2040-stamp",
"boards/sparkfun-pro-micro-rp2040",
"boards/sparkfun-thing-plus-rp2040",
"boards/vcc-gnd-yd-rp2040",
"boards/waveshare-rp2040-zero",
"boards/waveshare-rp2040-lcd-0-96",
]

[patch.'https://github.com/rp-rs/rp-hal.git']
rp2040-hal = { path = "./rp2040-hal" }

[patch.crates-io]
rp2040-hal = { path = "./rp2040-hal" }
i2c-pio = { git = "https://github.com/rp-rs/i2c-pio-rs" }
251 changes: 7 additions & 244 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ check out [pio-rs](https://github.com/rp-rs/pio-rs). You can even compile PIO
programs at run-time, on the RP2040 itself!

If you want to try out some examples on one of our supported boards, check out
the list of *Board Support Packages* below, and click through to see the various
the list of [*Board Support Packages*][BSPs], and click through to see the various
examples for each board.

Before trying any of the examples, please ensure you have the latest stable
Expand All @@ -78,8 +78,6 @@ cargo install probe-run

## Packages

This git repository is organised as a [Cargo Workspace].

There is a _Hardware Abstraction Layer_ (or HAL) crate for the RP2040 chip,
and _Board Support Package_ crates for a number of RP2040 based PCBs. If you
are writing code that should run on any microcontroller, consider using the
Expand Down Expand Up @@ -112,249 +110,14 @@ There are examples in this crate to show how to use various peripherals
(GPIO, I²C, SPI, UART, etc) but note that the pin-outs may not match any
particular board.

[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/

### [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.

[Raspberry Pi Pico]: https://www.raspberrypi.org/products/raspberry-pi-pico/
[rp-pico]: https://github.com/rp-rs/rp-hal/tree/main/boards/rp-pico

### [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.

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
[adafruit-feather-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-feather-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 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 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
[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

### [adafruit-trinkey-qt2040] - Board Support for the [Adafruit Trinkey QT2040]

You should include this crate if you are writing code that you want to run on
an [Adafruit Trinkey QT2040] - 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 Trinkey.

[Adafruit-Trinkey-QT2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-trinkey-qt2040
[adafruit trinkey qt2040]: https://www.adafruit.com/product/5056

### [pimoroni-badger2040] - Board Support for the [Pimoroni Badger2040]

You should include this crate if you are writing code that you want to run on
a [Pimoroni Badger2040] - a conference-style badge built around an e-paper
display and an rp2040

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

[Pimoroni Badger2040]: https://shop.pimoroni.com/products/badger-2040
[pimoroni-badger2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-badger2040

### [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 breakout board for the [Raspberry Pi Pico] featuring a small LCD screen, a
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/pimoroni-pico-explorer-base
[pimoroni-pico-explorer]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-pico-explorer

### [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,
plus a Li-Po battery charging circuit.

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 Lipo.

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
[pimoroni-pico-lipo-16mb]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-pico-lipo-16mb
### [BSPs] - Board support packages

### [pimoroni-plasma-2040] - Board Support for the [Pimoroni Plasma 2040]
There are BSPs for various boards based on the RP2040 avaialble in
a [separate repository][BSPs].

You should include this crate if you are writing code that you want to run on
a [Pimoroni Plasma 2040] - Swathe everything in rainbows with this all-in-one, USB-C powered controller
for WS2812/Neopixel and APA102/Dotstar addressable LED strip.

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

[Pimoroni Plasma 2040]: https://shop.pimoroni.com/products/plasma-2040
[pimoroni-plasma-2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-plasma-2040

### [pimoroni-servo2040] - Board Support for the [Pimoroni Servo2040]

You should include this crate if you are writing code that you want to run on
a [Pimoroni Servo2040] - a standalone servo motor controller for up to 18 servos
and 6 sensors.

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

[Pimoroni Servo2040]: https://shop.pimoroni.com/products/servo-2040
[pimoroni-servo2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-servo2040

### [pimoroni-tiny2040] - Board Support for the [Pimoroni Tiny2040]

You should include this crate if you are writing code that you want to run on
a [Pimoroni Tiny2040] - one of the first third party RP2040 boards available, with 8MB flash and a 3 colour LED.

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

[Pimoroni Tiny2040]: https://shop.pimoroni.com/products/tiny-2040
[pimoroni-tiny2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/pimoroni-tiny2040

### [solderparty-rp2040-stamp] - Board Support for the [SolderParty RP2040 Stamp]

You should include this crate if you are writing code that you want to run on
a [SolderParty RP2040 Stamp] - a square RP2040 board with castellated edges.

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

[SolderParty RP2040 Stamp]: https://www.solder.party/docs/rp2040-stamp/
[solderparty-rp2040-stamp]: https://github.com/rp-rs/rp-hal/tree/main/boards/solderparty-rp2040-stamp

### [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.

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
[sparkfun-pro-micro-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/sparkfun-pro-micro-rp2040

### [sparkfun-thing-plus-rp2040] - Board Support for the [Sparkfun Thing Plus RP2040]

You should include this crate if you are writing code that you want to run on
a [Sparkfun Thing Plus RP2040] - an RP2040 board with a Feather form factor, USB-C, and a WS2812B addressable LED.

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

[Sparkfun Thing Plus RP2040]: https://www.sparkfun.com/products/17745
[sparkfun-thing-plus-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/sparkfun-thing-plus-rp2040

### [arduino_nano_connect] - Board Support for the [Arduino Nano RP2040 Connect]

You should include this crate if you are writing code that you want to run on
an [Arduino Nano RP2040 Connect] - a development pcb with shortwave communication, IMU, and BLE package.

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

[Arduino Nano RP2040 Connect]: https://store-usa.arduino.cc/collections/boards/products/arduino-nano-rp2040-connect
[arduino_nano_connect]: https://github.com/rp-rs/rp-hal/tree/main/boards/arduino_nano_connect

### [seeeduino-xiao-rp2040] - Board Support for the [Seeeduino XIAO RP2040]

You should include this crate if you are writing code that you want to run on
a [Seeeduino XIAO RP2040] - a tiny board for wearable devices and small
projects.

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

[Seeeduino XIAO RP2040]: https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html
[seeeduino-xiao-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/seeeduino-xiao-rp2040

### [vcc-gnd-yd-rp2040] - Board Support for the [VCC-GND Studio YD-RP2040]

You should include this crate if you are writing code that you want to run on
a [VCC-GND Studio YD-RP2040] - a PCB for the RP2040 chip with USB-C port, WS2812 RGB LED on GPIO23, user key on GPIO24 and built-in blue LED.

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

[VCC-GND Studio YD-RP2040]: http://152.32.187.208:8080/yd-data/YD-RP2040/
[vcc-gnd-yd-rp2040]: https://github.com/rp-rs/rp-hal/tree/main/boards/vcc-gnd-yd-rp2040

### [waveshare-rp2040-zero] - Board Support for the [Waveshare RP2040 Zero]

You should include this crate if you are writing code that you want to run on
an [Waveshare RP2040 Zero] - a very small RP2040 breakout board with USB-C and a RGB led from Waveshare.

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.

[Waveshare RP2040 Zero]: https://www.waveshare.com/wiki/RP2040-Zero
[waveshare-rp2040-zero]: https://github.com/rp-rs/rp-hal/tree/main/boards/waveshare-rp2040-zero

### [waveshare-rp2040-lcd-0_96] - Board Support for the [Waveshare RP2040 LCD 0.96"]

You should include this crate if you are writing code that you want to run on
an [Waveshare RP2040 LCD 0.96"] - a very small RP2040 breakout board with USB-C,
a 65K IPS LCD 160x80, 16MBit Flash and 1A battery charger from Waveshare.

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.

[Waveshare RP2040 LCD 0.96"]: https://www.waveshare.com/wiki/RP2040-LCD-0.96
[waveshare-rp2040-lcd-0_96]: https://github.com/rp-rs/rp-hal/tree/main/boards/waveshare-rp2040-lcd-0_96
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
[BSPs]: https://github.com/rp-rs/rp-hal-boards/

<!-- PROGRAMMING -->
## Programming
Expand Down
33 changes: 0 additions & 33 deletions boards/adafruit-feather-rp2040/CHANGELOG.md
View file

This file was deleted.

51 changes: 0 additions & 51 deletions boards/adafruit-feather-rp2040/Cargo.toml
View file

This file was deleted.

Loading

0 comments on commit 18ee0ed

Please sign in to comment.