itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-30 05:40:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update I2C module documentation (#3000)

Browse Source 
* feat: Avoid raw md link

* docs: Improve i2c master docs

* fix: Typo

Co-authored-by: Juraj Sadel <jurajsadel@gmail.com>

---------

Co-authored-by: Juraj Sadel <jurajsadel@gmail.com>
This commit is contained in:
Sergio Gasquez Arcos 2025-01-20 17:03:32 +01:00 committed by GitHub
parent d1ee2ba733
commit 9ab751f55f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
esp-hal/src/i2c/master/mod.rs
View File

@ -1,9 +1,16 @@
//! # Inter-Integrated Circuit (I2C) - Master mode //! # Inter-Integrated Circuit (I2C) - Master mode
//! //!
//! ## Overview
//!
//! In this mode, the I2C acts as master and initiates the I2C communication by
//! generating a START condition. Note that only one master is allowed to occupy
//! the bus to access one slave at the same time.
//!
//! ## Configuration //! ## Configuration
//! //!
//! Each I2C controller is individually configurable, and the usual setting //! Each I2C Master controller is individually configurable, and the usual
//! such as frequency, timeout, and SDA/SCL pins can easily be configured. //! setting such as frequency, timeout, and SDA/SCL pins can easily be
//! configured.
//! //!
//! ## Usage //! ## Usage
//! //!
@ -35,7 +42,8 @@
//! } //! }
//! # } //! # }
//! ``` //! ```
//! [`embedded-hal`]: https://docs.rs/embedded-hal/latest/embedded_hal/index.html //!
//! [`embedded-hal`]:embedded_hal
use core::marker::PhantomData; use core::marker::PhantomData;
#[cfg(not(esp32))] #[cfg(not(esp32))]

3
esp-hal/src/i2c/mod.rs
View File

@ -4,6 +4,9 @@
//! protocol that allows co-existence of multiple masters and slaves on the //! protocol that allows co-existence of multiple masters and slaves on the
//! same bus. I2C uses two bidirectional open-drain lines: serial data line //! same bus. I2C uses two bidirectional open-drain lines: serial data line
//! (SDA) and serial clock line (SCL), pulled up by resistors. //! (SDA) and serial clock line (SCL), pulled up by resistors.
//!
//! For more information, see
#![doc = crate::trm_markdown_link!("i2c")]
pub mod master; pub mod master;