third_party/pigweed/repo/pw_i2c/docs.rst

   1 .. _module-pw_i2c:
   2
   3 ------
   4 pw_i2c
   5 ------
   6
   7 .. warning::
   8   This module is under construction, not ready for use, and the documentation
   9   is incomplete.
  10
  11 pw_i2c contains interfaces and utility functions for using I2C.
  12
  13 Features
  14 ========
  15
  16 pw::i2c::Initiator
  17 ------------------
  18 The common interface for initiating transactions with devices on an I2C bus.
  19 Other documentation sources may call this style of interface an I2C "master",
  20 "central" or "controller".