Add docs to all stm32f4 examples

examples/stm32f4/src/bin/adc.rs

@@ -8,6 +8,24 @@ use embassy_stm32::adc::{Adc, Temperature, VrefInt};
 use embassy_time::{Delay, Timer};
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/blinky.rs

@@ -7,6 +7,24 @@ use embassy_stm32::gpio::{Level, Output, Speed};
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/button.rs

@@ -6,6 +6,24 @@ use defmt::*;
 use embassy_stm32::gpio::{Input, Level, Output, Pull, Speed};
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[entry]
 fn main() -> ! {
     info!("Hello World!");

examples/stm32f4/src/bin/button_exti.rs

@@ -7,6 +7,24 @@ use embassy_stm32::exti::ExtiInput;
 use embassy_stm32::gpio::Pull;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/can.rs

@@ -20,6 +20,24 @@ bind_interrupts!(struct Irqs {
     CAN1_TX => TxInterruptHandler<CAN1>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     info!("Hello World!");

examples/stm32f4/src/bin/dac.rs

@@ -7,6 +7,24 @@ use embassy_stm32::dac::{DacCh1, Value};
 use embassy_stm32::dma::NoDma;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) -> ! {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/eth.rs

@@ -28,6 +28,24 @@ async fn net_task(stack: &'static Stack<Device>) -> ! {
     stack.run().await
 }
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(spawner: Spawner) -> ! {
     let mut config = Config::default();

examples/stm32f4/src/bin/eth_w5500.rs

@@ -35,6 +35,24 @@ async fn net_task(stack: &'static Stack<Device<'static>>) -> ! {
     stack.run().await
 }
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(spawner: Spawner) -> ! {
     let mut config = Config::default();

examples/stm32f4/src/bin/flash.rs

@@ -6,6 +6,24 @@ use embassy_executor::Spawner;
 use embassy_stm32::flash::{Blocking, Flash};
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/hello.rs

@@ -7,6 +7,24 @@ use embassy_stm32::Config;
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) -> ! {
     let config = Config::default();

examples/stm32f4/src/bin/i2c.rs

@@ -10,6 +10,24 @@ use {defmt_rtt as _, panic_probe as _};
 const ADDRESS: u8 = 0x5F;
 const WHOAMI: u8 = 0x0F;
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     info!("Hello world!");

examples/stm32f4/src/bin/i2c_async.rs

@@ -18,6 +18,24 @@ bind_interrupts!(struct Irqs {
     I2C1_ER => i2c::ErrorInterruptHandler<peripherals::I2C1>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     info!("Hello world!");

examples/stm32f4/src/bin/i2c_comparison.rs

@@ -43,6 +43,24 @@ fn a1454_buf_to_i16(buffer: &[u8; 4]) -> i16 {
     sensor_value
 }
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     info!("Setting up peripherals.");

examples/stm32f4/src/bin/i2s_dma.rs

@@ -10,6 +10,24 @@ use embassy_stm32::time::Hertz;
 use heapless::String;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/input_capture.rs

@@ -32,6 +32,24 @@ bind_interrupts!(struct Irqs {
     TIM2 => timer::CaptureCompareInterruptHandler<peripherals::TIM2>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/mco.rs

@@ -8,6 +8,24 @@ use embassy_stm32::rcc::{Mco, Mco1Source, Mco2Source, McoPrescaler};
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/multiprio.rs

@@ -121,6 +121,24 @@ unsafe fn UART5() {
     EXECUTOR_MED.on_interrupt()
 }
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[entry]
 fn main() -> ! {
     info!("Hello World!");

examples/stm32f4/src/bin/pwm.rs

@@ -10,6 +10,24 @@ use embassy_stm32::timer::Channel;
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/pwm_complementary.rs

@@ -11,6 +11,24 @@ use embassy_stm32::timer::Channel;
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/pwm_input.rs

@@ -31,6 +31,24 @@ bind_interrupts!(struct Irqs {
     TIM2 => timer::CaptureCompareInterruptHandler<peripherals::TIM2>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/rtc.rs

@@ -9,6 +9,24 @@ use embassy_stm32::Config;
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let config = Config::default();

examples/stm32f4/src/bin/sdmmc.rs

@@ -16,6 +16,24 @@ bind_interrupts!(struct Irqs {
     SDIO => sdmmc::InterruptHandler<peripherals::SDIO>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let mut config = Config::default();

examples/stm32f4/src/bin/spi.rs

@@ -8,6 +8,24 @@ use embassy_stm32::spi::{Config, Spi};
 use embassy_stm32::time::Hertz;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[entry]
 fn main() -> ! {
     info!("Hello World, dude!");

examples/stm32f4/src/bin/spi_dma.rs

@@ -11,6 +11,24 @@ use embassy_stm32::time::Hertz;
 use heapless::String;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/usart.rs

@@ -11,6 +11,24 @@ bind_interrupts!(struct Irqs {
     USART3 => usart::InterruptHandler<peripherals::USART3>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[entry]
 fn main() -> ! {
     info!("Hello World!");

examples/stm32f4/src/bin/usart_buffered.rs

@@ -12,6 +12,24 @@ bind_interrupts!(struct Irqs {
     USART3 => usart::BufferedInterruptHandler<peripherals::USART3>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/usart_dma.rs

@@ -14,6 +14,24 @@ bind_interrupts!(struct Irqs {
     USART3 => usart::InterruptHandler<peripherals::USART3>;
 });
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/usb_ethernet.rs

@@ -40,11 +40,30 @@ bind_interrupts!(struct Irqs {
     HASH_RNG => rng::InterruptHandler<peripherals::RNG>;
 });
 
-// If you are trying this and your USB device doesn't connect, the most
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
-// common issues are the RCC config and vbus_detection
+///
-//
+/// If you are using a different board or chip, make sure you update the following:
-// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+///
-// for more information.
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
+///
+/// If you are trying this and your USB device doesn't connect, the most
+/// common issues are the RCC config and vbus_detection
+///
+/// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+/// for more information.
 #[embassy_executor::main]
 async fn main(spawner: Spawner) {
     info!("Hello World!");

examples/stm32f4/src/bin/usb_hid_keyboard.rs

@@ -21,11 +21,30 @@ bind_interrupts!(struct Irqs {
     OTG_FS => usb::InterruptHandler<peripherals::USB_OTG_FS>;
 });
 
-// If you are trying this and your USB device doesn't connect, the most
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
-// common issues are the RCC config and vbus_detection
+///
-//
+/// If you are using a different board or chip, make sure you update the following:
-// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+///
-// for more information.
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
+///
+/// If you are trying this and your USB device doesn't connect, the most
+/// common issues are the RCC config and vbus_detection
+///
+/// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+/// for more information.
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let mut config = Config::default();

examples/stm32f4/src/bin/usb_hid_mouse.rs

@@ -18,11 +18,30 @@ bind_interrupts!(struct Irqs {
     OTG_FS => usb::InterruptHandler<peripherals::USB_OTG_FS>;
 });
 
-// If you are trying this and your USB device doesn't connect, the most
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
-// common issues are the RCC config and vbus_detection
+///
-//
+/// If you are using a different board or chip, make sure you update the following:
-// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+///
-// for more information.
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
+///
+/// If you are trying this and your USB device doesn't connect, the most
+/// common issues are the RCC config and vbus_detection
+///
+/// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+/// for more information.
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let mut config = Config::default();

examples/stm32f4/src/bin/usb_raw.rs

@@ -69,11 +69,30 @@ bind_interrupts!(struct Irqs {
     OTG_FS => usb::InterruptHandler<peripherals::USB_OTG_FS>;
 });
 
-// If you are trying this and your USB device doesn't connect, the most
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
-// common issues are the RCC config and vbus_detection
+///
-//
+/// If you are using a different board or chip, make sure you update the following:
-// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+///
-// for more information.
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
+///
+/// If you are trying this and your USB device doesn't connect, the most
+/// common issues are the RCC config and vbus_detection
+///
+/// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+/// for more information.
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     info!("Hello World!");

examples/stm32f4/src/bin/usb_serial.rs

@@ -16,11 +16,30 @@ bind_interrupts!(struct Irqs {
     OTG_FS => usb::InterruptHandler<peripherals::USB_OTG_FS>;
 });
 
-// If you are trying this and your USB device doesn't connect, the most
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
-// common issues are the RCC config and vbus_detection
+///
-//
+/// If you are using a different board or chip, make sure you update the following:
-// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+///
-// for more information.
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
+///
+/// If you are trying this and your USB device doesn't connect, the most
+/// common issues are the RCC config and vbus_detection
+///
+/// See https://embassy.dev/book/#_the_usb_examples_are_not_working_on_my_board_is_there_anything_else_i_need_to_configure
+/// for more information.
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     info!("Hello World!");

examples/stm32f4/src/bin/wdt.rs

@@ -8,6 +8,24 @@ use embassy_stm32::wdg::IndependentWatchdog;
 use embassy_time::Timer;
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let p = embassy_stm32::init(Default::default());

examples/stm32f4/src/bin/ws2812_pwm.rs

@@ -21,6 +21,24 @@ use embassy_stm32::timer::Channel;
 use embassy_time::{Duration, Ticker, Timer};
 use {defmt_rtt as _, panic_probe as _};
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: Spawner) {
     let mut device_config = embassy_stm32::Config::default();

examples/stm32f4/src/bin/ws2812_spi.rs

@@ -42,6 +42,24 @@ static DIM_WHITE: [u16; 25] = [
 
 static COLOR_LIST: &[&[u16]] = &[&TURN_OFF, &DIM_WHITE];
 
+/// This example is written for the nucleo-stm32f429zi, with a stm32f429zi chip.
+///
+/// If you are using a different board or chip, make sure you update the following:
+///
+/// * [ ] Update .cargo/config.toml with the correct `probe-rs run --chip STM32F429ZITx`chip name.
+/// * [ ] Update Cargo.toml to have the correct `embassy-stm32` feature, it is
+///       currently `stm32f429zi`.
+/// * [ ] If your board has a special clock or power configuration, make sure that it is
+///       set up appropriately.
+/// * [ ] If your board has different pin mapping, update any pin numbers or peripherals
+///       to match your schematic
+///
+/// If you are unsure, please drop by the Embassy Matrix chat for support, and let us know:
+///
+/// * Which example you are trying to run
+/// * Which chip and board you are using
+///
+/// Embassy Chat: https://matrix.to/#/#embassy-rs:matrix.org
 #[embassy_executor::main]
 async fn main(_spawner: embassy_executor::Spawner) {
     let mut device_config = embassy_stm32::Config::default();