capacitor-wifi
Connect to Wifi through your capacitor plugin. Good for IoT device connections.
Capacitor Version 7
Install
npm install @codext/capacitor-wifi
npx cap sync
API
scanWifi()
scanWifi() => Promise<ScanWifiResult>
Returns: Promise<ScanWifiResult>
getCurrentWifi()
getCurrentWifi() => Promise<GetCurrentWifiResult>
Returns: Promise<GetCurrentWifiResult>
connectToWifiBySsidAndPassword(...)
connectToWifiBySsidAndPassword(connectToWifiRequest: ConnectToWifiRequest) => Promise<ConnectToWifiResult>
Returns: Promise<ConnectToWifiResult>
connectToWifiBySsidPrefixAndPassword(...)
connectToWifiBySsidPrefixAndPassword(connectToWifiPrefixRequest: ConnectToWifiPrefixRequest) => Promise<ConnectToWifiResult>
Returns: Promise<ConnectToWifiResult>
checkPermissions()
checkPermissions() => Promise<PermissionStatus>
Returns: Promise<PermissionStatus>
requestPermissions()
requestPermissions() => Promise<PermissionStatus>
Returns: Promise<PermissionStatus>
disconnectAndForget()
disconnectAndForget() => Promise<void>
Interfaces
ScanWifiResult
WifiEntry
bssid | string |
capabilities | WifiCapability[] |
ssid | string |
level | number |
isCurrentWifi | boolean |
GetCurrentWifiResult
ConnectToWifiResult
ConnectToWifiRequest
ConnectToWifiPrefixRequest
ssidPrefix | string |
password | string |
PermissionStatus
Type Aliases
PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
Enums
WifiCapability
WPA2_PSK_CCM | 'WPA2-PSK-CCM' |
RSN_PSK_CCMP | 'RSN-PSK-CCMP' |
RSN_SAE_CCM | 'RSN-SAE-CCM' |
WPA2_EAP_SHA1_CCM | 'WPA2-EAP/SHA1-CCM' |
RSN_EAP_SHA1_CCMP | 'RSN-EAP/SHA1-CCMP' |
ESS | 'ESS' |
ES | 'ES' |
WP | 'WP' |
SpecialSsid