vintage_net_wizard v0.3.0 VintageNetWizard.WiFiConfiguration behaviour View Source

Module for working with various WiFi configurations

Link to this section Summary

Functions

Marshal a parameter map into a type of WiFi Configuration

Get the key_mgmt type from the particular WiFi Configuration

Convert a key_mgmt string into a key_mgmt

Get a human friendly name for the type of security of a WiFiConfiguration

Get the expected timeout in milisecs for a particular configuration

Take a particular type of WiFi configuration and make into a configuration that vintage_net can use

Callbacks

A function on how to transform the map of params into a WiFiConfiguration

A function on how to take a WiFiConfiguration and make it into a useable vintage_net WiFi configuration.

Link to this section Types

Specs

key_mgmt() :: :none | :wpa_psk

Specs

t()

Link to this section Functions

Specs

from_params(map()) ::
  {:ok, t()} | {:error, VintageNetWizard.WiFiConfiguration.Params.param_error()}

Marshal a parameter map into a type of WiFi Configuration

Specs

get_key_mgmt(t()) :: key_mgmt()

Get the key_mgmt type from the particular WiFi Configuration

Link to this function

key_mgmt_from_string(arg1)

View Source

Specs

key_mgmt_from_string(String.t()) ::
  {:ok, key_mgmt()} | {:error, :invalid_key_mgmt}

Convert a key_mgmt string into a key_mgmt

Specs

security_name(t()) :: String.t()

Get a human friendly name for the type of security of a WiFiConfiguration

Specs

timeout(t()) :: non_neg_integer()

Get the expected timeout in milisecs for a particular configuration

Link to this function

to_vintage_net_configuration(config)

View Source

Specs

to_vintage_net_configuration(struct()) :: map()

Take a particular type of WiFi configuration and make into a configuration that vintage_net can use

Link to this section Callbacks

Specs

from_params(map()) ::
  {:ok, t()} | {:error, VintageNetWizard.WiFiConfiguration.Params.param_error()}

A function on how to transform the map of params into a WiFiConfiguration

Link to this callback

to_vintage_net_configuration(t)

View Source

Specs

to_vintage_net_configuration(t()) :: map()

A function on how to take a WiFiConfiguration and make it into a useable vintage_net WiFi configuration.