cordova-plugin-android-wifi-manager

Cordova plugin for accessing Android WifiManager.

cordova plugin add cordova-plugin-android-wifi-manager

Usage

Access the plugin after the device is ready, exposed at window.cordova.plugins.WifiManager.

var WifiManager = cordova.plugins.WifiManager

WifiManager.onwifistatechanged = function (data) {
  console.log(data.previousWifiState, '->', data.wifiState)
}

// Turn on Wifi
WifiManager.setWifiEnabled(true, function (err, success) {
  console.log(err, success)
})

API

All the exposed methods and events have matching WifiManager counterparts. The methods accept an optional callback as last argument, which is either called with an error object first, or with the value returned by the corresponding Java method.

addNetwork(wifiConfiguration, callback(err, netId))

Add a new network to the set of configured networks.

The method accepts a JavaScript object representing a WifiConfiguration Java instance.

Note that the Java bitsets are represented as objects where the keys match the corresponding WifiConfiguration constants, e.g. wifiConfiguration.allowedAuthAlgorithms.get(WifiConfiguration.AuthAlgorithm.LEAP) maps to wifiConfiguration.allowedAuthAlgorithms.LEAP in JavaScript.

Example of a WifiConfiguration object.

{
  BSSID: 'any',
  SSID: 'my-ssid',
  allowedAuthAlgorithms: {
    LEAP: true,
    OPEN: true,
    SHARED: true
  },
  allowedGroupCiphers: {
    CCMP: true,
    TKIP: true,
    WEP104: true,
    WEP40: true
  },
  allowedKeyManagement: {
    IEEE8021X: true,
    NONE: true,
    WPA_EAP: true,
    WPA_PSK: true
  },
  allowedPairwiseCiphers: {
    CCMP: true,
    NONE: true,
    TKIP: true
  },
  allowedProtocols: {
    RSN: true,
    WPA: true
  },
  hiddenSSID: false,
  networkId: 0,
  preSharedKey: 'psk',
  status: 'ENABLED',
  wepKeys: [
    null,
    null,
    null,
    null
  ],
  wepTxKeyIndex: 0
}

Possible values for status: ENABLED, DISABLED or CURRENT.

disableNetwork(netId, callback(err, success))

Disable a configured network.

disconnect(callback(err, success))

Disassociate from the currently active access point.

enableNetwork(netId, attemptConnect, callback(err, success))

Allow a previously configured network to be associated with.

getConfiguredNetworks(callback(err, wifiConfigurations))

Get a list of all configured networks. The callback recevies a list of WifiConfiguration objects.

getConnectionInfo(callback(err, wifiInfo))

Get information about the currently active WiFi connection. The callback receives a WifiInfo object.

Example of a WifiInfo object.

{
  BSSID: 'any',
  frequency: 2456,
  hiddenSSID: false,
  ipAddress: 2130706433,
  linkSpeed: 2300,
  macAddress: '00:14:22:01:23:45',
  networkId: 0,
  rssi: -15,
  SSID: 'my-ssid',
  supplicantState: 'COMPLETED'
}

See SupplicantState for possible values for the supplicantState property.

getDhcpInfo(callback(err, dhcpInfo))

Get the assigned addresses from the last successfull DHCP request. The callback receives a DhcpInfo object.

Example of a DhcpInfo object.

{
  dns1: 2130706433,
  dns2: 2130706434,
  gateway: 2130706433,
  ipAddress: 2130706433,
  leaseDuration: 60,
  netmask: 4278190080,
  serverAddress: 2130706433
}

getScanResults(callback(err, scanResults))

Get the results from the latest WiFi scan. The callback receives a list of ScanResult objects.

Example of a ScanResult object.

{
  BSSID: 'any',
  SSID: 'my-ssid',
  capabilities: '[WPA2-PSK-CCMP]',
  centerFreq0: 80,
  centerFreq1: 80,
  channelWidth: '80MHZ',
  frequency: 2456,
  level: -15,
  timestamp: 1507117436782
}

Possible values for channelWidth: 20MHZ, 40MHZ, 80MHZ, 160MHZ or 80MHZ_PLUS_MHZ.

getWifiState(callback(err, wifiState))

Get WiFi enabled state. Possible values are DISABLED, DISABLING, ENABLED, ENABLING and UNKNOWN.

isScanAlwaysAvailable(callback(err, alwaysAvailable))

Check if scanning is always available.

isWifiEnabled(callback(err, wifiEnabled))

Check if WiFi is either enabled or disabled.

reassociate(callback(err, success))

Reconnect to the currently active network, even if we already connected.

reconnect(callback(err, success))

Reconnect to the currently active network, if we are currently disconnected.

removeNetwork(netId, callback(err, success))

Remove a configured network.

saveConfiguration(callback(err, success))

Persist the current list of configured networks.

setWifiEnabled(enabled, callback(err, success))

Enable or disable WiFi.

startScan(callback(err, success))

Request a scan for WiFi networks.

updateNetwork(wifiConfiguration, callback(err, netId))

Update an already configured network.

Events

The plugin also emits an event for each available broadcast intent action. The event callbacks are called with an object containing all the extra information from the intent.

onnetworkidschanged({})

The IDs of the configured networks might have changed.

onnetworkstatechanged({ networkInfo, BSSID, wifiInfo })

WiFi connectivity changed. The callback receives a NetworkInfo object, a BSSID string and a WifiInfo object.

Example of a NetworkInfo object.

{
  detailedState: 'AUTHENTICATING',
  extraInfo: null,
  reason: null,
  state: 'CONNECTING',
  subtype: 0,
  subtypeName: '',
  type: 'WIFI',
  typeName: 'WIFI',
  available: true,
  connected: false,
  connectedOrConnecting: true,
  failover: false,
  roaming: false
}

See NetworkInfo.DetailedState for possible values for the detailedState property, and NetworkInfo.State for possible values for the state property.

onrssichanged({ RSSI })

Network signal strength changed.

onscanresultsavailable({ resultsUpdated })

WiFi network scan completed. Results can be retrieved using the getScanResults method.

onsupplicantconnectionchange({ supplicantConnected })

Connection to the supplicant has been established or lost.

onsupplicantstatechanged({ newState, supplicantError })

The state of establishing a connection to a network has changed. newState contains the new SupplicantState value, and supplicantError indicates an error (e.g. ERROR_AUTHENTICATING).

onwifistatechanged({ wifiState, previousWifiState })

WiFi state changed.

onevent(name, data)

Called on all events with the event name (e.g. wifistatechanged) and extra information.

onerror

Called on internal errors.

Hotspot

The Android API does not expose a way to modify the hotspot configurations. But it is possible using reflection to access private and undocumented methods of the WifiManager instance. This approach is fragile and has some quirks, but has been tested to work with API version 23.

getWifiApConfiguration(callback(err, wifiConfiguration))

Get the current WifiConfiguration object for the hotspot.

getWifiApState(callback(err, wifiApState))

Get WiFi access point state. Possible values are DISABLED, DISABLING, ENABLED, ENABLING and FAILED.

isWifiApEnabled(callback(err, wifiApEnabled))

Check if WiFi access point is either enabled or disabled.

setWifiApConfiguration(wifiConfiguration, callback(err, success))

Set the WiFi access point configuration.

setWifiApEnabled(wifiConfiguration, enabled, callback(err, success))

Enable or disable WiFi access point with the given configuration.

onwifiapstatechanged({ wifiApState, previousWifiApState })

Event triggered when the WiFi access point state changes.