From 31e5b10ce500f5d62049d556a11a39547bc5b332 Mon Sep 17 00:00:00 2001 From: Frederik Menke Date: Sat, 6 Jul 2024 14:37:43 +0200 Subject: [PATCH] Use own repo --- Cargo.lock | 92 +++++++++++------------ Cargo.toml | 2 +- README.md | 213 +---------------------------------------------------- 3 files changed, 49 insertions(+), 258 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 27f3376..6f2993b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -119,6 +119,52 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" +[[package]] +name = "co2_sensing" +version = "0.1.0" +dependencies = [ + "byte-slice-cast 1.2.2", + "byteorder", + "cortex-m", + "cortex-m-rt", + "critical-section", + "cyw43", + "cyw43-pio", + "defmt", + "defmt-rtt", + "display-interface", + "display-interface-spi", + "embassy-embedded-hal", + "embassy-executor", + "embassy-futures", + "embassy-net-wiznet", + "embassy-rp", + "embassy-sync 0.6.0", + "embassy-time", + "embassy-usb", + "embassy-usb-logger", + "embedded-graphics", + "embedded-hal 1.0.0", + "embedded-hal-async", + "embedded-hal-bus", + "embedded-io-async", + "embedded-sdmmc", + "embedded-storage", + "fixed", + "fixed-macro", + "heapless 0.8.0", + "log", + "panic-probe", + "pio", + "pio-proc", + "portable-atomic", + "rand", + "smart-leds", + "st7789", + "static_cell", + "usbd-hid", +] + [[package]] name = "codespan-reporting" version = "0.11.1" @@ -485,52 +531,6 @@ dependencies = [ "rp2040-boot2", ] -[[package]] -name = "embassy-rp-skeleton" -version = "0.1.0" -dependencies = [ - "byte-slice-cast 1.2.2", - "byteorder", - "cortex-m", - "cortex-m-rt", - "critical-section", - "cyw43", - "cyw43-pio", - "defmt", - "defmt-rtt", - "display-interface", - "display-interface-spi", - "embassy-embedded-hal", - "embassy-executor", - "embassy-futures", - "embassy-net-wiznet", - "embassy-rp", - "embassy-sync 0.6.0", - "embassy-time", - "embassy-usb", - "embassy-usb-logger", - "embedded-graphics", - "embedded-hal 1.0.0", - "embedded-hal-async", - "embedded-hal-bus", - "embedded-io-async", - "embedded-sdmmc", - "embedded-storage", - "fixed", - "fixed-macro", - "heapless 0.8.0", - "log", - "panic-probe", - "pio", - "pio-proc", - "portable-atomic", - "rand", - "smart-leds", - "st7789", - "static_cell", - "usbd-hid", -] - [[package]] name = "embassy-sync" version = "0.3.0" diff --git a/Cargo.toml b/Cargo.toml index c83203c..e61a61e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "embassy-rp-skeleton" +name = "co2_sensing" version = "0.1.0" edition = "2021" diff --git a/README.md b/README.md index c67adf3..338204e 100644 --- a/README.md +++ b/README.md @@ -1,212 +1,3 @@ - -

- -

Embassy RP Skeleton

-

+# co2_sensing -The **Embassy RP Skeleton** repository is a project template intended as a starting point for developing your own -firmware for the [`rp2040`][1] based on the [`embassy`][2] asynchronous embedded development framework for [Rust][3]. - -It includes all of the [`knurling-rs`][4] tooling ([`defmt`][5], [`defmt-rtt`][5], [`panic-probe`][5], [`flip-link`][6], -[`probe-run`][7]) to enhance the embedded development process. - -The default [`cargo`][8] runner is configured as [`probe-run`][7], so you can build, flash and run your firmware _with_ -output from the device via a [`probe-rs`][9] compatible debug probe with the command: - -```shell -$ cargo run -``` - -If you want to use a different runner with your debugger (e.g., [`cargo-embed`][10], [`probe-rs-debugger`][11], etc.) or -if you _aren't_ using a debugger and want the runner to flash the firmware via USB (e.g., [`elf2uf2-rs`][12], -[`picotool`][13], etc.) then see: [Alternative Runners][14] - -## Table of Contents -1. [Requirements](#requirements) -2. [Setup](#setup) - 1. [System Setup](#system-setup) - 2. [Probe Setup](#probe-setup) - 3. [Hardware Setup](#hardware-setup) -3. [Usage](#usage) -6. [Appendix](#appendix) - -## Requirements -* Ubuntu -* Raspberry Pi Pico -* Debug Probe (*or* another Raspberry Pi Pico) -* Rust Toolchain ([`cargo`][8], [`rustup`][15]) - -## Setup -### System Setup -1. Install [Rust][3] and [`cargo`][8] using [`rustup`][15] -```shell -# Install `rustup` for Rust Toolchain -$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -``` - -2. Install Cortex-M Target Toolchain Support for [`Rust`][3] -```shell -# Install `thumbv6m-none-eabi` Target for `rp2040` -$ rustup target add thumbv6m-none-eabi -``` - -3. Install [`probe-run`][7] -```shell -# Install Linux Dependencies -$ sudo apt install -y libusb-1.0-0-dev libudev-dev - -# Install `probe-run` -$ cargo install probe-run - -# (Optional) Install `udev` Rules and Reload -$ sudo curl https://probe.rs/files/69-probe-rs.rules -o /etc/udev/rules.d/69-probe-rs.rules -$ sudo udevadm control --reload -$ sudo udevadm trigger - -# (Optional) Add User to `plugdev` Group -$ sudo usermod -aG plugdev $USER -``` - -4. Install [`flip-link`][6] -```shell -# Install `flip-link` -$ cargo install flip-link -``` - -### Probe Setup -You can use a Raspberry Pi Pico as a CMSIS-DAP debug probe. - -1. Download CMSIS-DAP debugger firmware [`DapperMime`][16] for the Raspberry Pi Pico -2. Boot the Raspberry Pi Pico in "Bootloader Mode" by holding the _BOOTSEL_ button while plugging it in -3. Open the mounted Raspberry Pi Pico storage device -4. Copy the `raspberry_pi_pico-DapperMime.uf2` onto the Raspberry Pi Pico -5. Firmware will be flashed to the Raspberry Pi Pico and it will disconnect - -Any [`probe-rs`][9] compatible debug probe can be used with [`probe-run`][7]. For a short list of alternative -compatible debug probes see: [Alternative Debug Probes][17]. - -### Hardware Setup -#### Connecting the Raspberry Pi Pico Debug Probe -The diagram below shows the wiring loom between Raspberry Pi Pico A (left) and Raspberry Pi Pico B (right), configuring -Raspberry Pi Pico A as a debug probe. - - -

