Marius Vikhammer
4d332f710e
docs(kconfig): update kconfig ref links to use menuitem
2026-08-11 11:19:45 +02:00
Mahavir Jain
4631b4a5d9
docs(protocomm): recommend using security2 scheme for production purpose
2026-02-11 13:55:44 +05:30
WanqQixiang
6b503d0db5
component: Remove wifi_provisioning component and esp_prov tool
2025-09-26 09:48:50 +08:00
hrushikesh.bhosale
ccbb885c81
fix(wifi_prov_mgr): Fixed wifi_prov_mgr_deinit api return type
...
1. Updated the return type for wifi_prov_mgr_deinit api from void
to esp_err_t.
2. Due to void type unable to trace the api failure.
2025-07-02 15:14:53 +05:30
Mahavir Jain
ab7d37d014
fix(docs): update for changes in provisioning security2 scheme
2025-03-07 13:49:11 +05:30
Linda
1c81862048
docs: update application examples for hmac.rst and wifi_provisioning.rst
2024-09-26 10:18:32 +08:00
Marius Vikhammer
f1e65b8373
docs(misc): fixed typos found with codespell
2024-03-28 11:50:58 +08:00
harshal.patil
483b87750c
docs(wifi_provisioning): Use heap to allocate memory for the response
...
Added a note to specify that the memory for the response of a custom endpoint
should be allocated using the heap, as this memory gets freed by the protocomm layer
once it has been passed to the transport layer.
Closes https://github.com/espressif/esp-idf/issues/13263
2024-03-04 16:34:27 +05:30
Harshit Malpani
48ca895e3c
docs: Update provisioning API refs and guides for ESP32P4
2024-02-19 13:24:57 +05:30
Zhang Xiao Yan
4cd0a6a4b1
Merge branch 'docs/remove_wifi_related_documentation_for_esp32h2' into 'master'
...
docs: remove WiFi related documentation for ESP32-H2
See merge request espressif/esp-idf!27026
2023-12-05 09:58:06 +08:00
Linda
bd1825f9b1
docs: remove WiFi related documentation for ESP32-H2
2023-12-04 11:12:39 +08:00
Vikram Dattu
b97322c521
refactor(esp_srp): Expose esp_srp.h and add API docs
...
- Also added missing `protocomm_security2` reference in `protocomm.rst`
2023-11-21 18:06:24 +05:30
caixinying-git
a67b37330d
docs: update format issues for EN and CN files under api-reference/provisioning and api-reference/storage
2023-07-24 17:21:09 +08:00
Li Xiaoyi
6e987afabe
Docs: add CN translation for api-reference/provisioning/protocomm.rst
2023-07-06 15:56:21 +08:00
Cai Xin Ying
9a1d6281c5
Merge branch 'docs/add_provisioning_CN_trans' into 'master'
...
Docs: add CN translation for api-reference/provisioning/provisioning.rst
Closes DOC-5384
See merge request espressif/esp-idf!24123
2023-06-29 11:12:51 +08:00
Li Xiaoyi
233d494a06
Docs: add CN translation for api-reference/provisioning/provisioning.rst
2023-06-27 15:44:37 +08:00
Li Xiaoyi
859dfbefcd
Docs: add CN translation for api-reference/provisioning/wifi_provisioning.rst
2023-06-26 17:22:08 +08:00
Harshit Malpani
2910050060
docs: Update Protocols & Provisioning sections for H2
2023-03-30 18:00:12 +05:30
Mahavir Jain
11f2683c27
docs: add chapter about overall "security" area guide
...
List down considerations for the following areas:
- Hardware security
- Network security
- Product security
Also added brief explanation about "Security Policy" for ESP-IDF.
Closes IDF-1565
2022-11-25 03:17:05 +00:00
harshal.patil
e7a4062a30
docs: added documentation for wifi_ctrl endpoint and updated esp_prov readme
2022-11-01 14:19:01 +05:30
Aditya Patwardhan
1d8e7fe2d7
wifi_prov: Update behaviour for wifi_prov_mgr_start_provisioning to avoid breaking the usage for sec1
2022-09-30 16:53:06 +05:30
Aditya Patwardhan
d736cd560a
protocomm.rst: Fix documentation regarding Security Version 0
2022-06-28 15:13:52 +05:30
Aditya Patwardhan
6222d43984
protocomm: Added option to enable/disable supported security versions.
2022-06-17 13:16:20 +00:00
Aditya Patwardhan
0b88785286
provisioning: Added documentation for SRP6a based Security Scheme 2
2022-06-17 13:16:20 +00:00
Shang Zhou
33a00cf197
docs: Updated CN translation for index files in api-guides and api-reference
2022-02-23 14:48:26 +08:00
Laukik Hase
ee0f3b5890
docs: Removed reference to legacy provisioning examples
2022-01-19 12:09:31 +05:30
Nachiket Kukade
f38b18f046
docs: Separate Doc on WiFi security, added DPP Doc
...
1. Add new Doc on WiFi security
2. Add DPP related Doc under WiFi
3. Add Supplicant public headers in Doxyfile
2021-08-10 12:35:43 +05:30
Alex Henrie
22964d2065
docs: Change ESP_ERR_CHECK to ESP_ERROR_CHECK in provisioning examples
...
Closes IDFGH-5222
Closes IDFGH-5221
Closes https://github.com/espressif/esp-idf/pull/6995
Closes https://github.com/espressif/esp-idf/issues/6994
2021-05-09 16:18:50 +05:30
Krzysztof Budzynski
e58c0ac3e7
Provide a brief description of SmartConfig and add link to example
2020-05-18 01:02:04 +08:00
Piyush Shah
156ae68275
provisioning_examples: Move older examples to legacy/ folder
...
Change the manager example folder name to wifi_prov_mgr to sound more meaningful.
Signed-off-by: Piyush Shah <piyush@espressif.com >
2020-03-13 06:23:15 +00:00
Angus Gratton
e6211c7864
docs: add new top-level docs builder that builds docs for a single chip
2020-02-07 16:37:43 +11:00
Geng Yu Chao
6c923cf330
Fix some typo in idf
2019-12-12 15:55:42 +08:00
Darian Leung
75adefe437
docs: Alphbetically sort toctree
...
This commit sorts the entries of variuos toctrees
alphabetically. Indentation was also fixed. The order
of some toctrees were not modified if the existing
order had some form of suggested reading order.
2019-08-13 16:04:12 +08:00
Anurag Kar
0e8bd1699d
Wi-Fi Provisioning : Manager docs updated with information about esp_event_loop support
2019-07-05 08:41:27 +00:00
Krzysztof
5aa019fce6
Replace hardcoded links with link roles
2019-07-02 21:01:52 +08:00
Wojciech Szczurek
82b3779b2b
Fix broken link to components/wifi_provisioning/proto
...
Merges https://github.com/espressif/esp-idf/pull/3668
2019-07-02 21:00:38 +08:00
Anurag Kar
9c0ee28670
wifi_provisioning : Added Wi-Fi Scan list feature to Provisioning Manager
...
List of changes in components/wifi_provisioning:
* Manager version is now v1.1
* .proto files and protocomm handler added for sending Wi-Fi scan command and receiving scan results
* Implemented handlers for wifi_scan protocomm endpoint
* Update manager context data structure to hold scan state and results
* scheme_softap now runs Wi-Fi in APSTA mode
* Wi-Fi is started in AP mode when provisioning is started. This is necessary for scan list to work
* Docs updates with information about new wifi_scan endpoint
List of changes in tools/esp_prov:
* Added functions for sending and receiving protobuf messages compatible with wifi_scan protocomm endpoint
* Added feature to display/refresh scan results and accept user selection at runtime
* New functions:
* get_version() : only returns the protocol version string
* has_capability() : check is a capability is present according to proto-ver response
* wifi_scan feature is provided only if the `wifi_scan` capability is present
Other changes:
* Replace recursive mutex with plain mutex
* assert on return value of mutex give / take calls
* replace all calls with macros ACQUIRE_LOCK and RELEASE_LOCK
* some checks added in scanning related private APIs
* free and nullify scanning context and state if service is stopped while ongoing scan
2019-06-26 05:24:20 +00:00
Anurag Kar
471a0e93a7
wifi_provisioning : Docs updated with information about new provisioning manager
2019-06-10 15:13:50 +05:30
Wang Fang
2864d6deb3
Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review, including:
...
-network/index.rst
-network/esp_wifi.rst
-peripherals/index.rst
-provisioning/index.rst
2019-05-15 21:05:44 +08:00
Kirill Chalov
b672002a5f
Doc/review api reference indexes
2019-04-29 10:53:42 +08:00
Anurag Kar
59b10709d1
wifi_provisioning : context pointer added to wifi_config_t structure and related examples/docs updated
...
Closes https://github.com/espressif/esp-idf/issues/2874
2019-02-15 10:45:34 +00:00
Piyush Shah
759b90a5e1
protocomm_httpd: Allow applications to pass HTTPD handle
...
This will be useful if a webserver is already running and the application
does not want protocomm to start a new instance.
Signed-off-by: Piyush Shah <piyush@espressif.com >
2019-02-04 18:22:05 +05:30
Anurag Kar
2bb669cfbd
Docs : Provisioning docs and READMEs updated with links to GitHub repositories of Android and iOS apps
2018-10-18 18:23:03 +05:30
Anurag Kar
2d199dc521
Docs : Added Provisioning and Protocomm related docs
...
Co-Authored-By: Amey Inamdar <amey@espressif.com >
Co-Authored-By: Anurag Kar <anurag.kar@espressif.com >
2018-10-02 19:07:28 +05:30