esptouch_flutter 0.1.5

esptouch_flutter #

Flutter plugin package which contains an API for ESP-Touch written in Dart combined with platform-specific implementation for Android using Java and iOS using Objective-C.

This package provides a high customizability to the ESP Touch tasks and an idiomatic Dart interface for launching tasks.

Custom task parameters lets the users of this plugin change how long the task runs, you could set it to hours, if this is what your workflow requires.

If you enjoy using this, I'd really appreciate a star on GitHub!

Usage #

Example app #

For a complete example app, see the example folder in the repository.

The example app lets you configure WiFi SSID, BSSID, password, the duration of the task, expected task count and many more.

Code snippets #

import 'package:esptouch_flutter/esptouch_flutter.dart';

// Somewhere in your widget...
final ESPTouchTask task = ESPTouchTask(
  ssid: 'My WiFi network',
  bssid: 'ab:cd:ef:12:23:34',
  password: 'I love SMAHO',
);
final Stream<ESPTouchResult> stream = task.execute();
final printResult = (ESPTouchResult result) {
 print('IP: ${result.ip} MAC: ${result.bssid}');
};
StreamSubscription<ESPTouchResult> streamSubscription = stream.listen(printResult);
// Don't forget to cancel your stream subscription:
streamSubscription.cancel();

If you would like to customize the task, provide ESPTouchTaskParameter instance as taskParameter to ESPTouchTask.

final ESPTouchTask task = ESPTouchTask(
  ssid: 'My WiFi network',
  bssid: 'ab:cd:ef:12:23:34',
  password: 'I love Flutter and ESP-Touch, too',
  // Tweak the task using task parameters
  taskParameter: ESPTouchTaskParameter(waitUdpReceiving: Duration(hour: 12)),
);
// You can still stop the task at any point by calling .cancel on the stream subscription:
streamSubscription.cancel();

In the code example, I specify the types for clarity. You can omit them as Dart can infer them.

In a real world example, you'd get the WiFi credentials from a TextEditingControlller (e.g. _passwordController.text) and you could display the configured devices to the user, save it locally in SQLite or send it to your backend.

API reference #

The Full API reference is available on pub.dev.

We put effort into the docs, so if something is still not clear, please open an issue. We will try top help you out and update the docs.

Fundamentals #

ESP-Touch #

Using ESP-Touch, you can configure network for ESP8266 and ESP32 devices.

Espressif’s ESP-Touch protocol implements the Smart Config technology to help users connect ESP8266EX- and ESP32-embedded devices to a Wi-Fi network through simple configuration on a smartphone.

Resources #

You can read more about ESP-Touch here:

The original iOS and Android apps had to be heavily customized and tweaked in order to support custom task parameters.

