mirrors
/
pimoroni-pico
mirror of https://github.com/pimoroni/pimoroni-pico.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #244 from pimoroni/helgibbons-update-readme 

Tweak readme links
This commit is contained in:
Philip Howard 2022-02-07 10:07:59 +00:00 committed by GitHub
parent 91b3ffb7d8 e4706277ce
commit 9b825e5b94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -2,7 +2,7 @@
Welcome to the brave new world of Pico!
This repository contains the C/C++ and MicroPython libraries for our range of RP2040-based boards, Raspberry Pi Pico addons & [supported Breakout Garden sensors](#supported-breakouts).
This repository contains the C/C++ and MicroPython libraries for our range of RP2040-based boards, Raspberry Pi Pico addons & [supported Breakout Garden sensors](#breakouts).
[![CMake Build Status](https://img.shields.io/github/workflow/status/pimoroni/pimoroni-pico/CMake?label=C%2B%2B)](https://github.com/pimoroni/pimoroni-pico/actions/workflows/cmake.yml)
[![MicroPython Build Status](https://img.shields.io/github/workflow/status/pimoroni/pimoroni-pico/MicroPython?label=MicroPython)](https://github.com/pimoroni/pimoroni-pico/actions/workflows/micropython.yml)
@ -15,16 +15,16 @@ This repository contains the C/C++ and MicroPython libraries for our range of RP
- [C/C++](#cc)
- [C++ Examples](#c-examples)
- [Boilerplate for C++ Projects](#boilerplate-for-c-projects)
- [Supported Breakouts](#supported-breakouts)
- [Supported Products](#supported-products)
- [Tutorials & Guides](#tutorials--guides)
# MicroPython
The easiest way to get started. If you're new to Pico, we recommend you read our [getting started with Pico](https://learn.pimoroni.com/article/getting-started-with-pico) tutorial.
:warning: all of our MicroPython libraries are baked into a batteries-included, custom version of MicroPython which you can grab from releases: [https://github.com/pimoroni/pimoroni-pico/releases/latest/](https://github.com/pimoroni/pimoroni-pico/releases/latest/)
:warning: All of our MicroPython libraries are baked into a batteries-included, custom version of MicroPython which you can grab from releases: [https://github.com/pimoroni/pimoroni-pico/releases/latest/](https://github.com/pimoroni/pimoroni-pico/releases/latest/)
New releases are issued regularly with new libraries, bugfixes to our existing libraries and new features inherited from MicroPython upstream. Be sure to check back!
New releases are issued regularly with new libraries, bug fixes to our existing libraries and new features inherited from MicroPython upstream. Be sure to check back!
* :link: [Tutorial: Getting started with Pico](https://learn.pimoroni.com/article/getting-started-with-pico)
* [Readme: Instructions for setting up MicroPython](setting-up-micropython.md)
@ -34,8 +34,7 @@ New releases are issued regularly with new libraries, bugfixes to our existing l
You can find MicroPython examples for supported sensors, packs and bases in the "micropython/examples" directory:
* [micropython/examples](MicroPython Examples)
* [MicroPython Examples](micropython/examples)
# C/C++
@ -48,7 +47,7 @@ For more advanced users that want to unleash the full power of Pico, you can use
You can find examples for supported sensors, packs and bases in the "examples" directory:
* [examples](C++ Examples)
* [C++ Examples](examples)
## Boilerplate for C++ Projects
@ -58,7 +57,28 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
* [Pimoroni Pico SDK Boilerplate](https://github.com/pimoroni/pico-boilerplate)
# Supported Breakouts
# Supported Products
## Packs and Bases
* Pico Display Pack - https://shop.pimoroni.com/products/pico-display-pack
* Pico Scroll Pack - https://shop.pimoroni.com/products/pico-scroll-pack
* Pico Explorer Base - https://shop.pimoroni.com/products/pico-explorer-base
* Pico RGB Keypad Base - https://shop.pimoroni.com/products/pico-rgb-keypad-base
* Pico Unicorn Pack - https://shop.pimoroni.com/products/pico-unicorn-pack
* Pico Audio Pack (C++ only) - https://shop.pimoroni.com/products/pico-audio-pack
* Pico Wireless Pack - https://shop.pimoroni.com/products/pico-wireless-pack
* Pico Display 2.0 - https://shop.pimoroni.com/products/pico-display-pack-2-0
## SHIMs
* Pico LiPo SHIM - https://shop.pimoroni.com/products/pico-lipo-shim
## RP2040 Boards
* Plasma 2040 - https://shop.pimoroni.com/products/plasma-2040
* Interstate 75 - HUB75 driver https://shop.pimoroni.com/products/interstate-75
## Breakouts
* AS7262 - 6-channel Spectral Sensor - https://shop.pimoroni.com/products/as7262-6-channel-spectral-sensor-spectrometer-breakout
* MSA301 - 3DoF Motion Sensor - https://shop.pimoroni.com/products/msa301-3dof-motion-sensor-breakout
@ -66,20 +86,19 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
* RGB Potentiometer - https://shop.pimoroni.com/products/rgb-potentiometer-breakout
* RGB Encoder - https://shop.pimoroni.com/products/rgb-encoder-breakout
* IO Expander - https://shop.pimoroni.com/products/io-expander
* RV3028 - RTC - https://shop.pimoroni.com/products/rv3028-real-time-clock-rtc-breakout
* RV3028 - Real-Time Clock (RTC) - https://shop.pimoroni.com/products/rv3028-real-time-clock-rtc-breakout
* ST7735 - 0.96" LCD - https://shop.pimoroni.com/products/0-96-spi-colour-lcd-160x80-breakout
* IS31FL3730 - LTP-305 dual matrix breakout - https://shop.pimoroni.com/products/led-dot-matrix-breakout?variant=32274405654611
* IS31FL3730 - dual LTP-305 LED matrices - https://shop.pimoroni.com/products/led-dot-matrix-breakout
* LTR559 - Proximity/Presence/Light Sensor - https://shop.pimoroni.com/products/ltr-559-light-proximity-sensor-breakout
* IS31FL3731 - 11x7 and 5x5 matrix displays
- https://shop.pimoroni.com/products/11x7-led-matrix-breakout
- https://shop.pimoroni.com/products/5x5-rgb-matrix-breakout
* TrackBall - https://shop.pimoroni.com/products/trackball-breakout
* Trackball - https://shop.pimoroni.com/products/trackball-breakout
* SGP30 - Air Quality Sensor - https://shop.pimoroni.com/products/sgp30-air-quality-sensor-breakout
* ST7789 - 1.3" LCD, 1.54" LCD and 1.3" round LCD
- https://shop.pimoroni.com/products/1-3-spi-colour-lcd-240x240-breakout
- https://shop.pimoroni.com/products/1-3-spi-colour-round-lcd-240x240-breakout
- https://shop.pimoroni.com/products/1-54-spi-colour-square-lcd-240x240-breakout
- Pico Display 2.0"
* BME680 - Temperature, Pressure, Humidity & Gas Sensor - https://shop.pimoroni.com/products/bme680-breakout
* BME688 - Temperature, Pressure, Humidity & Gas Sensor - https://shop.pimoroni.com/products/bme688-breakout
* BH1745 - Luminance & Colour Sensor - https://shop.pimoroni.com/products/bh1745-luminance-and-colour-sensor-breakout
@ -87,9 +106,7 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
* BMP280 - Temperature & Pressure Sensor - https://shop.pimoroni.com/products/bmp280-breakout-temperature-pressure-altitude-sensor
* PWM3901/PAA5100JE - Near Optical Flow Sensor - https://shop.pimoroni.com/products/paa5100je-optical-tracking-spi-breakout
* ICP10125 - High Accuracy Pressure / Altitude / Temperature Sensor - https://shop.pimoroni.com/products/icp10125-air-pressure-breakout
* Interstate 75 - HUB75 driver https://shop.pimoroni.com/products/interstate-75
* Plasma 2040 - https://shop.pimoroni.com/products/plasma-2040
* SCD40 - TBC
* SCD41 CO2 Sensor (Carbon Dioxide / Temperature / Humidity) - https://shop.pimoroni.com/products/scd41-co2-sensor-breakout
# Tutorials & Guides
@ -98,4 +115,4 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
- :link: [Pico C++ Development on Windows / WSL](https://learn.pimoroni.com/article/pico-development-using-wsl)
- :link: [Getting Started with Interstate 75](https://learn.pimoroni.com/article/getting-started-with-interstate-75)
- :link: [Getting Started with Plasma 2040](https://learn.pimoroni.com/article/plasma-2040)
- :link: [Assembling Keybow 2040](https://learn.pimoroni.com/article/assembling-keybow-2040)
- :link: [Assembling Keybow 2040](https://learn.pimoroni.com/article/assembling-keybow-2040)