Class: WifiDevice

LuCI.Network.WifiDevice

A Network.WifiDevice class instance represents a wireless radio device present on the system and provides wireless capability information as well as methods for enumerating related wireless networks.

Source:

Methods

addWifiNetwork(optionsopt) → {Promise.<(null|LuCI.Network.WifiNetwork)>}

Adds a new wireless network associated with this radio device to the configuration and sets its options to the provided values.

Parameters:
Name Type Attributes Description
options Object.<string, (string|Array.<string>)> <optional>

The options to set for the newly added wireless network.
Source:
Returns:

Returns a promise resolving to a WifiNetwork instance describing the newly added wireless network or null if the given options were invalid.

Type
Promise.<(null|LuCI.Network.WifiNetwork)>

deleteWifiNetwork(network) → {Promise.<boolean>}

Deletes the wireless network with the given name associated with this radio device.

Parameters:
Name Type Description
network string

The name of the wireless network to lookup. This may be either an uci configuration section ID, a network ID in the form radio#.network# or a Linux network device name like wlan0 which is resolved to the corresponding configuration section through ubus runtime information.
Source:
Returns:

Returns a promise resolving to true when the wireless network was successfully deleted from the configuration or false when the given network could not be found or if the found network was not associated with this wireless radio device.

Type
Promise.<boolean>

get(opt) → {null|string|Array.<string>}

Read the given UCI option value of this wireless device.

Parameters:
Name Type Description
opt string

The UCI option name to read.
Source:
Returns:

Returns the UCI option value or null if the requested option is not found.

Type
null | string | Array.<string>

getHTModes() → {Array.<string>}

Gets a list of supported htmodes.

The htmode values describe the wide-frequency options supported by the wireless phy.

Source:
Returns:

Returns an array of valid htmode values for this radio. Currently known mode values are:

  • HT20 - applicable to IEEE 802.11n, 20 MHz wide channels
  • HT40 - applicable to IEEE 802.11n, 40 MHz wide channels
  • VHT20 - applicable to IEEE 802.11ac, 20 MHz wide channels
  • VHT40 - applicable to IEEE 802.11ac, 40 MHz wide channels
  • VHT80 - applicable to IEEE 802.11ac, 80 MHz wide channels
  • VHT160 - applicable to IEEE 802.11ac, 160 MHz wide channels
Type
Array.<string>

getHWModes() → {Array.<string>}

Gets a list of supported hwmodes.

The hwmode values describe the frequency band and wireless standard versions supported by the wireless phy.

Source:
Returns:

Returns an array of valid hwmode values for this radio. Currently known mode values are:

  • a - Legacy 802.11a mode, 5 GHz, up to 54 Mbit/s
  • b - Legacy 802.11b mode, 2.4 GHz, up to 11 Mbit/s
  • g - Legacy 802.11g mode, 2.4 GHz, up to 54 Mbit/s
  • n - IEEE 802.11n mode, 2.4 or 5 GHz, up to 600 Mbit/s
  • ac - IEEE 802.11ac mode, 5 GHz, up to 6770 Mbit/s
Type
Array.<string>

getI18n() → {string}

Get a string describing the wireless radio hardware.

Source:
Returns:

Returns the description string.

Type
string

getName() → {string}

Get the configuration name of this wireless radio.

Source:
Returns:

Returns the UCI section name (e.g. radio0) of the corresponding radio configuration which also serves as unique logical identifier for the wireless phy.

Type
string

getScanList() → {Promise.<Array.<LuCI.Network.WifiScanResult>>}

Trigger a wireless scan on this radio device and obtain a list of nearby networks.

Source:
Returns:

Returns a promise resolving to an array of scan result objects describing the networks found in the vincinity.

Type
Promise.<Array.<LuCI.Network.WifiScanResult>>

getWifiNetwork(network) → {Promise.<LuCI.Network.WifiNetwork>}

Get the wifi network of the given name belonging to this radio device

Parameters:
Name Type Description
network string

The name of the wireless network to lookup. This may be either an uci configuration section ID, a network ID in the form radio#.network# or a Linux network device name like wlan0 which is resolved to the corresponding configuration section through ubus runtime information.
Source:
Returns:

Returns a promise resolving to a Network.WifiNetwork instance representing the wireless network and rejecting with null if the given network could not be found or is not associated with this radio device.

Type
Promise.<LuCI.Network.WifiNetwork>

getWifiNetworks() → {Promise.<Array.<LuCI.Network.WifiNetwork>>}

Get all wireless networks associated with this wireless radio device.

Source:
Returns:

Returns a promise resolving to an array of Network.WifiNetwork instances respresenting the wireless networks associated with this radio device.

Type
Promise.<Array.<LuCI.Network.WifiNetwork>>

isDisabled() → {boolean}

Checks whether this wireless radio is disabled.

Source:
Returns:

Returns true when the wireless radio is marked as disabled in ubus runtime state or when the disabled option is set in the corresponding UCI configuration.

Type
boolean

isUp() → {boolean}

Check whether the wireless radio is marked as up in the ubus runtime state.

Source:
Returns:

Returns true when the radio device is up, else false.

Type
boolean

set(opt, val)

Set the given UCI option of this network to the given value.

Parameters:
Name Type Description
opt string

The name of the UCI option to set.
val null | string | Array.<string>

The value to set or null to remove the given option from the configuration.
Source: