npm package: @orbital-systems/react-native-esp-idf-provisioning
Description: Android and iOS wrapper for ESP IDF provisioning
Author: Mateo Gianolio
Latest version: 0.5.3

# react-native-esp-idf-provisioning

Android and iOS bridge for ESP IDF provisioning. Provides a unified interface for BLE and SoftAP provisioning using the libraries provided by Espressif:

- https://github.com/espressif/esp-idf-provisioning-android
- https://github.com/espressif/esp-idf-provisioning-ios

BLE provisioning is the primary production path for this library. SoftAP support is implemented on both platforms, but has seen less real-world validation and may vary depending on platform, permissions, and device firmware. See [#6](https://github.com/orbital-systems/react-native-esp-idf-provisioning/issues/6).

QR code scanning is deliberately not supported. This can be done using other react-native libraries.

![Provisioning](provisioning.gif)

## Installation

```sh
npm install @orbital-systems/react-native-esp-idf-provisioning
```

### Expo

For Expo prebuild / CNG projects, install with:

```sh
npx expo install @orbital-systems/react-native-esp-idf-provisioning
```

The package now ships with a root `app.plugin.js`, so `expo install` can add the
plugin automatically in static Expo configs. The config plugin applies the iOS
permission keys required for BLE and SoftAP provisioning, and explicitly adds
the Android permissions used by the native module during prebuild.

If your project uses a dynamic Expo config, add the plugin manually:

```json
{
  "expo": {
    "plugins": [
      "@orbital-systems/react-native-esp-idf-provisioning"
    ]
  }
}
```

Optional plugin props:

```json
{
  "expo": {
    "plugins": [
      [
        "@orbital-systems/react-native-esp-idf-provisioning",
        {
          "transport": "both",
          "bluetoothAlwaysPermission": "Allow $(PRODUCT_NAME) to discover nearby ESP devices.",
          "locationWhenInUsePermission": "Allow $(PRODUCT_NAME) to access your location while provisioning over Wi-Fi.",
          "localNetworkPermission": "Allow $(PRODUCT_NAME) to communicate with devices on your local network while provisioning."
        }
      ]
    ]
  }
}
```

Plugin props can also be set to `false` to skip adding the corresponding iOS
permission string.

`transport` controls which native permissions are added:

- `"ble"` adds Bluetooth-related permissions only.
- `"softap"` adds SoftAP/Wi-Fi-related permissions only.
- `"both"` adds both sets of permissions. This is the default.

## Usage

```ts
import {
  ESPProvisionManager,
  ESPDevice,
  ESPTransport,
  ESPSecurity,
} from '@orbital-systems/react-native-esp-idf-provisioning';

// Method 1.
// Get devices...
let prefix = 'PROV_';
let transport = ESPTransport.ble;
let security = ESPSecurity.secure2;
const devices = await ESPProvisionManager.searchESPDevices(
  prefix,
  transport,
  security
);

// ... and select device (using picklist, dropdown, w/e)
const device: ESPDevice = devices[0];

// Method 2.
// If you know device name and transport/security settings, create a device class instance
const device = new ESPDevice({
  name: 'name',
  transport: ESPTransport.ble,
  security: ESPSecurity.secure2,
});

// Connect to device with proofOfPossession
const proofOfPossession = 'pop';
await device.connect(proofOfPosession);

// Connect to device with proofOfPossession + username
const proofOfPossession = 'pop';
const username = 'username';
await device.connect(proofOfPosession, null, username);

// Connect to device with softAP password
const softAPPassword = 'password';
await device.connect(null, softAPPassword, null);

// connect() means the transport is connected and device metadata/version info
// has been fetched. It does not guarantee that a provisioning session is still
// available for later custom endpoint requests.

// Get wifi list
const wifiList = await device.scanWifiList();

// Provision device
const ssid = 'ssid';
const passphrase = 'passphrase';
await device.provision(ssid, passphrase);

// Send custom data
// Note: custom endpoint requests require an active provisioning session.
// Some firmware disconnects after successful provisioning, so this may need
// to happen before provision() unless the device keeps the session available.
const response = await device.sendData('/custom-endpoint', '{"foo":"bar"}');

// Disconnect
device.disconnect();
```

## Why use this library instead of alternatives?

There have been several attempts to create a react-native bridge of Espressif's native libraries.

Below are a few examples:

- https://github.com/manbomb/esp-idf-ble-provisioning-rn - Last commit 3 years ago
- https://github.com/amoghpalnitkar/react-native-esp-idf-provisioning - Last commit 4 years ago
- https://github.com/kafudev/react-native-esp-idf - Last commit 2 years ago
- https://github.com/futuristiclabs/react-native-esp32-idf - Last commit 3 years ago

We wanted something that is guaranteed to be compatible with the latest versions of Android and iOS.
We also needed it to work with the latest (or almost latest) version of react-native.

The examples above were great for inspiration, but they were all abandoned a while ago.

Since this is something we as a company (Orbital Systems) rely on for our current and future
IoT devices, we decided it was worth it to create and maintain a library with help from the community.

## Enums

```ts
enum ESPTransport {
  ble = 'ble',
  softap = 'softap',
}

enum ESPSecurity {
  unsecure = 0,
  secure = 1,
  secure2 = 2,
}

enum ESPWifiAuthMode {
  open = 0,
  wep = 1,
  wpa2Enterprise = 2,
  wpa2Psk = 3,
  wpaPsk = 4,
  wpaWpa2Psk = 5,
}
```

## Permissions

### Android

See AndroidManifest.xml in the example project.

### iOS

- Since iOS 13, apps that want to access SSID (Wi-Fi network name) are required to have the location permission. Add key `NSLocationWhenInUseUsageDescription` in Info.plist with proper description. This permission is required to verify iOS device is currently connected with the SoftAP.

- Since iOS 14, apps that communicate over local network are required to have the local network permission. Add key `NSLocalNetworkUsageDescription` in Info.plist with proper description. This permission is required to send/receive provisioning data with the SoftAP devices.

- To use BLE, you must add an entry for `NSBluetoothAlwaysUsageDescription` to your app config.

If you use Expo prebuild / CNG and enable this package's config plugin, those iOS
entries are added automatically.

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)