feat(network_prov): Rename wifi_provisioning to network_provisioning …

…component to support thread provisioning

.build-test-rules.yml

@@ -43,6 +43,22 @@ catch2/examples/catch2-console:
  - if: IDF_VERSION_MAJOR < 5
  reason: Example relies on WHOLE_ARCHIVE component property which was introduced in IDF v5.0
 
+network_provisioning/examples/thread_prov:
+ enable:
+ - if: ((IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR >= 1) or (IDF_VERSION_MAJOR > 5))
+ reason: Network provisioning component has dependencies IDF >= 5.1
+ disable:
+ - if: SOC_IEEE802154_SUPPORTED != 1
+ reason: Relevant only for IEEE802.15.4 enabled targets
+
+network_provisioning/examples/wifi_prov:
+ enable:
+ - if: ((IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR >= 1) or (IDF_VERSION_MAJOR > 5))
+ reason: Network provisioning component has dependencies IDF >= 5.1
+ disable:
+ - if: SOC_WIFI_SUPPORTED != 1
+ reason: Relevant only for WiFi enabled targets
+
 esp_lcd_qemu_rgb/examples/lcd_qemu_rgb_panel:
  enable:
  - if: ((IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR >= 3) or (IDF_VERSION_MAJOR > 5)) and (IDF_TARGET in ["esp32", "esp32c3"])

.github/workflows/upload_component.yml

@@ -54,6 +54,7 @@ jobs:
  json_parser;
  led_strip;
  libsodium;
+ network_provisioning;
  nghttp;
  onewire_bus;
  pcap;

.pre-commit-config.yaml

@@ -3,4 +3,5 @@ repos:
  rev: v1.0.5
  hooks:
  - id: astyle_py
- args: ['--style=otbs', '--attach-namespaces', '--attach-classes', '--indent=spaces=4', '--convert-tabs', '--align-pointer=name', '--align-reference=name', '--keep-one-line-statements', '--pad-header', '--pad-oper']
+ args: ['--style=otbs', '--attach-namespaces', '--attach-classes', '--indent=spaces=4', '--convert-tabs', '--align-pointer=name', '--align-reference=name', '--keep-one-line-statements', '--pad-header', '--pad-oper']
+ exclude: 'network_provisioning/proto-c'

network_provisioning/CMakeLists.txt

@@ -0,0 +1,29 @@
+set(srcs "src/network_config.c"
+ "src/network_scan.c"
+ "src/network_ctrl.c"
+ "src/manager.c"
+ "src/handlers.c"
+ "src/scheme_console.c"
+ "proto-c/network_config.pb-c.c"
+ "proto-c/network_scan.pb-c.c"
+ "proto-c/network_ctrl.pb-c.c"
+ "proto-c/network_constants.pb-c.c")
+
+if(CONFIG_ESP_WIFI_ENABLED AND CONFIG_ESP_WIFI_SOFTAP_SUPPORT)
+ list(APPEND srcs "src/scheme_softap.c")
+endif()
+
+if(CONFIG_SOC_BT_SUPPORTED AND CONFIG_BT_ENABLED)
+ if(CONFIG_BT_BLUEDROID_ENABLED OR CONFIG_BT_NIMBLE_ENABLED)
+ list(APPEND srcs
+ "src/scheme_ble.c")
+ endif()
+endif()
+
+idf_component_get_property(protocomm_dir protocomm COMPONENT_DIR)
+
+idf_component_register(SRCS "${srcs}"
+ INCLUDE_DIRS include
+ PRIV_INCLUDE_DIRS src proto-c ${protocomm_dir}/proto-c
+ REQUIRES lwip protocomm
+ PRIV_REQUIRES protobuf-c bt json esp_timer esp_wifi openthread)

wifi_provisioning/Kconfig → network_provisioning/Kconfig

@@ -1,60 +1,63 @@
-menu "Wi-Fi Provisioning Manager"
+menu "Network Provisioning Manager"
 
- config WIFI_PROV_SCAN_MAX_ENTRIES
- int "Max Wi-Fi Scan Result Entries"
+ config NETWORK_PROV_SCAN_MAX_ENTRIES
+ int "Max Network Scan Result Entries"
  default 16
  range 1 255
  help
- This sets the maximum number of entries of Wi-Fi scan results that will be kept by the provisioning manager
+ This sets the maximum number of entries of network scan results that will be kept by the
+ provisioning manager
 
- config WIFI_PROV_AUTOSTOP_TIMEOUT
+ config NETWORK_PROV_AUTOSTOP_TIMEOUT
  int "Provisioning auto-stop timeout"
  default 30
  range 5 600
  help
