Skip to content

Commit c811153

Browse files
committed
docs: fota: Add more details to FOTA module documentation
Add some more detail on the FOTA module operations. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
1 parent 7a358af commit c811153

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

docs/modules/fota.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
1-
# FOTA module
1+
# FOTA Module
22

3-
The FOTA (Firmware Over-The-Air) module manages firmware updates for both the application and, if supported, modem firmware. It interacts with nRF Cloud to check for available updates, coordinates the download of new firmware images, and handles the application or activation of the firmware.
3+
The FOTA (Firmware Over-The-Air) module manages remote firmware updates for both application and modem firmware. It handles all the stages of the update process:
4+
5+
* Polling nRF Cloud for available updates
6+
* Downloading firmware images
7+
* Applying updates
8+
9+
The update process begins when the module receives a `FOTA_POLL_REQUEST` message, typically triggered by the main application module. When an update is available, the module automatically initiates the download without requiring additional commands.
10+
11+
The module supports three firmware image types:
12+
13+
* **Application**: Updates the main application firmware
14+
* **Delta Modem**: Incremental modem firmware updates for minor version changes
15+
* **Full Modem**: Complete modem firmware replacements
16+
17+
Application and delta modem images are marked ready for their respective bootloaders after download is completed and applied automatically on the next device reboot. When these downloads complete successfully, the module publishes a `FOTA_SUCCESS_REBOOT_NEEDED` message to indicate that a reboot is required to apply the update.
18+
19+
Full modem updates require that the device disconnects from the network before applying the update. For these updates, the module first sends a `FOTA_IMAGE_APPLY_NEEDED` message. The main application must then:
20+
1. Disconnect from the cellular network
21+
2. Send a `FOTA_IMAGE_APPLY` message to the FOTA module
22+
3. Wait for the `FOTA_SUCCESS_REBOOT_NEEDED` message that indicates successful application of the new modem firmware.
23+
24+
All update operations feature error handling with appropriate status messages, allowing the application to recover gracefully from download failures or interruptions.
425

526
## Messages
627

0 commit comments

Comments
 (0)