Improve examples documentation (#533)

* docs: 📝 Doccument embassy I2C example

* docs: 📝 Improve documentation of embassy SPI example

* docs: 📝 Doccument AES and RSA example

* docs: 📝 Update changelog

CHANGELOG.md

@@ -23,6 +23,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - DMA is supported for SPI3 on ESP32-S3 (#507)
 - `change_bus_frequency` is now available on `SpiDma` (#529)
 
+### Changed
+- Improve examples documentation (#533)
+
 ## [0.9.0] - 2023-05-02
 
 ### Added

esp32-hal/examples/aes.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES
+
 #![no_std]
 #![no_main]
 use aes::{

esp32-hal/examples/embassy_i2c.rs

@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO32
+//! SCL    GPIO33
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]

esp32-hal/examples/embassy_spi.rs

@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO19
+//! MISO    GPIO25
+//! MOSI    GPIO23
+//! CS      GPIO22
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]

esp32-hal/examples/rsa.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 

esp32c2-hal/examples/embassy_i2c.rs

@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]

esp32c2-hal/examples/embassy_spi.rs

@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]

esp32c3-hal/examples/aes.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES
+
 #![no_std]
 #![no_main]
 use aes::{

esp32c3-hal/examples/embassy_i2c.rs

@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]

esp32c3-hal/examples/embassy_spi.rs

@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]

esp32c3-hal/examples/rsa.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 

esp32c6-hal/examples/aes.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES.
+
 #![no_std]
 #![no_main]
 use aes::{

esp32c6-hal/examples/embassy_i2c.rs

@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]

esp32c6-hal/examples/embassy_spi.rs

@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]

esp32c6-hal/examples/rsa.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 

esp32s2-hal/examples/aes.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES.
+
 #![no_std]
 #![no_main]
 use aes::{

esp32s2-hal/examples/embassy_i2c.rs

@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]

esp32s2-hal/examples/embassy_spi.rs

@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO36
+//! MISO    GPIO37
+//! MOSI    GPIO35
+//! CS      GPIO34
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]

esp32s2-hal/examples/rsa.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 

esp32s3-hal/examples/aes.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES.
+
 #![no_std]
 #![no_main]
 use aes::{

esp32s3-hal/examples/embassy_i2c.rs

@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]

esp32s3-hal/examples/embassy_spi.rs

@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]

esp32s3-hal/examples/rsa.rs

@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]