View Source Wafer.Driver.Circuits.I2C (wafer v1.1.0)

A connection to a chip via Circuits' I2C driver.

Implements the Wafer.Conn behaviour as well as the Wafer.Chip and Wafer.I2C protocols.

Summary

option()

options()

t()

acquire(opts)

Acquire a connection to a peripheral using the Circuits' I2C driver on the specified bus and address.

@type option() ::
  {:bus_name, binary()} | {:address, Wafer.I2C.address()} | {:force, boolean()}

@type options() :: [option()]

@type t() :: %Wafer.Driver.Circuits.I2C{
  address: Wafer.I2C.address(),
  bus: binary(),
  conn: Circuits.I2C.Bus.t()
}

@spec acquire(options()) :: {:ok, t()} | {:error, reason :: any()}

Acquire a connection to a peripheral using the Circuits' I2C driver on the specified bus and address.