Known issues #

  • We needed full customizability for the touch task parameters, these made changing a significant chunk of the Android and iOS platform side code necessary. We added builders for the task parameters as this looked like a solution that required the least changes to the platform code.
  • The only way I could implement this plugin is by pasting the platform-specific code into this project. One reason for this was that it wasn't published anywhere as easily installable packages, and the second reason is that I had to tweak the platform code to support configuration of the ESPTouchTaskParameters. This means that new changes to the original git repositories do not automatically show up in this project, so we need to manually update the Android and iOS code.
  • The underlying Android and iOS apps support different task parameters. There were multiple changes especially around IPv4 vs IPv6 handling. The plugin does not handle all of these differences.
  • Keeping track of finished tasks is necessary on Flutter's side.
  • AES support (last I checked the support differred on Android and iOS, so I haven't added them)

Contribute #

This is an open-source project built by the SMAHO Engineering team from Munich to wrap Espressif's ESP-Touch mobile app kits.

If you discover issues or know how to improve the project, please contribute: open a pull request or issue.

Flutter #

If you are coming from IoT background, you might not know what Flutter is.

Flutter is Google's UI toolkit for creating beautiful, native experiences for iOS and Android from a single codebase. For help getting started with Flutter, view the online documentation.

Flutter plugin packages #

This repository contains a Flutter plugin package for ESP-Touch. A plugin package is a specialized package that includes platform-specific implementation code for Android and iOS.

Platform channels #

The Flutter portion of the app sends messages to its host, the iOS or Android portion of the app, over a platform channel. This plugin relies on platform channels (event channels) heavily.

Get started #

If you'd like to contribute, the best way to get started is by running the example app.

  1. Install Flutter.

  2. Configure your IDE.

    studio .
    
    • To work with Android-specific code (.gradle, .java, ...), use Android Studio.
    studio android
    studio example/android
    
    • To work with iOS-specific code (.m, .h, ...), use Xcode and/or AppCode.
    open example/ios/Runner.xcworkspace
    appcode example/ios/Runner.xcworkspace
    

    Make sure you don't see any red squiggly lines, a properly configured IDE will help a lot during development.

    This is my recommended setup, but other IDEs should also work, e.g Visual Studio Code, IntelliJ, or Vim.

  3. Use a real phone for development. The plugin will not work in emulators and simulators, so you need real phones for development. Run flutter devices to verify.

  4. Run the example app

    1. cd example
    2. Install packages flutter packages get
    3. Run the app flutter run. After some time (~1 minute), you should see the app opening on your phone.
  5. Prepare embedded devices. To verify that the ESP-Touch app works, you need some hardware with ESP8266 and ESP32 to connect to your WiFi network.

Keep in mind that hot-reload and hot-restart will not reload platform code, so if you change java or obj-c files, you'll need to restart and recompile your app.

Style guides #

As we are writing Dart, Java and Objective-C code, we need familiarize ourselves with each language's style guide. Whenever possible, prefer automated solutions or IDE configs that help other developers write consistent code "automatically".

When this is not available, fallback to these style guides:

0.1.5 #

  • Fix podspecs for iOS

0.1.4 #

  • Request run-time permissions for location on Android M+ to make BSSID/SSID information work
  • Execute event sink methods on the main thread

0.1.3 #

Add example app screenshots

0.1.2 #

More docs improvements. Add missing license.

0.1.1 #

Improve documentation.

0.1.0 #

Initial release. Support ESP-Touch on iOS and Android. Fully configurable from your Dart code.

example/README.md

Examples for using the esptouch_flutter plugin

The example demonstrates how to use the esptouch_flutter plugin. You can read the full source code on GitHub: example folder in the repository.

The example app lets you configure

  • WiFi SSID (WiFi name)
  • WiFi BSSID (MAC of the wireless access point)
  • Password
  • Duration of the task
  • Expected task count
  • ... many more.

You can use current network SSID/BSSID or enter it manually (getting wifi info is restricted on the platforms, so sometimes it's necessary to enter them manually).

You can run the example app by:

flutter packages get
cd example
flutter run

Screenshots #

When you run the example app, this is more or less what you should expect:

Simple config #

Set WiFi details, such as name, address and password. All fields are editable.

Simple Configuration

Advanced config #

You can configure all task parameters right from your Flutter app. This level of configurability is not even supported in the official example apps.

Advanced Configuration

Code snippets #

In the code example, I specify the types for clarity. You can omit them as Dart can infer them.

import 'package:esptouch_flutter/esptouch_flutter.dart';

// Somewhere in your widget...
final ESPTouchTask task = ESPTouchTask(
  ssid: 'My WiFi network',
  bssid: 'ab:cd:ef:12:23:34',
  password: 'I love SMAHO',
);
final Stream<ESPTouchResult> stream = task.execute();
StreamSubscription<ESPTouchResult> streamSubscription = stream.listen((ESPTouchResult result) {
  print('Configured IP: ${result.ip} MAC: ${result.bssid}');
});
// Don't forget to cancel your stream subscription:
streamSubscription.cancel();

If you would like to customize the task, provide ESPTouchTaskParameter instance as taskParameter to ESPTouchTask.

final ESPTouchTask task = ESPTouchTask(
  ssid: 'My WiFi network',
  bssid: 'ab:cd:ef:12:23:34',
  password: 'The esptouch flutter plugin is awesome',
  taskParameter: ESPTouchTaskParameter(waitUdpReceiving: Duration(hour: 12)),
);
// You can still stop the task at any point by calling .cancel on the stream subscription:
streamSubscription.cancel();

In a real world example, you could display the result to the user, save it locally in SQLite or send it to your backend.

Getting Started #

This project is a starting point for a Flutter application using the esptouch_flutter plugin.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  esptouch_flutter: ^0.1.5

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:esptouch_flutter/esptouch_flutter.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
65
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
83
Learn more about scoring.

We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8