Skip to content

Commit 53c1d6d

Browse files
committed
docs(general_notes): Add general notes to main page of document
1 parent 7a660b4 commit 53c1d6d

File tree

3 files changed

+34
-5
lines changed

3 files changed

+34
-5
lines changed

Diff for: docs/_static/general-notes.gif

7.61 KB
Loading

Diff for: docs/en/general-notes/index.rst

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
*************
2+
General Notes
3+
*************
4+
5+
Adding this content here is to improve the user's development efficiency and avoid stepping into known problems.
6+
7+
1. Bootloader
8+
^^^^^^^^^^^^^
9+
10+
V3.1 updated the bootloader to initialize SPI flash I/O mode and clock. So if you are using the V3.0 bootloader,
11+
and now upgrade to the new SDK, please disable the following configuration in the menuconfig:
12+
13+
- "Bootloader config ---> [ ] Bootloader init SPI flash"
14+
15+
2. Sniffer or Smartconfig
16+
^^^^^^^^^^^^^^^^^^^^^^^^^
17+
18+
We moved some functions from IRAM to flash, including `malloc` and `free` fucntions, to save more memory.
19+
In this case, please do not read/write/erase flash during sniffer/promiscuous mode.
20+
You need to disable the sniffer/promiscuous mode at first, then read/write/erase flash.
21+
22+
3. ESP8285 or ESP8266 + 1MB flash
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
ESP8285 or ESP8266 + 1MB flash can use "Copy OTA Mode" for OTA, more details are in the `examples/system/ota <https://github.com/espressif/ESP8266_RTOS_SDK/tree/master/examples/system/ota/>`_.

Diff for: docs/en/index.rst

+9-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ ESP8266\_RTOS\_SDK (IDF Style) Programming Guide
33

44
This is the documentation for the new `ESP8266_RTOS_SDK <https://github.com/espressif/ESP8266_RTOS_SDK>`_ which refacted to be ESP-IDF Style. ESP8266\_RTOS\_SDK is the official development framework for the `ESP8266EX <https://www.espressif.com/en/products/hardware/esp8266ex/overview>`_ chip.
55

6-
================== ================== ==================
7-
|Get Started|_ |API Reference|_ |API Guides|_
8-
------------------ ------------------ ------------------
9-
`Get Started`_ `API Reference`_ `API Guides`_
10-
================== ================== ==================
6+
================== ================== ================== ==================
7+
|Get Started|_ |API Reference|_ |API Guides|_ |General Notes|_
8+
------------------ ------------------ ------------------ ------------------
9+
`Get Started`_ `API Reference`_ `API Guides`_ `General Notes`_
10+
================== ================== ================== ==================
1111

1212
.. |Get Started| image:: ../_static/get-started.gif
1313
.. _Get Started: get-started/index.html
@@ -18,11 +18,15 @@ This is the documentation for the new `ESP8266_RTOS_SDK <https://github.com/espr
1818
.. |API Guides| image:: ../_static/api-guides.gif
1919
.. _API Guides: api-guides/index.html
2020

21+
.. |General Notes| image:: ../_static/general-notes.gif
22+
.. _General Notes: general-notes/index.html
23+
2124
.. toctree::
2225
:hidden:
2326

2427
Get Started <get-started/index>
2528
API Reference <api-reference/index>
2629
API Guides <api-guides/index>
30+
General Notes <general-notes/index>
2731

2832
* :ref:`genindex`

0 commit comments

Comments
 (0)