unicloudvn / esp_provisioning Goto Github PK

View Code? Open in Web Editor NEW

64.0 12.0 49.0 426 KB

Flutter Provisioning library for ESP-IDF ESP32 Unified provisioning

Home Page: https://unicloudgroup.dev

License: Apache License 2.0

Java 2.46% Ruby 1.49% Swift 5.52% Objective-C 3.24% Dart 86.60% CMake 0.53% Makefile 0.14%

esp32 ble bluetooth provisioning espressif flutter made-in-vietnam

esp_provisioning's Introduction

esp_provisioning

Espressif BLE Provisioning library for ESP32

A library for Flutter was developed to provide network credentials and/or custom data to an ESP32 over Bluetooth BLE. The company makes chips ESP32, Espresif, they have 2 libraries for each Platform iOS and Android

However, the mobile application development on Flutter is easier now, and many will need this.

Getting Started

Need flutter_ble_lib for BLE transport in your application
API (Check exmaple)

 EspProv prov = EspProv(
        transport: TransportBLE(ble_peripheral), security: Security1(pop: pop));
 var success = await prov.establishSession();
 await prov.sendWifiConfig(ssid: event.ssid, password: event.password);
 await prov.applyWifiConfig();

Protocol Communication Overview

Protocol Communication (protocomm) component manages secure sessions and provides framework for multiple transports. The application can also use protocomm layer directly to have application specific extensions for the provisioning (or non-provisioning) use cases.

Following features are available for provisioning :

Communication security at application level
- protocomm_security1 (curve25519 key exchange + AES-CTR encryption)
Proof-of-possession (support with protocomm_security1 only)

Protocomm internally uses protobuf (protocol buffers) for secure session establishment. Though users can implement their own security (even without using protobuf). One can even use protocomm without any security layer.

Protocomm provides framework for various transports - WiFi (SoftAP+HTTPD), BLE, console - in which case the handler invocation is automatically taken care of on the device side (see Transport Examples below for code snippets).

Note that the client still needs to establish session (only for protocomm_security1) by performing the two way handshake. See Unified Provisioning for more details about the secure handshake logic.

License

Apache License Version 2.0

esp_provisioning's People

Contributors

Stargazers

Watchers

esp_provisioning's Issues

Please remove the hardcoded MTU

In TransportBle I recommend removing the hardcoded MTU await peripheral.connect(requestMtu: 512); or allowing the user to pass in a value. This higher value breaks certain BLE stacks on some phones like Samsung.

My current workaround is to connect to the device myself to short circuit TransportBle.connect() which is called by EspProv.establishSesision()

Thanks

Possible performance improvments

Hi,
I think that with a minor changes is possible to sue this one https://pub.dev/packages/cryptography_flutter to improve crypto performance

esp_provisioning sample app does not find my esp32 hardware which runs protocomm_security0 profile

Hi,

I am using this sample app to valid POC which can configure SSID, Password to ESP32 FW - over BLE.

But as soon as the scan starts this does keep scanning without any results at all for infinitely.

Note: Our HW device is build with protocomm_security0 - profile. (Not protocomm_security1 profile)
Can this be a problem ? If so - Is there any guidance on what I need to change in library in order to support for security0 profile.

esp_provisioning-master.zip

ESP32 firmware

My friend, could you quote the esp-idf example that you used to make your tests. No working in the first hand here? With the IDF version as well.

Thanks in advance.

Null safety?

Do you plan to migrate the package to null safety?

Is library maintained?

Is this library maintained or it is not, and can it be used, I do not see any alternatives for the provisioning over ble in flutter, I found one library but it only provides the most basic functionality, this library has all functions but seems unsafe to use and not being maintained

Is it support SoftAP Provisioning?

for esp8266, rtos sdk?

https://github.com/espressif/ESP8266_RTOS_SDK/tree/master/components/wifi_provisioning

Migrate to actively developed and support bluetooth library.

Library flutter_blue is not being actively developed.

Consider moving to an actively developed bluetooth lib like https://github.com/PhilipsHue/flutter_reactive_ble.

Upgrade dependencies

Hi,
to upgrade this dependencies:

protobuf: ^1.1.1
cryptography: ^1.4.1

protobuf: ^2.0.0
cryptography: ^2.0.1

A refactoring of Security1 is needed due to new API of "cryptography" library.
Can you help me in the migration please?

Thanks.
Sandro

To further users...

