# `Wafer.Conn`
[🔗](https://harton.dev/james/wafer/src/branch/main/lib/wafer/conn.ex#L1)

Defines a behaviour for connecting to a peripheral.

This behaviour is used by all the driver types in `Wafer` and you should
implement it for your devices also.

## Example

Implementing `Conn` for a `HTS221` chip connected via Circuits' I2C driver.

```elixir
defmodule HTS221 do
  defstruct ~w[conn]a
  alias Wafer.Driver.Circuits.I2C, as: Driver
  @behaviour Wafer.Conn
  @default_bus "i2c-1"
  @default_address 0x5F

  def acquire(opts) when is_list(opts) do
    bus = Keyword.get(opts, :bus, @default_bus)
    address = Keyword.get(opts, :address, @default_address)
    with {:ok, conn} <- Driver.acquire(bus_name: bus, address: address),
        do: {:ok, %HTS221{conn: conn}}
  end
end
```

# `option`

```elixir
@type option() :: {atom(), any()}
```

# `options`

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

# `t`

```elixir
@type t() :: any()
```

# `acquire`

```elixir
@callback acquire(options()) :: {:ok, t()} | {:error, reason :: any()}
```

Acquire a connection to a peripheral using the provided driver.

---

*Consult [api-reference.md](api-reference.md) for complete listing*