Merge branch 'feature/smartconfig_links' into 'master'

Provide a brief description of SmartConfig and add link to example

See merge request espressif/esp-idf!8636
This commit is contained in:
Krzysztof Budzynski 2020-05-18 01:02:05 +08:00
commit 58a9db8492
5 changed files with 23 additions and 13 deletions

View file

@ -1,7 +1,18 @@
SmartConfig
===========
:link_to_translation:`zh_CN:[中文]`
The SmartConfig\ :sup:`TM` is a provisioning technology developed by TI to connect a new Wi-Fi device to a Wi-Fi network. It uses a mobile app to broadcast the network credentials from a smartphone, or a tablet, to an un-provisioned Wi-Fi device.
The advantage of this technology is that the device does not need to directly know SSID or password of an Access Point (AP). This information is provided using the smartphone. This is particularly important to headless device and systems, due to their lack of a user interface.
If you are looking for other options to provision your {IDF_TARGET_NAME} devices, check :doc:`../provisioning/index`.
Application Example
-------------------
Connect {IDF_TARGET_NAME} to target AP using SmartConfig: :example:`wifi/smart_config`.
API Reference
-------------

View file

@ -10,4 +10,11 @@ Provisioning API
Unified Provisioning <provisioning>
Wi-Fi Provisioning <wifi_provisioning>
Code examples for this API section are provided in the :example:`provisioning` directory of ESP-IDF examples.
Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples.
.. toctree::
:maxdepth: 1
SmartConfig <../network/esp_smartconfig>
Code example for above API is provided in :example:`wifi/smart_config`

View file

@ -1,9 +1 @@
SmartConfig
===========
:link_to_translation:`en:[English]`
API 参考
-------------
.. include-build-file:: inc/esp_smartconfig.inc
.. include:: ../../../en/api-reference/network/esp_smartconfig.rst