# SPDX-FileCopyrightText: 2018 Frank Hunleth, Mark Sebald, Matt Ludwigs
#
# SPDX-License-Identifier: Apache-2.0
defmodule Circuits.GPIO do
@moduledoc """
Control GPIOs from Elixir
See the [Readme](README.md) for a tutorial and the [porting guide](PORTING.md)
if updating from Circuits.GPIO v1.x.
Simple example:
```elixir
# GPIO 2 is connected to GPIO 3
iex> {:ok, my_output_gpio} = Circuits.GPIO.open({"gpiochip0", 2}, :output)
iex> {:ok, my_input_gpio} = Circuits.GPIO.open({"gpiochip0", 3}, :input)
iex> Circuits.GPIO.write(my_output_gpio, 1)
:ok
iex> Circuits.GPIO.read(my_input_gpio)
1
iex> Circuits.GPIO.close(my_output_gpio)
iex> Circuits.GPIO.close(my_input_gpio)
```
"""
alias Circuits.GPIO.Handle
require Logger
@typedoc """
Backends specify an implementation of a Circuits.GPIO.Backend behaviour
The second parameter of the Backend 2-tuple is a list of options. These are
passed to the behaviour function call implementations.
"""
@type backend() :: {module(), keyword()}
@typedoc """
GPIO controller
GPIO controllers manage one or more GPIO lines. They're referred to by
strings. For example, you'll mostly see `"gpiochip0"`, etc. but they could be
anything or even empty strings there's no reason to differentiate controllers
on a device.
"""
@type controller() :: String.t()
@typedoc """
GPIO line offset on a controller
GPIOs are numbered based on how they're connected to a controller. The
details are controller specific, but usually the first one is `0`, then `1`,
etc.
"""
@type line_offset() :: non_neg_integer()
@typedoc """
A GPIO controller or line label
Labels provide aliases for GPIO lines and controllers. They're
system-specific. On Linux, labels are provided in device tree files.
"""
@type label() :: String.t()
@typedoc """
An identifier for a GPIO
Call `Circuits.GPIO.enumerate/0` to see what GPIOs are available on your
device. Several ways exist to refer to GPIOs due to variations in devices and
programmer preference.
Options:
1. `index` - Many examples exist where GPIOs are referred to by a GPIO
number. There are issues with this strategy since GPIO indices can change.
It is so common that it's still supported. Prefer other ways when you're
able to change code.
2. `{controller, line_offset}` - Specify a line on a specific GPIO
controller. E.g., `{"gpiochip0", 10}`
3. `label` - Specify a GPIO line label. The first controller that has a
matching line is used. This lets you move the mapping of GPIOs to
peripheral connections to a device tree file or other central place. E.g.,
`"LED_ENABLE"`
4. `{label, label}` - Specify both GPIO controller and line labels. E.g.,
`{"primary-gpios", "PIO4"}`
"""
@type gpio_spec() ::
non_neg_integer() | {controller(), line_offset()} | label() | {label(), label()}
@typedoc "The GPIO direction (input or output)"
@type direction() :: :input | :output
@typedoc "GPIO logic value (low = 0 or high = 1)"
@type value() :: 0 | 1
@typedoc "Trigger edge for pin change notifications"
@type trigger() :: :rising | :falling | :both | :none
@typedoc "Pull mode for platforms that support controllable pullups and pulldowns"
@type pull_mode() :: :not_set | :none | :pullup | :pulldown
@typedoc """
Options for `open/3`
"""
@type open_options() :: [initial_value: value(), pull_mode: pull_mode()]
@typedoc """
Options for `set_interrupt/2`
"""
@type interrupt_options() :: [suppress_glitches: boolean(), receiver: pid() | atom()]
# Public API
@doc """
Open a GPIO
`gpio_spec` should be a valid GPIO pin number on the system and `direction`
should be `:input` or `:output`. If opening as an output, then be sure to set
the `:initial_value` option if you need the set to be glitch free.
If you're having trouble, see `enumerate/0` for available `gpio_spec`'s.
`Circuits.GPIO.Diagnostics` might also be helpful.
Options:
* :initial_value - Set to `0` or `1`. Only used for outputs. Defaults to `0`.
* :pull_mode - Set to `:not_set`, `:pullup`, `:pulldown`, or `:none` for an
input pin. `:not_set` is the default.
Returns `{:ok, handle}` on success.
"""
@spec open(gpio_spec(), direction(), open_options()) :: {:ok, Handle.t()} | {:error, atom()}
def open(gpio_spec, direction, options \\ []) do
check_options!(options)
{backend, backend_defaults} = default_backend()
all_options =
backend_defaults
|> Keyword.merge(options)
|> Keyword.put_new(:initial_value, 0)
|> Keyword.put_new(:pull_mode, :not_set)
backend.open(gpio_spec, direction, all_options)
end
defp check_options!([]), do: :ok
defp check_options!([{:initial_value, value} | rest]) do
case value do
0 -> :ok
1 -> :ok
:not_set -> Logger.warning("Circuits.GPIO no longer supports :not_set for :initial_value")
_ -> raise(ArgumentError, ":initial_value should be :not_set, 0, or 1")
end
check_options!(rest)
end
defp check_options!([{:pull_mode, value} | rest]) do
unless value in [:not_set, :pullup, :pulldown, :none],
do: raise(ArgumentError, ":pull_mode should be :not_set, :pullup, :pulldown, or :none")
check_options!(rest)
end
defp check_options!([_unknown_option | rest]) do
# Ignore unknown options - the backend might use them
check_options!(rest)
end
@doc """
Release the resources associated with a GPIO
This is optional. The garbage collector will free GPIO resources that aren't
in use, but this will free them sooner.
"""
@spec close(Handle.t()) :: :ok
defdelegate close(handle), to: Handle
@doc """
Read a GPIO's value
The value returned for GPIO's that are configured as outputs is undefined.
Backends may choose not to support this.
"""
@spec read(Handle.t()) :: value()
defdelegate read(handle), to: Handle
@doc """
Set the value of a GPIO
The GPIO must be configured as an output.
"""
@spec write(Handle.t(), value()) :: :ok
defdelegate write(handle, value), to: Handle
@doc """
Enable or disable GPIO value change notifications
Notifications are sent based on the trigger:
* :none - No notifications are sent
* :rising - Send a notification when the pin changes from 0 to 1
* :falling - Send a notification when the pin changes from 1 to 0
* :both - Send a notification on all changes
Available Options:
* `:suppress_glitches` - Not supported in Circuits.GPIO v2
* `:receiver` - Process which should receive the notifications.
Defaults to the calling process (`self()`)
Notification messages look like:
```
{:circuits_gpio, gpio_spec, timestamp, value}
```
Where `gpio_spec` is the gpio_spec passed to `open/3`, `timestamp` is an OS
monotonic timestamp in nanoseconds, and `value` is the new value.
Timestamps are not necessarily the same as from `System.monotonic_time/0`.
For example, with the cdev backend, they're applied by the Linux kernel or
can be come from a hardware timer. Erlang's monotonic time is adjusted so
it's not the same as OS monotonic time. The result is that these timestamps
can be compared with each other, but not with anything else.
Notifications only get
NOTE: You will need to store the `Circuits.GPIO` reference somewhere (like
your `GenServer`'s state) so that it doesn't get garbage collected. Event
messages stop when it gets collected. If you only get one message and you are
expecting more, this is likely the case.
"""
@spec set_interrupts(Handle.t(), trigger(), interrupt_options()) :: :ok | {:error, atom()}
defdelegate set_interrupts(handle, trigger, options \\ []), to: Handle
@doc """
Change the direction of the pin
"""
@spec set_direction(Handle.t(), direction()) :: :ok | {:error, atom()}
defdelegate set_direction(handle, direction), to: Handle
@doc """
Enable or disable an internal pull-up or pull-down resistor
"""
@spec set_pull_mode(Handle.t(), pull_mode()) :: :ok | {:error, atom()}
defdelegate set_pull_mode(gpio, pull_mode), to: Handle
@doc """
Get the GPIO pin number
This function is for Circuits.GPIO v1.0 compatibility. It is recommended to
use other ways of identifying GPIOs going forward. See `gpio_spec/0`.
"""
@spec pin(Handle.t()) :: non_neg_integer()
def pin(handle) do
info = Handle.info(handle)
info.pin_number
end
@doc """
Return info about the low level GPIO interface
This may be helpful when debugging issues.
"""
@spec info(backend() | nil) :: map()
def info(backend \\ nil)
def info(nil), do: info(default_backend())
def info({backend, _options}), do: backend.info()
@spec enumerate(backend() | nil) :: map()
def enumerate(backend \\ nil)
def enumerate(nil), do: enumerate(default_backend())
def enumerate({backend, _options}), do: backend.enumerate()
defp default_backend() do
case Application.get_env(:circuits_gpio, :default_backend) do
nil -> {Circuits.GPIO.NilBackend, []}
m when is_atom(m) -> {m, []}
{m, o} = value when is_atom(m) and is_list(o) -> value
end
end
end
