wpe_kiosk v0.1.0 WpeKiosk

Control a fullscreen WebKit browser using Elixir for use in a kiosk.

Use cog from Igalia which is a WPE launcher and webapp container. See (Cog)[https://github.com/Igalia/cog].

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Stop the kiosk

Force exit of Cog, despite starting as a port, Cog doesn't seem to die properly. FIXME?

Link to this section Functions

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

platform_init_events(udev_init_delay_ms)

Link to this function

start_link(opts, genserver_opts \\ [])
start_link(WpeKiosk.Options.t(), GenServer.options()) ::
  {:ok, pid()} | {:error, term()}

Start the kiosk.

The kiosk starts fullscreen and goes to a default local web page. To change this, set one or more options:

  • homepage: url - load this page first. For local files, specify file:///path/to/index.html
  • use_touch: boolean - uses touch inputs (e.g. mice)
  • use_cursor: boolean - uses cursor inputs (e.g. mice)
  • init_udev_inputs: boolean- starts udev daemon to handle input device events * ... See [WpeKiosk.Options`](WpeKiosk.Options.html) for full list. Currently WIP, the full bindings for controlling the WPE "cog" program are undocumented.
Link to this function

stop(server)
stop(GenServer.server()) :: :ok

Stop the kiosk

Link to this function

terminate(reason, state)

Force exit of Cog, despite starting as a port, Cog doesn't seem to die properly. FIXME?