- Time (in seconds) after which the Wi-Fi provisioning manager will auto-stop after connecting to
- a Wi-Fi network successfully.
+ Time (in seconds) after which the network provisioning manager will auto-stop after connecting to
+ a network successfully.
 
- config WIFI_PROV_BLE_BONDING
+ config NETWORK_PROV_BLE_BONDING
  bool
  prompt "Enable BLE bonding"
  depends on BT_ENABLED
  help
- This option is applicable only when provisioning transport is BLE.
+ This option is applicable only when provisioning transport is BLE. Used to enable BLE bonding process
+ where the information from the pairing process will be stored on the devices.
 
- config WIFI_PROV_BLE_SEC_CONN
+ config NETWORK_PROV_BLE_SEC_CONN
  bool
  prompt "Enable BLE Secure connection flag"
  depends on BT_NIMBLE_ENABLED
  default y
  help
  Used to enable Secure connection support when provisioning transport is BLE.
 
- config WIFI_PROV_BLE_FORCE_ENCRYPTION
+ config NETWORK_PROV_BLE_FORCE_ENCRYPTION
  bool
  prompt "Force Link Encryption during characteristic Read / Write"
  help
  Used to enforce link encryption when attempting to read / write characteristic
 
- config WIFI_PROV_KEEP_BLE_ON_AFTER_PROV
+ config NETWORK_PROV_KEEP_BLE_ON_AFTER_PROV
  bool "Keep BT on after provisioning is done"
  depends on BT_ENABLED
  select ESP_PROTOCOMM_KEEP_BLE_ON_AFTER_BLE_STOP
 
- config WIFI_PROV_DISCONNECT_AFTER_PROV
+ config NETWORK_PROV_DISCONNECT_AFTER_PROV
  bool "Terminate connection after provisioning is done"
- depends on WIFI_PROV_KEEP_BLE_ON_AFTER_PROV
+ depends on NETWORK_PROV_KEEP_BLE_ON_AFTER_PROV
  default y
  select ESP_PROTOCOMM_DISCONNECT_AFTER_BLE_STOP
 
- choice WIFI_PROV_STA_SCAN_METHOD
+ choice NETWORK_PROV_WIFI_STA_SCAN_METHOD
  bool "Wifi Provisioning Scan Method"
- default WIFI_PROV_STA_ALL_CHANNEL_SCAN
- config WIFI_PROV_STA_ALL_CHANNEL_SCAN
+ depends on ESP_WIFI_ENABLED
+ default NETWORK_PROV_WIFI_STA_ALL_CHANNEL_SCAN
+ config NETWORK_PROV_WIFI_STA_ALL_CHANNEL_SCAN
  bool "All Channel Scan"
  help
  Scan will end after scanning the entire channel. This option is useful in Mesh WiFi Systems.
- config WIFI_PROV_STA_FAST_SCAN
+ config NETWORK_PROV_WIFI_STA_FAST_SCAN
  bool "Fast Scan"
  help
  Scan will end after an AP matching with the SSID has been detected.

network_provisioning/LICENSE

@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ https://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2020 Piyush Shah <[email protected]>
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

network_provisioning/README.md

@@ -0,0 +1,9 @@
+# Network Provisioning component
+
+[![Component Registry](https://components.espressif.com/components/espressif/network_provisioning/badge.svg)](https://components.espressif.com/components/espressif/network_provisioning)
+
+The network provisioning component provides APIs that control the network provisioning service for receiving and configuring network credentials via secure [Protocol Communication](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/provisioning/protocomm.html) sessions.
+
+It currently supports both Wi-Fi and Thread network provisioning:
+- Provision Wi-Fi credentials over SoftAP or Bluetooth LE
+- Provision Thread credentials over Bluetooth LE

network_provisioning/examples/README.md

@@ -0,0 +1,11 @@
+# Provisioning Application Examples
+
+This primarily consists of two examples `wifi_prov` and `thread_prov`.
+
+* wifi_prov
+ Abstracts out most of the complexity of Wi-Fi provisioning and allows easy switching between the SoftAP (using HTTP) and BLE transports. It also demonstrates how applications can register and use additional custom data endpoints.
+
+* thread_prov
+ Abstracts out most of the complexity of Thread provisioning over BLE transport. It also demonstrates how applications can register and use additional custom data endpoints.
+
+Provisioning applications are available for `Linux / Windows / macOS` platform as `esp_prov.py` [script](../tool/esp_prov/esp_prov.py)

wifi_provisioning/examples/wifi_prov/CMakeLists.txt → network_provisioning/examples/thread_prov/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(wifi_prov_mgr)
+project(thread_prov)