Update GPIO code to use gpio_specs

Author: fhunleth

config/config.exs

@@ -14,8 +14,8 @@ config :circuits_sim,
     {CircuitsSim.Device.SGP30, bus_name: "i2c-1", address: 0x58},
     {CircuitsSim.Device.BMP3XX, bus_name: "i2c-1", address: 0x77},
     {CircuitsSim.Device.TM1620, bus_name: "spidev0.0", render: :binary_clock},
-    {CircuitsSim.Device.GPIOLED, pin_spec: 10},
-    {CircuitsSim.Device.GPIOButton, pin_spec: 11}
+    {CircuitsSim.Device.GPIOLED, gpio_spec: 10},
+    {CircuitsSim.Device.GPIOButton, gpio_spec: 11}
   ]
 
 # Default to simulated versions of I2C, SPI, and GPIO

lib/circuits_sim.ex

@@ -46,11 +46,11 @@ defmodule CircuitsSim do
 
   defp gpio_info() do
     DeviceRegistry.bus_names(:gpio)
-    |> Enum.map(&pin_spec_info/1)
+    |> Enum.map(&gpio_spec_info/1)
   end
 
-  defp pin_spec_info(pin_spec) do
-    result = GPIOServer.render(pin_spec)
-    ["=== GPIO ", inspect(pin_spec), " ===\n", result]
+  defp gpio_spec_info(gpio_spec) do
+    result = GPIOServer.render(gpio_spec)
+    ["=== GPIO ", inspect(gpio_spec), " ===\n", result]
   end
 end

lib/circuits_sim/device/gpio_button.ex

@@ -44,18 +44,18 @@ defmodule CircuitsSim.Device.GPIOButton do
   Pass in a duration in milliseconds to automatically release the button after
   a timeout.
   """
-  @spec press(GPIO.pin_spec(), non_neg_integer() | :infinity) :: :ok
-  def press(pin_spec, duration \\ :infinity)
+  @spec press(GPIO.gpio_spec(), non_neg_integer() | :infinity) :: :ok
+  def press(gpio_spec, duration \\ :infinity)
       when duration == :infinity or (duration > 0 and duration < 10000) do
-    GPIOServer.send_message(pin_spec, {:press, duration})
+    GPIOServer.send_message(gpio_spec, {:press, duration})
   end
 
   @doc """
   Release the button
   """
-  @spec release(GPIO.pin_spec()) :: :ok
-  def release(pin_spec) do
-    GPIOServer.send_message(pin_spec, :release)
+  @spec release(GPIO.gpio_spec()) :: :ok
+  def release(gpio_spec) do
+    GPIOServer.send_message(gpio_spec, :release)
   end
 
   defimpl GPIODevice do

lib/circuits_sim/device_registry.ex

@@ -6,12 +6,13 @@ defmodule CircuitsSim.DeviceRegistry do
 
   @type type() :: :i2c | :spi | :gpio | :all
 
-  @spec via_name(type(), String.t() | GPIO.pin_spec(), I2C.address()) :: {:via, Registry, tuple()}
+  @spec via_name(type(), String.t() | GPIO.gpio_spec(), I2C.address()) ::
+          {:via, Registry, tuple()}
   def via_name(type, bus, address) do
     {:via, Registry, {CircuitSim.DeviceRegistry, {type, bus, address}}}
   end
 
-  @spec bus_names(type()) :: [String.t() | GPIO.pin_spec()]
+  @spec bus_names(type()) :: [String.t() | GPIO.gpio_spec()]
   def bus_names(type) do
     # The select returns [{{:i2c, "i2c-0", 32}}]
     Registry.select(CircuitSim.DeviceRegistry, [{{:"$1", :_, :_}, [], [{{:"$1"}}]}])

lib/circuits_sim/gpio/backend.ex

@@ -4,7 +4,6 @@ defmodule CircuitsSim.GPIO.Backend do
   """
   @behaviour Circuits.GPIO.Backend
 
-  alias Circuits.GPIO
   alias Circuits.GPIO.Backend
   alias CircuitsSim.DeviceRegistry
   alias CircuitsSim.GPIO.GPIOServer
