Pigpiox

v0.1.2

Pigpiox v0.1.2 Pigpiox.Socket View Source

Pigpiox.Socket provides an interface to send commands to a running pigpio daemon started by Pigpiox.Port

Link to this section Summary

Types

command_result()

The response of a command sent to pigpiod. The interpretation of result will vary based on the command run

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

command(cmd, p1 \\ 0, p2 \\ 0, extents \\ [])

Runs a command via pigpiod

init(_)

Invoked when the server is started. start_link/3 or start/3 will block until it returns

start_link(options \\ [])

Opens a TCP socket to a running pigpiod

Link to this section Types

Link to this type command_result() View Source 
command_result ::
  {:ok, result :: non_neg_integer} |
  {:error, reason :: atom}

The response of a command sent to pigpiod. The interpretation of result will vary based on the command run.

Link to this section Functions

Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function command(cmd, p1 \\ 0, p2 \\ 0, extents \\ []) View Source 
command(type :: atom, param_one :: integer, param_two :: integer, extents :: [integer]) :: command_result

Runs a command via pigpiod.

Link to this function init(_) View Source 
init(term) :: {:ok, :gen_tcp.socket} | {:stop, atom}

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be (re)started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function start_link(options \\ []) View Source 
start_link(list) :: {:ok, pid} | {:error, term}

Opens a TCP socket to a running pigpiod.