capacitor-wifi

Connect to Wifi through your capacitor plugin. Good for IoT device connections.
Capacitor Version 7

Forked from https://github.com/Lindsor/capacitor-wifi.git

Install

``bash
npm install @codext/capacitor-wifi
npx cap sync
`

API

* scanWifi()
* getCurrentWifi()
* connectToWifiBySsidAndPassword(...)
* connectToWifiBySsidPrefixAndPassword(...)
* checkPermissions()
* requestPermissions()
* disconnectAndForget()
* Interfaces
* Type Aliases
* Enums

$3

`typescript
scanWifi() => Promise
`

Returns: Promise<ScanWifiResult>

--------------------

$3

`typescript
getCurrentWifi() => Promise
`

Returns: Promise<GetCurrentWifiResult>

--------------------

$3

`typescript
connectToWifiBySsidAndPassword(connectToWifiRequest: ConnectToWifiRequest) => Promise
`

| Param | Type |
| -------------------------- | --------------------------------------------------------------------- |
| connectToWifiRequest | ConnectToWifiRequest |

Returns: Promise<ConnectToWifiResult>

--------------------

$3

`typescript
connectToWifiBySsidPrefixAndPassword(connectToWifiPrefixRequest: ConnectToWifiPrefixRequest) => Promise
`

| Param | Type |
| -------------------------------- | --------------------------------------------------------------------------------- |
| connectToWifiPrefixRequest | ConnectToWifiPrefixRequest |

Returns: Promise<ConnectToWifiResult>

--------------------

$3

`typescript
checkPermissions() => Promise
`

Returns: Promise<PermissionStatus>

--------------------

$3

`typescript
requestPermissions() => Promise
`

Returns: Promise<PermissionStatus>

--------------------

$3

`typescript
disconnectAndForget() => Promise
`

--------------------

$3


#### ScanWifiResult

| Prop | Type |
| ----------- | ------------------------ |
| wifis | WifiEntry[] |


#### WifiEntry

| Prop | Type |
| ------------------- | ----------------------------- |
| bssid | string |
| capabilities | WifiCapability[] |
| ssid | string |
| level | number |
| isCurrentWifi | boolean |


#### GetCurrentWifiResult

| Prop | Type |
| ----------------- | ----------------------------------------------- |
| currentWifi | WifiEntry |


#### ConnectToWifiResult

| Prop | Type |
| ---------------- | ----------------------------------------------- |
| wasSuccess | true |
| wifi | WifiEntry |


#### ConnectToWifiRequest

| Prop | Type |
| -------------- | ------------------- |
| ssid | string |
| password | string |


#### ConnectToWifiPrefixRequest

| Prop | Type |
| ---------------- | ------------------- |
| ssidPrefix | string |
| password | string |


#### PermissionStatus

| Prop | Type |
| -------------- | ----------------------------------------------------------- |
| LOCATION | PermissionState |
| NETWORK | PermissionState |

$3


#### PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

$3


#### WifiCapability

| Members | Value |
| ----------------------- | -------------------------------- |
| 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

| Members | Value |
| ------------ | ---------------------------- |
| HIDDEN` | '[HIDDEN_SSID]' |