Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Provide a brief description of SmartConfig and add link to example

Browse source
This commit is contained in:
Krzysztof Budzynski 2020-05-18 01:02:04 +08:00
parent 1d5ef75c7d
commit e58c0ac3e7
5 changed files with 23 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/en/api-reference/network/esp_smartconfig.rst
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
-------------

2
docs/en/api-reference/network/index.rst
View file

@ -10,7 +10,7 @@ Wi-Fi
:maxdepth: 1
Wi-Fi <esp_wifi>
Smart Config <esp_smartconfig>
SmartConfig <esp_smartconfig>
ESP-NOW <esp_now>
ESP Mesh <esp_mesh>

9
docs/en/api-reference/provisioning/index.rst
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`

2
docs/en/contribute/documenting-code.rst
View file

@ -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 <https://www.sphinx-doc.org/en/stable/rest.html>`_. 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 <https://recommonmark.readthedocs.io/en/latest/>`_.
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 <https://www.sphinx-doc.org/en/stable/rest.html>`_. 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 <https://recommonmark.readthedocs.io/en/latest/>`_.
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.

10
docs/zh_CN/api-reference/network/esp_smartconfig.rst
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