- -

- -The connections shown in the diagram above are listed below. - -``` -Pico A GND -> Pico B GND -Pico A GP2 -> Pico B SWCLK -Pico A GP3 -> Pico B SWDIO -Pico A GP4/UART1 TX -> Pico B GP1/UART0 RX -Pico A GP5/UART1 RX -> Pico B GP0/UART0 TX -Pico A VSYS -> Pico B VSYS -``` - -For more information on connecting the two Raspberry Pi Picos, the wiring loom between them and its connections, see -the section _Appendix A > Wiring Loom_ in: [Getting Started with Raspberry Pi Pico][18] - -#### Raspberry Pi Pico Dev Board -Alternatively, a custom printed Raspberry Pi Pico Dev Board can be used to enhance development, which includes: - -* Debug Probe Host (Raspberry Pi Pico) -* Detachable Target (Raspberry Pi Pico) -* Serial Interface -* Reset Button -* Breakout Pins -* Selection of _VSys_ or _VBus_ Power Sources - -The custom printed Raspberry Pi Pico Dev board is shown below: - - -

- -

- -For more information on printing your own custom Raspberry Pi Pico Dev Board, see: -[Raspberry Pi Pico Dev Board][19] - -## Usage -#### Running -To run the firmware in debug mode: -```shell -$ cargo run -``` - -To run the firmware in release mode: -```shell -$ cargo run --release -``` - -#### Logging -To change the default [`defmt`][5] log level, see `.cargo/config.toml`: -```toml -[env] -DEFMT_LOG = "trace" -``` - -You can also set the log level inline: -```shell -$ DEFMT_LOG=debug cargo run -$ DEFMT_LOG=error cargo run --release -``` - -## Appendix -#### Documentation -* [Raspberry Pi Pico][1] -* [Rust][3] -* [Cargo][8] -* [Rustup][15] -* [Embassy][2] -* [Knurling-RS `defmt`][5] -* [Knurling-RS `flip-link`][6] -* [Knurling-RS `probe-run`][7] -* [Probe-RS `cargo-embed`][10] -* [Probe-RS `probe-rs-debugger`][11] -* [Raspberry Pi Pico `elf2uf2`][12] -* [Raspberry Pi Pico `picotool`][13] -* [CMSIS-DAP Firmware `DapperMime`][16] - -#### Resources -* [Rust Embedded Book][20] -* [Awesome Embedded Rust][21] -* [Getting Started with Raspberry Pi Pico][22] -* [Ferrous Systems Embedded Training][23] -* [Ferrous Systems Embedded Teaching Material][24] -* [RP-RS App Template][25] -* [RP-RS Alternative Debug Probes][17] -* [RP-RS Alternative Runners][14] -* [Knurling-RS App Template][4] -* [Probe-RS Probe Setup][9] -* [Raspberry Pi Pico Dev Board][19] - - - -[1]: https://www.raspberrypi.com/documentation/microcontrollers/rp2040.html -[2]: https://embassy.dev/dev/index.html -[3]: https://www.rust-lang.org/ -[4]: https://github.com/knurling-rs/app-template -[5]: https://github.com/knurling-rs/defmt -[6]: https://github.com/knurling-rs/flip-link -[7]: https://github.com/knurling-rs/probe-run -[8]: https://doc.rust-lang.org/cargo/ -[9]: https://probe.rs/docs/getting-started/probe-setup/ -[10]: https://github.com/probe-rs/cargo-embed -[11]: https://github.com/probe-rs/vscode -[12]: https://github.com/JoNil/elf2uf2-rs -[13]: https://github.com/raspberrypi/picotool -[14]: https://github.com/rp-rs/rp2040-project-template#alternative-runners -[15]: https://rustup.rs/ -[16]: https://github.com/majbthrd/DapperMime -[17]: https://github.com/rp-rs/rp2040-project-template/blob/main/debug_probes.md -[18]: https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#picoprobe-wiring-section -[19]: https://timsavage.github.io/rpi-pico-devboard/ -[20]: https://docs.rust-embedded.org/book/ -[21]: https://github.com/rust-embedded/awesome-embedded-rust -[22]: https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf -[23]: https://embedded-trainings.ferrous-systems.com/ -[24]: https://github.com/ferrous-systems/teaching-material -[25]: https://github.com/rp-rs/rp2040-project-template +Measuring the CO2 levels at a local club (with permission) \ No newline at end of file