Skip to content

Commit 34f7d83

Browse files
committed
Merge branch 'docs/new_sdk_load_old_sdk_ap_info' into 'master'
ota: add note how to load old SDK's target AP information (backport v3.2) See merge request sdk/ESP8266_RTOS_SDK!1008
2 parents 78cf0dd + c71358c commit 34f7d83

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

docs/en/api-guides/fota-from-old-new.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Connect your host PC and the ESP8266 to the same AP.
6868
Step 2: Configure and Build
6969
-----------------------------
7070

71-
Here, we use the `SP8266_RTOS_SDK/examples/system/ota <https://github.com/espressif/ESP8266_RTOS_SDK/tree/master/examples/system/ota>`_ example.
71+
Here, we use the :example:`system/ota/native_ota/1MB_flash/new_to_new_with_old` if flash is 1MB or :example:`system/ota/native_ota/2+MB_flash/new_to_new_with_old` if flash is 2MB or larger.
7272

7373
Open a new terminal on your PC, set the following configurations, and then compile the example:
7474

@@ -119,6 +119,17 @@ Configure the flash size according to your actual development board's flash.
119119
- HTTP Server Port: HTTP server port
120120
- HTTP GET Filename: Using "ota.ota.bin" which is the target firmware of the example
121121

122+
5. Select connecting to the original AP
123+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
124+
125+
If users want to connect to the original AP of old SDK, then configurate as following:
126+
127+
::
128+
129+
Example Configuration --->
130+
[*] Connect to the original AP
131+
132+
122133
5. Build the project
123134
^^^^^^^^^^^^^^^^^^^^
124135

@@ -150,3 +161,10 @@ Note
150161

151162
- This "unpacking workflow" will only be executed when it is an old SDK firmware that upgrade to the new SDK firmware, for example, V2.0 upgrade to V3.1. After that, the FOTA in later versions (for example, V3.1 upgrade to later) will be the `normal FOTA workflow <https://github.com/espressif/ESP8266_RTOS_SDK/blob/master/examples/system/ota/README.md>`_.
152163

164+
Inheritance Data
165+
================
166+
167+
Users can perfer to the source code :example_file:`system/ota/native_ota/2+MB_flash/new_to_new_with_old/main/ota_example_main.c` to check
168+
how to load original AP's information.
169+
170+
See structure **old_sysconf** in the file of :component_file:`esp8266/include/internal/esp_system_internal.h` for the organization of this information.

examples/system/ota/native_ota/1MB_flash/new_to_new_with_old/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,13 @@ Configurate the flash size:
101101
(X) 1 MB
102102
```
103103

104+
If you want to connect to the original AP of old SDK, then configurate as following:
105+
106+
```
107+
Example Configuration --->
108+
[*] Connect to the original AP
109+
```
110+
104111
Save your changes, and type `make ota` to build the example to generate the real OTA binary firmware.
105112

106113
The name of final generated binary firmware is `ota.v2_to_v3.ota.bin` and the binary firmware locates at directory of `build`.

examples/system/ota/native_ota/2+MB_flash/new_to_new_with_old/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,13 @@ If you old SDK storing RF parameters is customized and want the new firmware to
9393
[*] Load old RF Parameters
9494
```
9595

96+
If you want to connect to the original AP of old SDK, then configurate as following:
97+
98+
```
99+
Example Configuration --->
100+
[*] Connect to the original AP
101+
```
102+
96103
Save your changes, and type `make ota` to build the example to generate the real OTA binary firmware.
97104

98105
The name of final generated binary firmware is `ota.v2_to_v3.ota.bin` and the binary firmware locates at directory of `build`.

0 commit comments

Comments
 (0)