Added exercise 5 firmware update implementation #190

malw4 · 2024-05-10T13:15:00Z

No description provided.

JZimnol

@malw4 reviewed. Remember to NOT merge this before the newest pico-client is released.

JZimnol · 2024-05-14T07:22:56Z

docs/academy/exercise5.md

@@ -1,20 +1,446 @@
-# Graduation Project
+# Exercise 5: Implement Firmware Update
+In this exercise, we implement Object 5 - Firmware Update.  It utilizes the pico_fota_bootloader to swap the flash partitions after downloading the appropriate binary file from Coiote IoT DM.


Suggested change

In this exercise, we implement Object 5 - Firmware Update. It utilizes the pico_fota_bootloader to swap the flash partitions after downloading the appropriate binary file from Coiote IoT DM.

In this exercise, we implement Object 5 - Firmware Update. It utilizes the [pico_fota_bootloader](https://github.com/JZimnol/pico_fota_bootloader) to swap the flash partitions after downloading the appropriate binary file from Coiote IoT DM.

JZimnol · 2024-05-14T07:23:34Z

docs/academy/exercise5.md


-Your graduation project involves building an application that utilizes the LwM2M standard and the {{ coiote_long_name }}. Whether you choose the Raspberry Pi Pico W or any other IoT device, your task is to effectively gather sensor data and establish a cloud connection.
+* A Raspberry Pi Pico W board with a USB cable
+* A LM35 temperature sensor


Is it really needed in this exercise?

sorry, copy and paste gone wrong

JZimnol · 2024-05-14T07:26:33Z

docs/academy/exercise5.md

-* [Getting Started guides](https://iotdevzone.avsystem.com/docs/LwM2M_Client/Getting_started/) containing detailed documentation on using different IoT development kits
-* [AVSystem Discord](https://discord.avsystem.com/) for support and for submitting your graduation project
+!!! Note
+    This part only describes functions that are in the code. The user doesn’t have to modify the code.


It doesn't say where the code can be found.

JZimnol · 2024-05-14T07:29:13Z

docs/academy/exercise5.md


-!!! important "Provide your feedback"
+<p style="text-align: center;">firmware_update.h</p>
+```


All code snippets should start with "```c", this way the syntax can be colored.

JZimnol · 2024-05-14T07:30:38Z

docs/academy/exercise5.md

+<p style="text-align: center;">main.c</p>
+```
+#include "lwip/sockets.h"
+#include <anjay/anjay.h>
+#include <anjay/core.h>
+#include <anjay/security.h>
+#include <anjay/server.h>
+#include <avsystem/commons/avs_list.h>
+#include <avsystem/commons/avs_log.h>
+#include <avsystem/commons/avs_prng.h>
+#include <avsystem/commons/avs_time.h>
+
+#include "firmware_update.h"
+```


If the user doesn't need to modify the code, this code snippet that shows the #include "firmware_update.h" is useless and can be removed.

JZimnol · 2024-05-14T07:55:04Z

docs/academy/exercise5.md

+1. Click **Schedule Update** to trigger the Firmware Update process.
+
+!!! Note
+    After doing so, a Firmware Update process will begin. Check the serial output logs - `the INFO [fw_update] [/anjay-pico-client/firmware_update/firmware_update.c]: Downloaded X bytes` logs should appear.


Suggested change

After doing so, a Firmware Update process will begin. Check the serial output logs - `the INFO [fw_update] [/anjay-pico-client/firmware_update/firmware_update.c]: Downloaded X bytes` logs should appear.

After doing so, a Firmware Update process will begin. Check the serial output logs - the `INFO [fw_update] [/anjay-pico-client/firmware_update/firmware_update.c]: Downloaded X bytes` logs should appear.

JZimnol · 2024-05-14T07:57:15Z

docs/academy/exercise5.md

+![Successful update](images/success.png)
+
+!!! note
+    While the device is updating its firmware, it will deregister and reboot using the new firmware. This process may time several minutes.


reboot using the new firmware sounds... strange

look at this https://iotdevzone.avsystem.com/docs/Coiote_IoT_DM/Single_update/#download-upgrade-process. There is also this note

JZimnol · 2024-05-14T07:58:11Z

docs/academy/exercise5.md

+
+### Monitoring the update process
+
+During the update process, the status of the firmware update can be monitored by reviewing the Resources **State** `/5/*/3` and **Update Results** `/5/*/5`.


/5 is a single instance object, so no *.

JZimnol · 2024-05-14T08:05:45Z

docs/academy/exercise5.md

+4. **Updated** `state 0` & `update result 1`
+
+!!! important "Update successful?"
+    Does the **State** `/5/*/3` report `0` and the **Update Results** `/5/*/5` report `1`? Congratulations! You've successfully updated the firmware of your device. 🎉


Suggested change

Does the **State** `/5/*/3` report `0` and the **Update Results** `/5/*/5` report `1`? Congratulations! You've successfully updated the firmware of your device. 🎉

Does the **State** `/5/*/3` report `0` and the **Update Result** `/5/*/5` report `1`? Congratulations! You've successfully updated the firmware of your device 🎉

JZimnol · 2024-05-14T08:08:55Z

docs/academy/gradproject.md

+
+    We're constantly working on improving the LwM2M Academy. Please share with us your feedback about this module so we can create an even better learning experience.
+
+    [Feedback form](https://forms.gle/UAFLJs9LJocAeger9){: .md-button .md-button--big }


The feedback form does not include the Module 5 Exercise

JZimnol

@malw4 re-reviewed.

JZimnol · 2024-05-21T07:26:43Z

docs/academy/exercise5.md

-* [Getting Started guides](https://iotdevzone.avsystem.com/docs/LwM2M_Client/Getting_started/) containing detailed documentation on using different IoT development kits
-* [AVSystem Discord](https://discord.avsystem.com/) for support and for submitting your graduation project
+!!! Note
+    This part only describes functions that are in the code in **Anjay-pico-client/firmware_update** folder. The user doesn’t have to modify the code.


Suggested change

This part only describes functions that are in the code in **Anjay-pico-client/firmware_update** folder. The user doesn’t have to modify the code.

This part only describes functions that are in the code in **Anjay-pico-client/firmware_update** directory. The user doesn’t have to modify the code.

JZimnol · 2024-05-21T07:28:27Z

docs/academy/exercise5.md

+
+<p style="text-align: center;">flash_aligned_writer.c</p>
+``` c
+    #include <assert.h>


You've indented the code, but not the whole section. It renders badly. Applies for other code snippets.

JZimnol · 2024-05-21T07:36:31Z

docs/academy/module5.md

@@ -73,6 +73,11 @@ Learn more about the Firmware Update Object on the [OMA LwM2M Object and Resourc
    | `update result 10`  | **Firmware update cancelled** |
    | `update result 11`  | **Firmware update deferred** |

+
+## What is Bootloader and why do I need this here?


No no no, this place is z dupy for that in my opinion. THis hsould be in Exercise 5, before Implement Firmware Update for example.

JZimnol · 2024-05-21T07:40:44Z

docs/academy/exercise5.md

It is single instance, so no *.

JZimnol

The code snippets in firmware_update.c are still not up to date or are incorrect.

JZimnol · 2024-05-28T06:39:34Z

docs/academy/exercise5.md

-        out_writer->writer_cb = writer_cb;
-    }
+    <p style="text-align: center;">flash_aligned_writer.c</p>
+    ``` c


The whole code is still indented not the way it should be. The "code section" is OK itself, the code inside is indented unnecessarily.

JZimnol · 2024-05-28T06:40:47Z

docs/academy/exercise5.md

+        void flash_aligned_writer_new(uint8_t *batch_buf,
+                                    size_t batch_buf_max_len_bytes,


Suggested change

void flash_aligned_writer_new(uint8_t *batch_buf,

size_t batch_buf_max_len_bytes,

void flash_aligned_writer_new(uint8_t *batch_buf,

size_t batch_buf_max_len_bytes,

And everywhere else, the code is not aligned after copy-paste.

JZimnol

@malw4 approving in advance, but please make any necessary changes discussed privately

added exercise 5 firmware update implementation

f1a0289

malw4 requested review from JZimnol and Pantofel102 May 10, 2024 13:15

JZimnol reviewed May 14, 2024

View reviewed changes

after first review

594afb1

JZimnol reviewed May 21, 2024

View reviewed changes

after review

0eb0a1b

JZimnol reviewed May 28, 2024

View reviewed changes

fixed problems with alignment

2fe4f31

JZimnol approved these changes May 31, 2024

View reviewed changes

fixed code snippets

cd121e7

malw4 merged commit 3fd28fd into AVSystem:master May 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added exercise 5 firmware update implementation #190

Added exercise 5 firmware update implementation #190

malw4 commented May 10, 2024

JZimnol left a comment

JZimnol May 14, 2024

JZimnol May 14, 2024

malw4 May 15, 2024

JZimnol May 14, 2024

JZimnol May 14, 2024

JZimnol May 14, 2024

JZimnol May 14, 2024

JZimnol May 14, 2024

malw4 May 15, 2024

JZimnol May 14, 2024

JZimnol May 14, 2024

JZimnol May 14, 2024

JZimnol left a comment

JZimnol May 21, 2024

JZimnol May 21, 2024

JZimnol May 21, 2024

JZimnol May 21, 2024

JZimnol left a comment

JZimnol May 28, 2024

JZimnol May 28, 2024

JZimnol left a comment

	In this exercise, we implement Object 5 - Firmware Update. It utilizes the pico_fota_bootloader to swap the flash partitions after downloading the appropriate binary file from Coiote IoT DM.
	In this exercise, we implement Object 5 - Firmware Update. It utilizes the [pico_fota_bootloader](https://github.com/JZimnol/pico_fota_bootloader) to swap the flash partitions after downloading the appropriate binary file from Coiote IoT DM.

	After doing so, a Firmware Update process will begin. Check the serial output logs - `the INFO [fw_update] [/anjay-pico-client/firmware_update/firmware_update.c]: Downloaded X bytes` logs should appear.
	After doing so, a Firmware Update process will begin. Check the serial output logs - the `INFO [fw_update] [/anjay-pico-client/firmware_update/firmware_update.c]: Downloaded X bytes` logs should appear.


		### Monitoring the update process

		During the update process, the status of the firmware update can be monitored by reviewing the Resources State `/5//3` and Update Results* `/5/*/5`.

	Does the State `/5//3` report `0` and the Update Results* `/5/*/5` report `1`? Congratulations! You've successfully updated the firmware of your device. 🎉
	Does the State `/5//3` report `0` and the Update Result* `/5/*/5` report `1`? Congratulations! You've successfully updated the firmware of your device 🎉


		We're constantly working on improving the LwM2M Academy. Please share with us your feedback about this module so we can create an even better learning experience.

		[Feedback form](https://forms.gle/UAFLJs9LJocAeger9){: .md-button .md-button--big }

	This part only describes functions that are in the code in Anjay-pico-client/firmware_update folder. The user doesn’t have to modify the code.
	This part only describes functions that are in the code in Anjay-pico-client/firmware_update directory. The user doesn’t have to modify the code.

		void flash_aligned_writer_new(uint8_t *batch_buf,
		size_t batch_buf_max_len_bytes,

Added exercise 5 firmware update implementation #190

Added exercise 5 firmware update implementation #190

Conversation

malw4 commented May 10, 2024

JZimnol left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JZimnol left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JZimnol left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JZimnol left a comment

Choose a reason for hiding this comment