The application will update the LR1110 firmware using fragments received from the UART.
The companion lr1110_firmware_update.py script will read firmware data from a given file and send fragments to the application through the specified serial interface.
The application defines a basic TLV-based protocol to transfer the fragments. The protocol also defines a couple of auxiliary commands to check the updated firmware version.
All commands start with a specific tag value, coded as a single byte, followed by the length of optional arguments, given in bytes and coded as a 16-bit value. Finally, the message may include optional arguments. All multi-byte values are little-endian (LSB first).
+-----+-----+-----+-----+...+-----+
byte offset | 0 | 1 | 2 | |
+-----+-----+-----+-----+...+-----+
value | tag | length | args |
+-----+-----+-----+-----+...+-----+
This command returns the firmware version. It only works if the LR1110 is either in bootloader mode or runs the Transceiver (TRX) firmware.
+-----+-----+-----+
byte offset | 0 | 1 | 2 |
+-----+-----+-----+
value | 0 | 0 |
+-----+-----+-----+
+-----+-----+-----+-----+-----+-----+-----+
byte offset | 0 | 1 | 2 | 3 | 4 | 5 | 6 |
+-----+-----+-----+-----+-----+-----+-----+
value | 0 | 4 | hw |type | fw |
+-----+-----+-----+-----+-----+-----+-----+
The reply message arguments are copied from the lr1110_bootloader_version_t structure initialized by lr1110_bootloader_get_version(). See the documentation for this structure and function for more information.
This command returns the firmware version. It only works if the LR1110 runs the Modem-E firmware.
+-----+-----+-----+
byte offset | 0 | 1 | 2 |
+-----+-----+-----+
value | 1 | 0 |
+-----+-----+-----+
+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+
byte offset | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 |
+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+
value | 1 | 14 | bootloader | functionality | firmware | LoRaWAN |
+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+
The reply message arguments are copied from the lr1110_modem_version_t structure initialized by lr1110_modem_get_version(). See the documentation for this structure and function for more information.
This command transfers a fragment of firmware from the UART and installs it.
When the application receives this command for the first firmware fragment, it will automatically restart the LR1110 in bootloader mode and erase its flash memory.
When the application receives this command for the last firmware fragment, it will automatically restart the LR1110 and run the new firmware.
+-----+-----+-----+-----+-----+-----+-----+.....+-----+
byte offset | 0 | 1 | 2 | 3 | 4 | 5 | 6 | | N+4 |
+-----+-----+-----+-----+-----+-----+-----+.....+-----+
value | 2 | 2 + N |fragment_id| fragment bytes |
+-----+-----+-----+-----+-----+-----+-----+.....+-----+
fragment_id is an integer value. It starts at zero and is incremented for each new fragment sent.
N is the number of fragments bytes in the message. It must to be equal to 256 except for the last fragment which will be shorter.
The application will reply with the same fragment ID to acknowledge the request.
+-----+-----+-----+-----+-----+
byte offset | 0 | 1 | 2 | 3 | 4 |
+-----+-----+-----+-----+-----+
value | 2 | 2 |fragment_id|
+-----+-----+-----+-----+-----+
The application will display a status using the user LEDs of the LoRa Edge Tracker Reference design.
At startup all three LEDs (TX, RX) will blink twice to indicate that the application is ready.
The application will turn the RX LED on when it is executing a single UART command.
The application will turn the TX LED on when it receives the first firmware fragment and turn it off when it receives the last one.
The lr1110_firmware_update.py script requires that the PySerial module is installed on the host computer. See https://pypi.org/project/pyserial/ for mode information.
You can get binary firmware image files from this GitHub repository.
This script will request and display the new firmware version after installation, for this reason and because different firmware types have incompatible ways of indicating their version, the script must know which kind of firmware it is installing. The type of firmware is given as a command line argument along with the serial interface and firmware binary file.
Generic invocation syntax for the script:
lr1110_firmware_update.py <EVK_COM_PORT> <FILE> [<TYPE>]
The firmware will is assumed to be of 'Modem-E' type if <TYPE> is not specified.
For more information, call the script with the -h option:
$ python3 lr1110_firmware_update.py -h
usage: lr1110_firmware_update.py [-h] [--port PORT] [--file FILE]
[{modem,transceiver}]
Update the LR1110 firmware of a device over a serial link
positional arguments:
{modem,transceiver} Type of firmware
optional arguments:
-h, --help show this help message and exit
--port PORT Device name of the serial port
--file FILE Name of the LR1110 firmware binary file
Example of updating to a new Modem-E firmware:
$ python3 lr1110_firmware_update.py --port /dev/ttyACM0 --file lr1110_modem_1.1.7.bin modem
Sending fragment 0... done.
Sending fragment 1... done.
Sending fragment 2... done.
...
Sending fragment 957... done.
Sending fragment 958... done.
Firmware version:
Bootloader: 0x22df6500
Functionality: 0x00000004
Firmware: 0x00010107
LoRaWAN: 0x00000103
Example of updating to a new Transceiver firmware:
$ python3 lr1110_firmware_update.py --port /dev/ttyACM0 --file lr1110_transceiver_0306.bin transceiver
Sending fragment 0... done.
Sending fragment 1... done.
Sending fragment 2... done.
...
Sending fragment 957... done.
Sending fragment 958... done.
Firmware version:
HW: 0x22
Type: 0x1
FW: 0x306