Wobserver

v0.1.10

Wobserver v0.1.10 Wobserver.Page View Source

Page management for custom commands and pages in api and wobserver.

Link to this section Summary

Types

data()

Accepted page formats

t()

Page structure

Functions

call(command)

Calls the function associated with the command/page

find(command)

Find the page for a given command

list()

List all registered pages

load_config()

Loads custom pages from configuration and adds them to :wobserver

register(page)

Registers a page with :wobserver

register(title, command, callback, options \\ [])

Registers a page with :wobserver

Link to this section Types

Link to this type

data() View Source 
data() ::
  Wobserver.Page.t()
  | map()
  | {String.t(), atom(), (... -> any())}
  | {String.t(), atom(), (... -> any()), boolean()}

Accepted page formats.

Link to this type

t() View Source 
t() :: %Wobserver.Page{
  callback: (... -> any()),
  command: atom(),
  options: keyword(),
  title: String.t()
}

Page structure.

Fields:

  • title, the name of the page. Is used for the web interface menu.
  • command, single atom to associate the page with.
  • callback, function to be evaluated, when the a api is called or page is viewd. The result is converted to JSON and displayed.
  • options, map containing options for the page.

Options:

  • api_only (boolean), if set to true the page won't show up in the web interface, but will only be available as API.
  • refresh (float, 0-1), sets the refresh time factor. Used in the web interface to refresh the data on the page. Set to 0 for no refresh.

Link to this section Functions

Link to this function

call(command) View Source 
call(Wobserver.Page.t() | atom()) :: any()

Calls the function associated with the command/page.

Returns the result of the function or :page_not_found, if the page can not be found.

Link to this function

find(command) View Source 
find(command :: atom()) :: Wobserver.Page.t()

Find the page for a given command

Returns :page_not_found, if no page can be found.

Link to this function

list() View Source 
list() :: [map()]

List all registered pages.

For every page the following information is given:

  • title
  • command
  • api_only
  • refresh
Link to this function

load_config() View Source 
load_config() :: [any()]

Loads custom pages from configuration and adds them to :wobserver.

To add custom pages set the :pages option. The :pages option must be a list of page data.

The page data can be formatted as:

  • {title, command, callback}
  • {title, command, callback, options}

  • a map with the following fields:

    • title
    • command
    • callback
    • options (optional)

For more information and types see: Wobserver.Page.register/1.

Example:

config :wobserver,
  pages: [
    {"Example", :example, fn -> %{x:  9} end}
  ]
Link to this function

register(page) View Source 
register(page :: Wobserver.Page.data()) :: boolean()

Registers a page with :wobserver.

Returns true if succesfully added. (otherwise false)

The following inputs are accepted:

  • {title, command, callback}
  • {title, command, callback, options}

  • a map with the following fields:

    • title
    • command
    • callback
    • options (optional)

The fields are used as followed:

  • title, the name of the page. Is used for the web interface menu.
  • command, single atom to associate the page with.
  • callback, function to be evaluated, when the a api is called or page is viewd. The result is converted to JSON and displayed.
  • options, options for the page.

The following options can be set:

  • api_only (boolean), if set to true the page won't show up in the web interface, but will only be available as API.
  • refresh (float, 0-1), sets the refresh time factor. Used in the web interface to refresh the data on the page. Set to 0 for no refresh.
Link to this function

register(title, command, callback, options \\ []) View Source 
register(
  title :: String.t(),
  command :: atom(),
  callback :: (... -> any()),
  options :: keyword()
) :: boolean()

Registers a page with :wobserver.

The arguments are used as followed:

  • title, the name of the page. Is used for the web interface menu.
  • command, single atom to associate the page with.
  • callback, function to be evaluated, when the a api is called or page is viewd. The result is converted to JSON and displayed.
  • options, options for the page.

The following options can be set:

  • api_only (boolean), if set to true the page won't show up in the web interface, but will only be available as API.
  • refresh (float, 0-1), sets the refresh time factor. Used in the web interface to refresh the data on the page. Set to 0 for no refresh.