react-native-esp-smartconfig

ESP-TOUCH protocol to seamlessly configure Wi-Fi devices connecting to a router.

Installation

``sh
npm install react-native-esp-smartconfig
`

Congiguration

$3

- Add following permissions into android/src/main/AndroidManifest.xml

`






`

$3

- Add following entitlements into ios//.entitlements

`
com.apple.developer.networking.wifi-info
com.apple.developer.networking.HotspotConfiguration
`

- Add following capabilites into ios//info.plist

`
NSLocalNetworkUsageDescription
The application needs to access the local network, allowing UDP to send broadcasts
NSLocationAlwaysAndWhenInUseUsageDescription
This application uses location permissions to obtain currently connected Wi-Fi information. This application does not collect, store or record any location data.
NSLocationAlwaysUsageDescription
This application uses location permissions to obtain currently connected Wi-Fi information. This application does not collect, store or record any location data.
NSLocationWhenInUseUsageDescription
This application uses location permissions to obtain currently connected Wi-Fi information. This application does not collect, store or record any location data.
`

- Add adding them, run pod install inside ios directory.

Usage

- Available methods and interfaces

`typescript
interface SmartConfigResponse {
bssid: string;
ipv4: string;
}

interface WifiInfoState {
bssid: string | null;
ssid: string | null;
ipv4: string;
isConnected: boolean;
isWifi: boolean;
frequency: number | null; // android only
type: string; // connection type name i.e wifi/cellular/none
}

function start({
bssid: string;
ssid: string;
password: string;
}): Promise;

function stop();

function getWifiInfo(): Promise;
`

- Javascript example

`javascript
import espSmartconfig from 'react-native-esp-smartconfig';

espSmartconfig
.start({
bssid: 'wifi-network-bssid',
ssid: 'wifi-network-ssid',
password: 'wifi-password',
})
.then(function (results) {
// Array of devices, successfully handshaked by smartconfig
console.log(results);
/*[
{
'bssid': 'device-bssid', // device bssid
'ipv4': '192.168.1.11' // device local ip address
}
]*/
})
.catch(function (error) {});

// to cancel on-going smartconfig process
espSmartconfig.stop();
``

TODO

- [x] Android support
- [x] iOS support
- [x] getWifiInfo - android
- [ ] getWifiInfo - ios

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

Created by Alauddin Ansari (alauddinx27@gmail.com)