Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs
History
lly 711c8472fc ble_mesh: Miscellaneous modifications 
1. Add an API to set Provisioner static oob value
2. Add an API to deinit BLE Mesh stack
3. Add an API to set Provisioner unicast address
4. Add an API to provision devices with fixed address
5. Add an API to store node composition data
6. Add an API to get node with device uuid
7. Add an API to get node with unicast address
8. Add an API to delete node with device uuid
9. Add an API to delete node with unicast address
10. Add an API for Provisioner to update local AppKey
11. Add an API for Provisioner to update local NetKey
12. Support Provisioner persistent functionality
13. Fix Provisioner entering IV Update procedure
14. Fix an issue which may cause client failing to send msg
15. Use bt_mesh.flags to indicate device role
16. Remove several useless macros
17. Callback RSSI of received mesh provisioning packets
18. Modify the Provisioner disable function
19. Change some log level from debug to info
20. Add parameters to Provisioner bind AppKey completion event
21. Fix node ignoring relay messages issue
22. Support using a specific partition for BLE Mesh
23. Fix compile warning when proxy related macros are disabled
24. Clean up BLE Mesh stack included header files
25. NULL can be input if client message needs no parameters
26. Fix compile warning when BT log is disabled
27. Initilize BLE Mesh stack local variables
28. Support using PSRAM for BLE Mesh mutex, queue and task
29. Add a menuconfig option to enable using memory from PSRAM
30. Clean up sdkconfig.defaults of BLE Mesh examples
2020-03-02 02:08:13 +00:00
..
_static Review the file api-reference/peripherals/i2c.rst 2020-01-09 17:04:41 +08:00
en ble_mesh: Miscellaneous modifications 2020-03-02 02:08:13 +00:00
zh_CN ble_mesh: Miscellaneous modifications 2020-03-02 02:08:13 +00:00
check_doc_warnings.sh docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs. 2019-02-27 22:11:59 +01:00
check_lang_folder_sync.sh Revert "docs: Temporarily allow cmake docs to be in English only" 2018-05-07 18:45:49 +08:00
conf_common.py Generate source files for kconfiglib from the build system 2019-11-15 15:25:09 +00:00
docs_common.mk docs: Add ESP-IDF support period policy 2019-10-18 18:25:20 +11:00
Doxyfile Merge branch 'refactor/can_driver' into 'master' 2020-01-10 14:22:02 +08:00
gen-dxd.py docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
gen-toolchain-links.py Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 2019-11-04 16:14:57 +07:00
gen-version-specific-includes.py doc: Fix invalid 'This command will clone master' note in docs 2019-02-19 04:05:39 +00:00
html_redirects.py docs: Add option to redirect documentation pages which have moved 2018-12-18 14:07:43 +11:00
link-roles.py docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
local_util.py Download font file only is not exists in target location 2019-05-21 09:51:39 +08:00
page_redirects.txt esp_netif: docs update to include tcpip_adapter migration guide 2019-11-25 08:32:11 +01:00
README.md doc: Fix doc builds on Windows MINGW32, add some doc build documentation 2018-10-26 04:04:56 +00:00
requirements.txt Docs: Fix sphinxcontrib dependencies 2020-02-13 14:50:31 +01:00
sphinx-known-warnings.txt doc: Remove duplicate ulp-cmake 2020-01-10 16:38:06 +11:00
TEMPLATE_EXAMPLE_README.md examples: Update system examples README 2019-08-28 16:19:40 +08:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.

Building Documentation

  • Install make and doxygen for your platform (make may already be installed as an ESP-IDF prerequisite).
  • Change to either the docs/en or docs/zh_CN subdirectory and run make html
  • make will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run make html to build the docs.

For MSYS2 MINGW32 on Windows

If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:

pacman -S doxygen mingw-w64-i686-python2-pillow

Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.