Skip to content

Commit 4bdfc55

Browse files
committed
docs(modem): Add migration manual
1 parent 6da2518 commit 4bdfc55

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

docs/esp_modem/en/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ ESP-MODEM Programmers manual
44
.. toctree::
55

66
Brief intro <README>
7+
Migration Guide <migration_guide>
78
C interface <api_docs>
89
C++ interface <cxx_api_docs>
910
Advanced use cases <advanced_api>
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
Migration Guide
2+
===============
3+
4+
ESP-MODEM v2.0 introduces production mode (default) with pre-generated sources for better IDE navigation. Previous behavior (development mode) requires explicit configuration.
5+
6+
Breaking Changes
7+
----------------
8+
9+
**Production Mode (Default)**
10+
- Uses pre-generated sources from ``command/`` directory
11+
- Better IDE navigation and code completion
12+
- Faster compilation
13+
14+
**Development Mode (Optional)**
15+
- Uses macro expansion from ``generate/`` directory
16+
- Enable with ``CONFIG_ESP_MODEM_ENABLE_DEVELOPMENT_MODE=y``
17+
- Required for modifying core ESP-MODEM files
18+
19+
Migration Steps
20+
---------------
21+
22+
**Application Developers:**
23+
No changes required. Production mode is default.
24+
25+
**Library Developers:**
26+
Enable development mode:
27+
28+
.. code-block:: bash
29+
30+
idf.py -D CONFIG_ESP_MODEM_ENABLE_DEVELOPMENT_MODE=y build
31+
32+
**Custom ``*.inc`` Files:**
33+
Use generation script:
34+
35+
.. code-block:: bash
36+
37+
./components/esp_modem/scripts/generate.sh your_file.inc
38+
39+
**Build:**
40+
.. code-block:: bash
41+
42+
idf.py fullclean
43+
idf.py build
44+
45+
New Features (Coming Soon)
46+
--------------------------
47+
48+
**Better URC Handling**
49+
- Enhanced unsolicited result code processing
50+
- Existing URC code remains compatible
51+
52+
**AT-based Networking**
53+
- AT command networking examples now supports multiple connections
54+
55+
Troubleshooting
56+
---------------
57+
58+
**Build errors:** ``idf.py fullclean && idf.py build``
59+
60+
**No IDE completion:** Use production mode (default)
61+
62+
**Custom .inc files:** Use ``./components/esp_modem/scripts/generate.sh your_file.inc``
63+
64+
**Modify core files:** Enable ``CONFIG_ESP_MODEM_ENABLE_DEVELOPMENT_MODE=y``

0 commit comments

Comments
 (0)