@spec get_all_pwm(t()) :: {:ok, [{on :: 0..4095, off :: 0..4095}]} | {:error, term()}

Read all channels' PWM duty cycles.

@spec get_channel_pwm(t(), channel :: 0..15) ::
  {:ok, {on :: 0..4095, off :: 0..4095}} | {:error, term()}

Read a specific channel's PWM duty cycle.

@spec initialize(t(), frequency :: pos_integer(), oscillator_freq :: pos_integer()) ::
  {:ok, t()} | {:error, term()}

Initialise the PCA9685 device and set all outputs to off.

@spec read_mode1(Wafer.Conn.t()) :: {:ok, binary()} | {:error, reason :: any()}

Read the contents of the mode1 register.

Example

iex> read_mode1(conn)
{:ok, <<0>>}

@spec read_mode2(Wafer.Conn.t()) :: {:ok, binary()} | {:error, reason :: any()}

Read the contents of the mode2 register.

Example

iex> read_mode2(conn)
{:ok, <<0>>}

@spec read_prescale(Wafer.Conn.t()) :: {:ok, binary()} | {:error, reason :: any()}

Read the contents of the prescale register.

Example

iex> read_prescale(conn)
{:ok, <<0>>}

@spec set_all_pwm(t(), on :: 0..4095, off :: 0..4095) :: {:ok, t()} | {:error, term()}

Set all channels to the same PWM duty cycle.

@spec set_channel_pwm(t(), channel :: 0..15, on :: 0..4095, off :: 0..4095) ::
  {:ok, t()} | {:error, term()}

Set a specific channel's PWM duty cycle.

@spec set_pwm_frequency(t(), pos_integer(), oscillator_freq :: pos_integer()) ::
  {:ok, t()} | {:error, term()}

Set the PWM frequency in Hz.

@spec swap_mode1(Wafer.Conn.t(), data :: binary()) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Swap the contents of the mode1 register.

Reads the contents of the register, then replaces it, returning the previous contents. Some drivers may implement this atomically.

Example

iex> swap_mode1(conn, <<0>>)
{:ok, <<0>>, _conn}

@spec swap_mode2(Wafer.Conn.t(), data :: binary()) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Swap the contents of the mode2 register.

Reads the contents of the register, then replaces it, returning the previous contents. Some drivers may implement this atomically.

Example

iex> swap_mode2(conn, <<0>>)
{:ok, <<0>>, _conn}

@spec swap_prescale(Wafer.Conn.t(), data :: binary()) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Swap the contents of the prescale register.

Reads the contents of the register, then replaces it, returning the previous contents. Some drivers may implement this atomically.

Example

iex> swap_prescale(conn, <<0>>)
{:ok, <<0>>, _conn}

@spec update_mode1(Wafer.Conn.t(), (<<_::_*8>> -> <<_::_*8>>)) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Update the contents of the mode1 register using a transformation function.

Example

iex> transform = fn <<data::size(8)>> -> <<(data * 2)::size(8)>> end
...> update_mode1(conn, transform)
{:ok, _conn}

@spec update_mode2(Wafer.Conn.t(), (<<_::_*8>> -> <<_::_*8>>)) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Update the contents of the mode2 register using a transformation function.

Example

iex> transform = fn <<data::size(8)>> -> <<(data * 2)::size(8)>> end
...> update_mode2(conn, transform)
{:ok, _conn}

@spec update_prescale(Wafer.Conn.t(), (<<_::_*8>> -> <<_::_*8>>)) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Update the contents of the prescale register using a transformation function.

Example

iex> transform = fn <<data::size(8)>> -> <<(data * 2)::size(8)>> end
...> update_prescale(conn, transform)
{:ok, _conn}

@spec write_mode1(Wafer.Conn.t(), data :: binary()) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Write new contents to the mode1 register.

Example

iex> write_mode1(conn, <<0>>)
{:ok, _conn}

@spec write_mode2(Wafer.Conn.t(), data :: binary()) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Write new contents to the mode2 register.

Example

iex> write_mode2(conn, <<0>>)
{:ok, _conn}

@spec write_prescale(Wafer.Conn.t(), data :: binary()) ::
  {:ok, Wafer.Conn.t()} | {:error, reason :: any()}

Write new contents to the prescale register.

Example

iex> write_prescale(conn, <<0>>)
{:ok, _conn}