From c71358cd20796374ead552cd3450d643b069fcec Mon Sep 17 00:00:00 2001 From: dongheng Date: Mon, 15 Jul 2019 14:32:56 +0800 Subject: [PATCH] docs(ota): add note how to load old SDK's target AP information --- docs/en/api-guides/fota-from-old-new.rst | 20 ++++++++++++++++++- .../1MB_flash/new_to_new_with_old/README.md | 7 +++++++ .../2+MB_flash/new_to_new_with_old/README.md | 7 +++++++ 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/en/api-guides/fota-from-old-new.rst b/docs/en/api-guides/fota-from-old-new.rst index d5ca61dc..312d5f58 100644 --- a/docs/en/api-guides/fota-from-old-new.rst +++ b/docs/en/api-guides/fota-from-old-new.rst @@ -68,7 +68,7 @@ Connect your host PC and the ESP8266 to the same AP. Step 2: Configure and Build ----------------------------- -Here, we use the `SP8266_RTOS_SDK/examples/system/ota `_ example. +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. Open a new terminal on your PC, set the following configurations, and then compile the example: @@ -119,6 +119,17 @@ Configure the flash size according to your actual development board's flash. - HTTP Server Port: HTTP server port - HTTP GET Filename: Using "ota.ota.bin" which is the target firmware of the example +5. Select connecting to the original AP +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If users want to connect to the original AP of old SDK, then configurate as following: + +:: + + Example Configuration ---> + [*] Connect to the original AP + + 5. Build the project ^^^^^^^^^^^^^^^^^^^^ @@ -150,3 +161,10 @@ Note - 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 `_. +Inheritance Data +================ + +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 +how to load original AP's information. + +See structure **old_sysconf** in the file of :component_file:`esp8266/include/internal/esp_system_internal.h` for the organization of this information. diff --git a/examples/system/ota/native_ota/1MB_flash/new_to_new_with_old/README.md b/examples/system/ota/native_ota/1MB_flash/new_to_new_with_old/README.md index edff927e..e14e4324 100644 --- a/examples/system/ota/native_ota/1MB_flash/new_to_new_with_old/README.md +++ b/examples/system/ota/native_ota/1MB_flash/new_to_new_with_old/README.md @@ -101,6 +101,13 @@ Configurate the flash size: (X) 1 MB ``` +If you want to connect to the original AP of old SDK, then configurate as following: + +``` + Example Configuration ---> + [*] Connect to the original AP +``` + Save your changes, and type `make ota` to build the example to generate the real OTA binary firmware. The name of final generated binary firmware is `ota.v2_to_v3.ota.bin` and the binary firmware locates at directory of `build`. diff --git a/examples/system/ota/native_ota/2+MB_flash/new_to_new_with_old/README.md b/examples/system/ota/native_ota/2+MB_flash/new_to_new_with_old/README.md index 824287f2..b921e9ac 100644 --- a/examples/system/ota/native_ota/2+MB_flash/new_to_new_with_old/README.md +++ b/examples/system/ota/native_ota/2+MB_flash/new_to_new_with_old/README.md @@ -93,6 +93,13 @@ If you old SDK storing RF parameters is customized and want the new firmware to [*] Load old RF Parameters ``` +If you want to connect to the original AP of old SDK, then configurate as following: + +``` + Example Configuration ---> + [*] Connect to the original AP +``` + Save your changes, and type `make ota` to build the example to generate the real OTA binary firmware. The name of final generated binary firmware is `ota.v2_to_v3.ota.bin` and the binary firmware locates at directory of `build`.