From e58c0ac3e7326b79614bede7de9fa6fc334234eb Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Mon, 18 May 2020 01:02:04 +0800 Subject: [PATCH] Provide a brief description of SmartConfig and add link to example --- docs/en/api-reference/network/esp_smartconfig.rst | 13 ++++++++++++- docs/en/api-reference/network/index.rst | 2 +- docs/en/api-reference/provisioning/index.rst | 9 ++++++++- docs/en/contribute/documenting-code.rst | 2 +- .../zh_CN/api-reference/network/esp_smartconfig.rst | 10 +--------- 5 files changed, 23 insertions(+), 13 deletions(-) diff --git a/docs/en/api-reference/network/esp_smartconfig.rst b/docs/en/api-reference/network/esp_smartconfig.rst index 7b195c67907..9d95a68fc0f 100644 --- a/docs/en/api-reference/network/esp_smartconfig.rst +++ b/docs/en/api-reference/network/esp_smartconfig.rst @@ -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 ------------- diff --git a/docs/en/api-reference/network/index.rst b/docs/en/api-reference/network/index.rst index 82db052c231..097b37ca8b4 100644 --- a/docs/en/api-reference/network/index.rst +++ b/docs/en/api-reference/network/index.rst @@ -10,7 +10,7 @@ Wi-Fi :maxdepth: 1 Wi-Fi - Smart Config + SmartConfig ESP-NOW ESP Mesh diff --git a/docs/en/api-reference/provisioning/index.rst b/docs/en/api-reference/provisioning/index.rst index c2341ad73aa..18150c2e6f8 100644 --- a/docs/en/api-reference/provisioning/index.rst +++ b/docs/en/api-reference/provisioning/index.rst @@ -10,4 +10,11 @@ Provisioning API Unified Provisioning Wi-Fi 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` diff --git a/docs/en/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst index dee7a199ae4..58b634d6880 100644 --- a/docs/en/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -352,7 +352,7 @@ Once documentation is ready, follow instruction in :doc:`../api-reference/templa OK, but I am new to Sphinx! --------------------------- -1. No worries. All the software you need is well documented. It is also open source and free. Start by checking `Sphinx`_ documentation. If you are not clear how to write using rst markup language, see `reStructuredText Primer `_. You can also use markdown (.md) files, and find out about more about the specific markdown syntax that we use on`Recommonmark parser's documentation page `_. +1. No worries. All the software you need is well documented. It is also open source and free. Start by checking `Sphinx`_ documentation. If you are not clear how to write using rst markup language, see `reStructuredText Primer `_. You can also use markdown (.md) files, and find out about more about the specific markdown syntax that we use on `Recommonmark parser's documentation page `_. 2. Check the source files of this documentation to understand what is behind of what you see now on the screen. Sources are maintained on GitHub in `espressif/esp-idf`_ repository in :idf:`docs` folder. You can go directly to the source file of this page by scrolling up and clicking the link in the top right corner. When on GitHub, see what's really inside, open source files by clicking ``Raw`` button. diff --git a/docs/zh_CN/api-reference/network/esp_smartconfig.rst b/docs/zh_CN/api-reference/network/esp_smartconfig.rst index 24cd50a26c9..00a8e6f6603 100644 --- a/docs/zh_CN/api-reference/network/esp_smartconfig.rst +++ b/docs/zh_CN/api-reference/network/esp_smartconfig.rst @@ -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