JSPM

esp-idf-provisioning-web

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14
  • Score
    100M100P100Q86857F
  • License MIT

ESP-IDF WiFi Provisioning SDK for web browsers

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esp-idf-provisioning-web) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    ESP-IDF Provisioning Web SDK

    A TypeScript SDK for provisioning ESP32 devices from web browsers using the ESP-IDF provisioning protocol. Supports both BLE (Web Bluetooth) and SoftAP (HTTP) transport modes.

    Features

    • Multiple Security Modes
      • Security1 (not implemented)
      • Security2 (not implemented)
    • BLE Transport: Uses Web Bluetooth API for wireless provisioning
    • SoftAP Transport: HTTP-based provisioning for devices in AP mode
    • Provisioning Protocol: Supports ESP-IDF provisioning protocol for WiFi credentials
      • Scan APs
      • Provision device status monitoring
      • Reset and re-provisioning
      • Custom endpoints

    Browser Compatibility

    • BLE Mode: Requires browsers with Web Bluetooth API support (Chrome, Edge, Opera)
    • SoftAP Mode: Works in all modern browsers (user must manually connect to WiFi)

    Installation

    npm install esp-idf-provisioning-web

    Usage

    BLE Provisioning

    import { ESPProvisionManager } from 'esp-idf-provisioning-web';

// Search for devices with BLE
const device = await ESPProvisionManager.searchBLEDevice();

// Connect with proof of possession
await device.connect();

// Scan for WiFi networks
const wifiList = await device.scanWifiList();

// Provision the device
await device.provision('MyWiFiSSID', 'MyWiFiPassword');

// Wait for STA connected
let result;
do {
  result = await device.fetchWifiStatus();
  await new Promise((resolve) => setTimeout(resolve, 2000));
} while (result.staState !== ESPWifiStaState.connecting);

if (result.staState === ESPWifiStaState.connected) {
  console.log('Provisioning successful!');
} else {
  console.log('Provisioning failed:', result);
}

// Disconnect
device.disconnect();

    SoftAP Provisioning

    Important: The browser cannot automatically connect to WiFi networks. Users must manually connect to the ESP device's access point before running this code.

    import { ESPProvisionManager } from 'esp-idf-provisioning-web';

// Create device instance for SoftAP
// User should already be connected to the device's WiFi network
const device = ESPProvisionManager.createSoftAPDevice(new URL('http://192.168.4.1'));

// Connect and provision
await device.connect();
await device.provision('MyWiFiSSID', 'MyWiFiPassword');

    Check Bluetooth Support

    // Check if Web Bluetooth is available
if (ESPProvisionManager.isBluetoothSupported()) {
  const isAvailable = await ESPProvisionManager.getBluetoothAvailability();
  console.log('Bluetooth available:', isAvailable);
}

    Browser Limitations

    BLE Mode

    • Requires user interaction (button click) to initiate device scanning
    • User must manually select device from browser's device picker
    • HTTPS or localhost required for Web Bluetooth API
    • Service UUID must be filled in optionalServiceUUIDs for some browsers

    SoftAP Mode

    • Browser cannot connect to WiFi networks programmatically
    • User must manually connect to ESP device's access point
    • CORS may need to be configured on the ESP device
    • May not work on all networks due to browser security restrictions

    Development

    # Install dependencies
npm install

# Build
npm run build

# Lint
npm run lint

# Format
npm run format

    License

    MIT

    References