Package detailsv3.0.0

esp_smartconfig

EspTouch and EspTouchV2 implementations of SmartConfig provisioning protocols. Plain Dart. All platforms.

AndroidiOSmacOSWindowsLinux

pub.dev API documentation Source code

30-day downloads: 580
Likes: 46
Pub points: 160

Install package

flutter pub add esp_smartconfig

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Dart implementation of Esptouch and EsptouchV2 smart configuration protocols for IoT device provisioning. Enables seamless Wi-Fi setup of ESP8266/ESP32 devices via smartphones or desktop apps without requiring direct network access. Fully platform-agnostic, supporting Android, iOS, macOS, Windows, and Linux. Designed for developers integrating zero-touch device pairing into cross-platform Flutter applications. The package operates entirely in Dart with no native dependencies, ensuring compatibility across all supported platforms.

Use cases

IoT device onboarding
Smart home gadget setup
Embedded device configuration
Cross-platform Wi-Fi provisioning
Automated device registration

Key features

Esptouch and EsptouchV2 support
Pure Dart implementation
Multi-platform compatibility
No native code required
Lightweight and efficient
Secure Wi-Fi credential transfer

Suitable for

Flutter developers building IoT apps
Hardware integrators using ESP chips
Applications needing zero-touch device setup
Cross-platform mobile/desktop solutions
Projects avoiding native platform code

Considerations

Requires compatible ESP8266/ESP32 firmware
Network permissions needed on mobile platforms
Limited to devices supporting Esptouch protocol
Does not handle device reboot after configuration
Best used in local network environments

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Dart implementation of EspTouch provisioner. Supports Android, iOS, Windows, Linux and macOS.

Implemented protocols

EspTouch
EspTouch V2

Supported platforms

All non-web platforms are supported. Web platform is not supported mainly because browsers does not allow UDP communication.

If you are going to use this library on Desktop platforms make sure that UDP port 18266 is open in firewall for incoming data.

Breaking Change iOS 14.6/16

The breaking change was implemented with 14.6. However, it seems to be the case that the mentioned problem only occurs on devices with iOS version 16. It results in the fact that no connection to the ESP can be established.

How to:

You need an Apple-Developer account
After the Dev-Account has been approved, you have to make a request via this form to be allowed to use the Multicast Api.
Then you can follow this guide (new process)

Demo videos

Console App	Flutter Mobile App

Example

Several examples of using this library are available in example folder.

import 'package:esp_smartconfig/esp_smartconfig.dart';

final provisioner = Provisioner.espTouch();

provisioner.listen((response) {
    print("Device ${response.bssidText} connected to WiFi!");
});

try {
    await provisioner.start(ProvisioningRequest.fromStrings(
        ssid: "NETWORK NAME",
        bssid: "ROUTER BSSID", // Optional
        password: "NETWORK PASSWORD",
    ));

    // If you are going to use this library in Flutter
    // this is good place to show some Dialog and wait for exit
    //
    // Or simply you can delay with Future.delayed function
    await Future.delayed(Duration(seconds: 10));
} catch (e, s) {
    print(e);
}

// Provisioning does not have any timeout so it needs to be
// stopped manually
provisioner.stop();

SmartConfig

The SmartConfig^TM is a provisioning technology to connect a new Wi-Fi device to a Wi-Fi network.

The advantage of this technology is that the device does not need to directly know SSID or password of an Access Point (AP). Those information is provided using this library. This is particularly important to headless device and systems, due to their lack of a user interface.