@falconeta/capacitor-wifi-connect
plugin used for connect the device trhought Wifi also with prefix
Install
npm install @falconeta/capacitor-wifi-connect
npx cap sync
iOS Functions
For functionality, you need to note the following:
-
Connect/Disconnect only works for iOS11+
-
prefixConnect/securePrefixConnect only works for iOS13+
-
Can't run in the simulator so you need to attach an actual device when building with xCode
-
Will ensure 'HotspotConfiguration' and 'Wifi Information' capabilities are added to your xCode project
Android Functions
- ensure that the following permissions is configured in AndroidManifest.xml:
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /> <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
API
checkPermission()
checkPermission() => Promise<{ value: PermissionState; }>
Returns: Promise<{ value: PermissionState; }>
requestPermission()
requestPermission() => Promise<{ value: PermissionState; }>
Returns: Promise<{ value: PermissionState; }>
disconnect()
disconnect() => Promise<{ value: boolean; }>
Returns: Promise<{ value: boolean; }>
getSSID()
getSSID() => Promise<{ value: string; }>
Returns: Promise<{ value: string; }>
connect(...)
connect(options: { ssid: string; saveNetwork?: boolean; }) => Promise<{ value: ConnectState; }>
Param | Type |
---|
options | { ssid: string; saveNetwork?: boolean; } |
Returns: Promise<{ value: ConnectState; }>
prefixConnect(...)
prefixConnect(options: { ssid: string; saveNetwork?: boolean; }) => Promise<{ value: ConnectState; }>
Param | Type |
---|
options | { ssid: string; saveNetwork?: boolean; } |
Returns: Promise<{ value: ConnectState; }>
secureConnect(...)
secureConnect(options: { ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; }) => Promise<{ value: ConnectState; }>
Param | Type |
---|
options | { ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; } |
Returns: Promise<{ value: ConnectState; }>
securePrefixConnect(...)
securePrefixConnect(options: { ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; }) => Promise<{ value: ConnectState; }>
Param | Type |
---|
options | { ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; } |
Returns: Promise<{ value: ConnectState; }>
Type Aliases
PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
Enums
ConnectState
Members | Value |
---|
Ok | 0 |
Denied | -1 |
Ko | -2 |
UnknowSsid | -3 |