vintage_net_wizard v0.4.0 VintageNetWizard View Source

Documentation for VintageNetWizard.

Link to this section Summary

Functions

Run the wizard.

Stop the wizard.

Link to this section Functions

Specs

run_wizard([VintageNetWizard.Web.Endpoint.opt()]) :: :ok | {:error, String.t()}

Run the wizard.

This means the WiFi module will be put into access point mode and the web server will be started.

Options:

  • :backend - Implementation for communicating with the network drivers (defaults to VintageNetWizard.Backend.Default)
  • :captive_portal - Whether to run in captive portal mode (defaults to true)
  • :device_info - A list of string tuples to render in a table in the footer (see README.md)
  • :ifname - The network interface to use (defaults to "wlan0")
  • :inactivity_timeout - Minutes to run before automatically stopping (defaults to 10 minutes)
  • :on_exit - {module, function, args} tuple specifying callback to perform after stopping the server.
  • :ssl - A Keyword list of :ssl.tls_server_options. See Plug.SSL.configure/1.

Specs

stop_wizard() :: :ok | {:error, String.t()}

Stop the wizard.

This will apply the current configuration in memory and completely stop the web and backend processes.