1376 - I2C runtime ISR binding example update (#1516)

* 1376 - I2C runtime ISR binding example update. After #1376 the reference example requires the extra Option<InterruptHadnler>, adding it to the doc example/snippet. Signed-off-by: Seb Ospina <[email protected]> * Update i2c doc example with interrupt_handler parameter Signed-off-by: Seb Ospina <[email protected]> * Upd read_base_mac_address vns get_mac_address example Signed-off-by: Seb Ospina <[email protected]> --------- Signed-off-by: Seb Ospina <[email protected]>
esp-rs · Apr 29, 2024 · c77b061 · c77b061
1 parent 0354880
commit c77b061
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 7 deletions.
diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md
@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Updated example on i2c to use the new `interrupt_handler` parameter (#1376)
 
 ### Added
 

diff --git a/esp-hal/src/i2c.rs b/esp-hal/src/i2c.rs
@@ -23,6 +23,7 @@
 //!     io.pins.gpio2,
 //!     100.kHz(),
 //!     &clocks,
+//!     None,
 //! );
 //! loop {
 //!     let mut data = [0u8; 22];

diff --git a/esp-hal/src/soc/esp32/efuse/mod.rs b/esp-hal/src/soc/esp32/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",

diff --git a/esp-hal/src/soc/esp32c2/efuse/mod.rs b/esp-hal/src/soc/esp32c2/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",

diff --git a/esp-hal/src/soc/esp32c3/efuse/mod.rs b/esp-hal/src/soc/esp32c3/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",

diff --git a/esp-hal/src/soc/esp32c6/efuse/mod.rs b/esp-hal/src/soc/esp32c6/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",

diff --git a/esp-hal/src/soc/esp32h2/efuse/mod.rs b/esp-hal/src/soc/esp32h2/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",

diff --git a/esp-hal/src/soc/esp32s2/efuse/mod.rs b/esp-hal/src/soc/esp32s2/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",

diff --git a/esp-hal/src/soc/esp32s3/efuse/mod.rs b/esp-hal/src/soc/esp32s3/efuse/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ### Read chip's MAC address from the eFuse storage.
 //! ```no_run
-//! let mac_address = Efuse::get_mac_address();
+//! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(
 //!     serial_tx,
 //!     "MAC: {:#X}:{:#X}:{:#X}:{:#X}:{:#X}:{:#X}",