@spec all_interfaces() :: [ifname()]

Return a list of all interfaces on the system

@spec configuration_valid?(ifname(), map()) :: boolean()

Check if this is a valid configuration

This runs the validation routines for a settings map, but doesn't try to apply them.

@spec configure(ifname(), map(), configure_options()) :: :ok | {:error, any()}

Update the configuration of a network interface

Configurations are validated and normalized before being applied. This means that type errors and missing required fields will be caught and old or redundant ways of specifying configurations will be fixed. Call get_configuration/1 to see how what changes, if any, were made as part of the normalization process.

After validation, the configuration is optionally persisted and applied.

See the VintageNet documentation for configuration examples or your VintageNet.Technology provider's docs.

Options:

• :persist - set to false to avoid persisting this configuration. System restarts will revert to the previous configuration. Defaults to true.

@spec configured_interfaces() :: [ifname()]

Return a list of configured interface

@spec deconfigure(ifname(), configure_options()) :: :ok | {:error, any()}

Deconfigure and persists (by default) settings for a specified interface.

Supports same options as configure/3

@spec get(property(), value()) :: value()

Get the current value of a network property

See get_by_prefix/1 for exact prefix matches (i.e., get all properties for one interface) and match/1 to run wildcard matches (i.e., get a specific property for all interfaces).

@spec get_by_prefix(property()) :: [{property(), value()}]

Get a list of all properties matching the specified prefix

To get a list of all known properties and their values, call VintageNet.get_by_prefix([])

@spec get_configuration(ifname()) :: map()

Return the settings for the specified interface

@spec info(info_options()) :: :ok

Print the current network status

Options include:

• :redact - Set to false to print out passwords

@spec ioctl(ifname(), atom(), any()) :: :ok | {:ok, any()} | {:error, any()}

Run a command on a network interface

Commands are mostly network interface-specific. Also see the VintageNet PropertyTable fo getting status or registering for status changes.

@spec match(pattern()) :: [{property(), value()}]

Get a list of all properties matching a pattern

Patterns are list of strings that optionally specify :_ at a position in the list to match any value.

@spec max_interface_count() :: 1..100

Return the maximum number of interfaces controlled by VintageNet

Internal constraints mean that VintageNet can't manage an arbitrary number of interfaces and knowing the max can reduce some processing. The limit is set by the application config. Unless you need over 100 network interfaces, VintageNet's use of the Linux networking API is not likely to be an issue, though.

@spec reset_to_defaults(ifname()) :: :ok | {:error, any()}

Configure an interface to use the defaults

This configures an interface to the defaults found in the application environment (config.exs). If the application environment doesn't have a default configuration, the interface is deconfigured. On reboot, the interface will continue to use the defaults and if a new version of firmware updates the defaults, it will use those.

@spec scan(ifname()) :: :ok | {:ok, any()} | {:error, any()}

Initiate an access point scan on a wireless interface

The scan results are posted asynchronously to the ["interface", ifname, "wifi", "access_points"] property as they come in. After waiting a second or two they can be fetched via VintageNet.get(["interface", ifname, "wifi", "access_points"]).

It appears that there's some variation in how scanning is implemented on WiFi adapters. One strategy that seems to work is to call scan/1 every 10 seconds or so while prompting a user to pick a WiFi network.

This is a utility function for calling the :scan ioctl.

@spec subscribe(pattern()) :: :ok

Subscribe to property change messages

Messages have the form:

{VintageNet, property_name, old_value, new_value, metadata}

Subscriptions are prefix matches. For example, to get notified whenever a property changes on "wlan0", run this:

VintageNet.subscribe(["interface", "wlan0"])

It's also possible to match with wildcards using :_. For example, to get notified whenever an IP address in the system changes, do this:

VintageNet.subscribe(["interface", :_, "addresses"])

@spec unsubscribe(pattern()) :: :ok

Stop subscribing to property change messages

@spec verify_system(keyword() | nil) :: :ok | {:error, String.t()}

Check that the system has the required programs installed

NOTE: This isn't completely implemented yet!