ScrollHat.Buttons (scroll_hat v0.2.3)

Copy Markdown View Source

Buttons interface for Scroll HAT Mini

Pass a :handler option as a pid or {m, f, a} to receive the button events

Summary

Types

name()

A name of Scroll HAT Mini button

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_value(button)

Return the current state of the button

start_link(opts \\ [])

Start a GenServer to watch the buttons on the Scroll HAT Mini

Types

name()

@type name() :: :a | :b | :x | :y

A name of Scroll HAT Mini button

These are labelled A, B, X, and Y on the board.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_value(button)

@spec get_value(name()) :: 0 | 1

Return the current state of the button

0 - released 1 - pressed

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Start a GenServer to watch the buttons on the Scroll HAT Mini

Options:

  • :handler - pass a pid or an MFA to receive button events