@@ -14,25 +13,21 @@ defmodule CircuitsSim.GPIO.Backend do
   Open an GPIO handle
   """
   @impl Backend
-  def open(pin_spec, direction, options) do
-    if pin_spec in pin_specs(options) do
-      handle = %Handle{pin_spec: pin_spec}
-
-      with :ok <- GPIOServer.set_direction(pin_spec, direction),
-           :ok <- set_pull_mode(pin_spec, options[:pull_mode]),
-           :ok <- set_initial_value(pin_spec, options[:initial_value]) do
-        {:ok, handle}
-      end
-    else
-      {:error, "Unknown GPIO pin_spec #{inspect(pin_spec)}"}
+  def open(gpio_spec, direction, options) do
+    with {:ok, identifiers} <- identifiers(gpio_spec, options),
+         handle = %Handle{gpio_spec: identifiers.gpio_spec},
+         :ok <- GPIOServer.set_direction(identifiers.gpio_spec, direction),
+         :ok <- set_pull_mode(identifiers.gpio_spec, options[:pull_mode]),
+         :ok <- set_initial_value(identifiers.gpio_spec, options[:initial_value]) do
+      {:ok, handle}
     end
   end
 
-  defp set_pull_mode(_pin_spec, :not_set), do: :ok
-  defp set_pull_mode(pin_spec, pull_mode), do: GPIOServer.set_pull_mode(pin_spec, pull_mode)
+  defp set_pull_mode(_gpio_spec, :not_set), do: :ok
+  defp set_pull_mode(gpio_spec, pull_mode), do: GPIOServer.set_pull_mode(gpio_spec, pull_mode)
 
-  defp set_initial_value(_pin_spec, :not_set), do: :ok
-  defp set_initial_value(pin_spec, value), do: GPIOServer.write(pin_spec, value)
+  defp set_initial_value(_gpio_spec, :not_set), do: :ok
+  defp set_initial_value(gpio_spec, value), do: GPIOServer.write(gpio_spec, value)
 
   @doc """
   Return information about this backend
@@ -41,9 +36,4 @@ defmodule CircuitsSim.GPIO.Backend do
   def info() do
     %{backend: __MODULE__}
   end
-
-  @spec pin_specs(keyword()) :: [GPIO.pin_spec()]
-  def pin_specs(_options) do
-    DeviceRegistry.bus_names(:gpio)
-  end
 end

lib/circuits_sim/gpio/gpio_server.ex

@@ -9,15 +9,15 @@ defmodule CircuitsSim.GPIO.GPIOServer do
 
   require Logger
 
-  defstruct pin_spec: nil,
+  defstruct gpio_spec: nil,
             device: nil,
             direction: :input,
             pull_mode: :none,
             cached_value: 0,
             interrupt_receiver: nil,
             interrupt_trigger: :none
 