The app is still on development stage... It only find devices if your bluetooth is turned off, so the app can turn the bluetooth on itself. And worse than that, it wil only start to scan wifi if the wifi is off too, but in this case, is not a solution, the behaviour is still random to me. It also could not find my wifi network, maybe cause of the max number of the names in the network list.
Despite all of that, its a great idea, and the esp32 does receive the wifi network name. Just need more work.

with your example i can't find the esp32 ble provision device

with your example i can't find the esp32 ble provision device, have any advice?

Wifi screen not coming up

Hi,

This is a very great library and its very handy too.

I see an issue. I found ESP32 device and discovered, but When i click discovered device following error is thrown. Could you help please?

I/flutter (31505): └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
I/flutter (31505): EstablishSession error NoSuchMethodError: The method 'isConnected' was called on null.
I/flutter (31505): Receiver: null
I/flutter (31505): Tried calling: isConnected()
I/flutter (31505): ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
I/flutter (31505): │ #0 WifiBloc._mapLoadToState
package:esp_provisioning_example/wifi_screen/wifi_bloc.dart:32
I/flutter (31505): │
I/flutter (31505): │ #1 WifiBloc.mapEventToState
package:esp_provisioning_example/wifi_screen/wifi_bloc.dart:21
I/flutter (31505): ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
I/flutter (31505): │ ⛔ Error conencting to device Exception: Error establishSession
I/flutter (31505): └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
I/flutter (31505): ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
I/flutter (31505): │ #0 WifiBloc._mapLoadToState
package:esp_provisioning_example/wifi_screen/wifi_bloc.dart:42
I/flutter (31505): │
I/flutter (31505): │ #1 WifiBloc.mapEventToState
package:esp_provisioning_example/wifi_screen/wifi_bloc.dart:21
I/flutter (31505): ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
I/flutter (31505): │ ⛔ Error scan WiFi network NoSuchMethodError: The method 'startScanWiFi' was called on null.
I/flutter (31505): │ ⛔ Receiver: null
I/flutter (31505): │ ⛔ Tried calling: startScanWiFi()
I/flutter (31505): └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

establishSession method call below Error code: 302,

scanBle Ble Method code change uuids: []


  Stream<ScanResult> scanBle() {
    stopScanBle();
    return _bleManager.startPeripheralScan(
        uuids: [], //[TransportBLE.PROV_BLE_SERVICE],
        scanMode: ScanMode.balanced,
        allowDuplicates: true);
  }

Error code: 302, ATT error code: null, iOS error code: null, Android error code: null, reason: null, internal message: null, device ID: null, service UUID: 021a9004-0382-4aea-bff4-6b3f1c5adfb4, characteristic UUID: null, descriptor UUID: null

Not received wifi list

Error

How to disable Security1?

We don't need it for our devices and wondering is there is a way to disable it?
Thank you

Cryptography hang GUI loader

Cryptography library not use Isolates so there are 2 points in the code of security1.dart :

line88 :await _generateKey();
line105 :final sharedKey = await x25519.sharedSecretKey;

that cause the hang of GUI loader for some seconds.

I try to add Isolate, but I'm unable to do it works.
Can you help me pelase?

Unable to build the app

Suggestion: use a compatible library with a minSdk of at most 16,
or increase this project's minSdk version to at least 18,
or use tools:overrideLibrary="com.polidea.flutter_ble_lib" to force usage (may lead to runtime failures)

Incompatibility with mqtt_client

I am hitting the following incompatibility when trying to use esp_provisioning and mqtt_client in the same app.

Because mqtt_client >=9.1.0 depends on crypto ^3.0.1 and cryptography >=0.2.6 <2.0.0-nullsafety.0 depends on crypto ^2.0.0, mqtt_client >=9.1.0 is incompatible with cryptography >=0.2.6 <2.0.0-nullsafety.0.
Because esp_provisioning <=1.0.0+5 depends on cryptography ^0.2.6 and esp_provisioning >=1.0.0+6 depends on cryptography ^1.4.1, every version of esp_provisioning requires cryptography ^0.2.6 or ^1.4.1.
Thus, mqtt_client >=9.1.0 is incompatible with esp_provisioning.
So, because flutter_mqtt depends on both mqtt_client ^9.6.1 and esp_provisioning any, version solving failed.

Any suggestions on how to fix or workaround this?

unable to find wifi

with this example, it is searching wifi forever and never be done. Does anyone have solution ?