-  @type init_args :: [pin_spec: GPIO.pin_spec()]
+  @type init_args :: [gpio_spec: GPIO.gpio_spec()]
 
   @doc """
   Helper for creating child_specs for simple I2C implementations
@@ -27,9 +27,9 @@ defmodule CircuitsSim.GPIO.GPIOServer do
           :start => {__MODULE__, :start_link, [[any()], ...]}
         }
   def child_spec_helper(device, args) do
-    pin_spec = Keyword.fetch!(args, :pin_spec)
+    gpio_spec = Keyword.fetch!(args, :gpio_spec)
 
-    combined_args = Keyword.merge([device: device, name: via_name(pin_spec)], args)
+    combined_args = Keyword.merge([device: device, name: via_name(gpio_spec)], args)
 
     %{
       id: __MODULE__,
@@ -39,64 +39,59 @@ defmodule CircuitsSim.GPIO.GPIOServer do
 
   @spec start_link(keyword()) :: GenServer.on_start()
   def start_link(init_args) do
-    pin_spec = Keyword.fetch!(init_args, :pin_spec)
+    gpio_spec = Keyword.fetch!(init_args, :gpio_spec)
 
-    GenServer.start_link(__MODULE__, init_args, name: via_name(pin_spec))
+    GenServer.start_link(__MODULE__, init_args, name: via_name(gpio_spec))
   end
 
   # Helper for constructing the via_name for GPIODevice servers
-  defp via_name(pin_spec) do
-    DeviceRegistry.via_name(:gpio, pin_spec, 0)
+  defp via_name(gpio_spec) do
+    DeviceRegistry.via_name(:gpio, gpio_spec, 0)
   end
 
-  @spec write(GPIO.pin_spec(), GPIO.value()) :: :ok
-  def write(pin_spec, value) do
-    GenServer.call(via_name(pin_spec), {:write, value})
+  @spec write(GPIO.gpio_spec(), GPIO.value()) :: :ok
+  def write(gpio_spec, value) do
+    GenServer.call(via_name(gpio_spec), {:write, value})
   end
 
-  @spec read(GPIO.pin_spec()) :: GPIO.value()
-  def read(pin_spec) do
-    GenServer.call(via_name(pin_spec), :read)
+  @spec read(GPIO.gpio_spec()) :: GPIO.value()
+  def read(gpio_spec) do
+    GenServer.call(via_name(gpio_spec), :read)
   end
 
-  @spec set_direction(GPIO.pin_spec(), GPIO.pin_direction()) :: :ok | {:error, atom()}
-  def set_direction(pin_spec, direction) do
-    GenServer.call(via_name(pin_spec), {:set_direction, direction})
+  @spec set_direction(GPIO.gpio_spec(), GPIO.pin_direction()) :: :ok | {:error, atom()}
+  def set_direction(gpio_spec, direction) do
+    GenServer.call(via_name(gpio_spec), {:set_direction, direction})
   end
 
-  @spec set_interrupts(GPIO.pin_spec(), GPIO.trigger(), GPIO.interrupt_options()) ::
+  @spec set_interrupts(GPIO.gpio_spec(), GPIO.trigger(), GPIO.interrupt_options()) ::
           :ok | {:error, atom()}
-  def set_interrupts(pin_spec, trigger, options) do
+  def set_interrupts(gpio_spec, trigger, options) do
     receiver = options[:receiver] || self()
-    GenServer.call(via_name(pin_spec), {:set_interrupts, trigger, receiver})
+    GenServer.call(via_name(gpio_spec), {:set_interrupts, trigger, receiver})
   end
 
-  @spec set_pull_mode(GPIO.pin_spec(), GPIO.pull_mode()) :: :ok | {:error, atom()}
-  def set_pull_mode(pin_spec, pull_mode) do
-    GenServer.call(via_name(pin_spec), {:set_pull_mode, pull_mode})
+  @spec set_pull_mode(GPIO.gpio_spec(), GPIO.pull_mode()) :: :ok | {:error, atom()}
+  def set_pull_mode(gpio_spec, pull_mode) do
+    GenServer.call(via_name(gpio_spec), {:set_pull_mode, pull_mode})
   end
 
-  @spec info(GPIO.pin_spec()) :: map()
-  def info(pin_spec) do
-    GenServer.call(via_name(pin_spec), :info)
+  @spec render(GPIO.gpio_spec()) :: IO.ANSI.ansidata()
+  def render(gpio_spec) do
+    GenServer.call(via_name(gpio_spec), :render)
   end
 
-  @spec render(GPIO.pin_spec()) :: IO.ANSI.ansidata()
-  def render(pin_spec) do
-    GenServer.call(via_name(pin_spec), :render)
-  end
-
-  @spec send_message(GPIO.pin_spec(), any()) :: any()
-  def send_message(pin_spec, message) do
-    GenServer.call(via_name(pin_spec), {:send_message, message})
+  @spec send_message(GPIO.gpio_spec(), any()) :: any()
+  def send_message(gpio_spec, message) do
+    GenServer.call(via_name(gpio_spec), {:send_message, message})
   end
 
   @impl GenServer
   def init(init_args) do
-    pin_spec = Keyword.fetch!(init_args, :pin_spec)
+    gpio_spec = Keyword.fetch!(init_args, :gpio_spec)
     device = Keyword.fetch!(init_args, :device)
 
-    {:ok, %__MODULE__{pin_spec: pin_spec, device: device}}
+    {:ok, %__MODULE__{gpio_spec: gpio_spec, device: device}}
   end
 
   @impl GenServer
@@ -109,7 +104,7 @@ defmodule CircuitsSim.GPIO.GPIOServer do
         {:reply, :ok, %{state | device: new_device, cached_value: value}}
 
       :input ->
-        Logger.warning("Ignoring write to input GPIO #{inspect(state.pin_spec)}")
+        Logger.warning("Ignoring write to input GPIO #{inspect(state.gpio_spec)}")
         {:reply, :ok, state}
     end
   end
@@ -183,7 +178,7 @@ defmodule CircuitsSim.GPIO.GPIOServer do
 
   defp process_read(state, :hi_z) do
     Logger.warning(
-      "GPIO #{inspect(state.pin_spec)} is in high impedance state. Set pull mode to reliably read."
+      "GPIO #{inspect(state.gpio_spec)} is in high impedance state. Set pull mode to reliably read."
     )
 
     0
@@ -211,6 +206,6 @@ defmodule CircuitsSim.GPIO.GPIOServer do
   defp send_interrupt_message(state, value) do
     {uptime_ms, _} = :erlang.statistics(:wall_clock)
     uptime_ns = uptime_ms * 1_000_000
-    send(state.interrupt_receiver, {:circuits_gpio, state.pin_spec, uptime_ns, value})
+    send(state.interrupt_receiver, {:circuits_gpio, state.gpio_spec, uptime_ns, value})
   end
 end

lib/circuits_sim/gpio/handle.ex

@@ -4,15 +4,15 @@ defmodule CircuitsSim.GPIO.Handle do
   alias Circuits.GPIO.Handle
   alias CircuitsSim.GPIO.GPIOServer
 
-  defstruct [:pin_spec]
+  defstruct [:gpio_spec]
 
   @type t() :: %__MODULE__{
-          pin_spec: Circuits.GPIO.pin_spec()
+          gpio_spec: Circuits.GPIO.gpio_spec()
         }
 
   @spec render(t()) :: String.t()
   def render(%__MODULE__{} = handle) do
-    GPIOServer.render(handle.pin_spec)
+    GPIOServer.render(handle.gpio_spec)
     |> IO.ANSI.format()
     |> IO.chardata_to_string()
   end
@@ -22,27 +22,27 @@ defmodule CircuitsSim.GPIO.Handle do
 
     @impl Handle
     def read(%CircuitsSim.GPIO.Handle{} = handle) do
-      GPIOServer.read(handle.pin_spec)
+      GPIOServer.read(handle.gpio_spec)
     end
 
     @impl Handle
     def write(%CircuitsSim.GPIO.Handle{} = handle, value) do
-      GPIOServer.write(handle.pin_spec, value)
+      GPIOServer.write(handle.gpio_spec, value)
     end
 
     @impl Handle
     def set_direction(%CircuitsSim.GPIO.Handle{} = handle, direction) do
-      GPIOServer.set_direction(handle.pin_spec, direction)
+      GPIOServer.set_direction(handle.gpio_spec, direction)
     end
 
     @impl Handle
     def set_interrupts(%CircuitsSim.GPIO.Handle{} = handle, trigger, options) do
-      GPIOServer.set_interrupts(handle.pin_spec, trigger, options)
+      GPIOServer.set_interrupts(handle.gpio_spec, trigger, options)
     end
 
     @impl Handle
     def set_pull_mode(%CircuitsSim.GPIO.Handle{} = handle, pull_mode) do
-      GPIOServer.set_pull_mode(handle.pin_spec, pull_mode)
+      GPIOServer.set_pull_mode(handle.gpio_spec, pull_mode)
     end
 
     @impl Handle

mix.exs

@@ -45,7 +45,7 @@ defmodule CircuitsSim.MixProject do
     [
       {:circuits_i2c, "~> 2.0", override: true},
       {:circuits_spi, "~> 2.0"},
-      {:circuits_gpio, "~> 2.0.0-pre.0"},
+      {:circuits_gpio, "~> 2.0"},
       {:bmp280, "~> 0.2.12", only: [:dev, :test]},
       {:bmp3xx, "~> 0.1.5", only: [:dev, :test]},
       {:sgp30, github: "jjcarstens/sgp30", branch: "main", only: [:dev, :test]},

mix.lock

@@ -4,14 +4,14 @@
   "bmp3xx": {:hex, :bmp3xx, "0.1.6", "305a20e9f684ce7efc59185f20c17ddd3f9a5ce5fbf5fbeca1c0d17d58042d05", [:mix], [{:circuits_i2c, "~> 0.3 or ~> 1.0 or ~> 2.0", [hex: :circuits_i2c, repo: "hexpm", optional: false]}], "hexpm", "4b4f1e0eb62a9d0b8c7ffaba456e386848fa75328bc66a65e9cfa77a28e9be9d"},
   "bunt": {:hex, :bunt, "0.2.1", "e2d4792f7bc0ced7583ab54922808919518d0e57ee162901a16a1b6664ef3b14", [:mix], [], "hexpm", "a330bfb4245239787b15005e66ae6845c9cd524a288f0d141c148b02603777a5"},
   "cerlc": {:hex, :cerlc, "0.2.1", "cfe0880aa049ebcca079ca49578055aa48e7f2e9ed8ae08bd1f919d59015d03f", [:rebar3], [], "hexpm", "37f0d74a4277dcbaf64c7c47e9953dcc8060d26d86bb466ab2a86928e0181a7d"},
-  "circuits_gpio": {:hex, :circuits_gpio, "2.0.0-pre.0", "122a76a90f49cc2e83483157012fb7eff194ad80787567a2a6c1bd5133b989a7", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "454449f11527ff70da428765f725ef84263f5d68919dbb830a4868315ed0823e"},
+  "circuits_gpio": {:hex, :circuits_gpio, "2.0.2", "84225714b0d698fb8a7dfbbc900bbc1bbf57f4ad14dca3af15174f701a5b9a45", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "697e80b0e7ed4fd14bbab6c7e8b8b68d43f58fc1eff0ee800262c4f9b31f56c6"},
   "circuits_i2c": {:hex, :circuits_i2c, "2.0.1", "e9ab22f078b403cafd2c5006fff448f9a790f73c04e9135b7ac22f45f2e63c5c", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "a1567004389b49637fe34d9dd8bdf36c26a53c269e654753860b5c09532bc3c4"},
   "circuits_spi": {:hex, :circuits_spi, "2.0.0", "9198c15c7ffce5bc353e13b7c82df3fe99d7332bd7c28fb9a62c60ce1e7567dc", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "2eddec1fe6486a16f77f72eca91d50a806f9365033d96a517381b61d747612c2"},
   "credo": {:hex, :credo, "1.7.1", "6e26bbcc9e22eefbff7e43188e69924e78818e2fe6282487d0703652bc20fd62", [:mix], [{:bunt, "~> 0.2.1", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2.8", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "e9871c6095a4c0381c89b6aa98bc6260a8ba6addccf7f6a53da8849c748a58a2"},
   "credo_binary_patterns": {:hex, :credo_binary_patterns, "0.2.3", "0dabadbe3cfd8db14b69ff346c112bfadde9bf65dc7aea19c39743c8d2ed07fa", [:mix], [{:credo, "~> 1.6", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "3c333a564ed3e27f5c9f69985a921b88ef90f131bf722d085957cc4b25b7a085"},
   "dialyxir": {:hex, :dialyxir, "1.4.2", "764a6e8e7a354f0ba95d58418178d486065ead1f69ad89782817c296d0d746a5", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "516603d8067b2fd585319e4b13d3674ad4f314a5902ba8130cd97dc902ce6bbd"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.38", "b42252eddf63bda05554ba8be93a1262dc0920c721f1aaf989f5de0f73a2e367", [:mix], [], "hexpm", "2cd0907795aaef0c7e8442e376633c5b3bd6edc8dbbdc539b22f095501c1cdb6"},
-  "elixir_make": {:hex, :elixir_make, "0.7.7", "7128c60c2476019ed978210c245badf08b03dbec4f24d05790ef791da11aa17c", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}], "hexpm", "5bc19fff950fad52bbe5f211b12db9ec82c6b34a9647da0c2224b8b8464c7e6c"},
+  "elixir_make": {:hex, :elixir_make, "0.7.8", "505026f266552ee5aabca0b9f9c229cbb496c689537c9f922f3eb5431157efc7", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:certifi, "~> 2.0", [hex: :certifi, repo: "hexpm", optional: true]}], "hexpm", "7a71945b913d37ea89b06966e1342c85cfe549b15e6d6d081e8081c493062c07"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ex_doc": {:hex, :ex_doc, "0.30.9", "d691453495c47434c0f2052b08dd91cc32bc4e1a218f86884563448ee2502dd2", [:mix], [{:earmark_parser, "~> 1.4.31", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "d7aaaf21e95dc5cddabf89063327e96867d00013963eadf2c6ad135506a8bc10"},
   "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"},