%20--%3e%3csvg%20version='1.1'%20id='Layer_1'%20xmlns='http://www.w3.org/2000/svg'%20xmlns:xlink='http://www.w3.org/1999/xlink'%20x='0px'%20y='0px'%20viewBox='0%200%20530.1%2097.1'%20style='enable-background:new%200%200%20530.1%2097.1;'%20xml:space='preserve'%3e%3cstyle%20type='text/css'%3e%20.st0{fill:%23282725;}%20.st1{fill:%23FF471C;}%20%3c/style%3e%3cg%3e%3cpath%20class='st0'%20d='M514,15.9c0,3.5-2.8,6.2-6.1,6.2c-3.4,0-6.1-2.8-6.1-6.2c0-3.4,2.8-6.1,6.1-6.1C511.2,9.7,514,12.5,514,15.9z%20M513.3,15.9c0-2.9-2.4-5.3-5.4-5.3c-3,0-5.4,2.4-5.4,5.3c0,3,2.4,5.4,5.4,5.4C510.9,21.3,513.3,18.9,513.3,15.9z%20M509.2,16.3%20l1.4,3.4h-0.8l-1.2-3.2h-2v2.8c0,0.3-0.1,0.4-0.4,0.4c-0.2,0-0.3-0.1-0.3-0.4v-6.9c0-0.3,0.1-0.4,0.3-0.4h2.2c1.2,0,2.2,1,2.2,2.1%20C510.6,15.2,510,15.9,509.2,16.3z%20M509.8,14.3c0-0.8-0.6-1.4-1.4-1.4h-1.9v2.8h1.9C509.2,15.7,509.8,15.1,509.8,14.3z'/%3e%3c/g%3e%3crect%20x='283.5'%20y='10.4'%20class='st0'%20width='3.8'%20height='44.2'/%3e%3cpolygon%20class='st0'%20points='248.9,31%20219.2,31%20219.2,10.4%20215.4,10.4%20215.4,54.5%20219.2,54.5%20219.2,34.8%20248.9,34.8%20248.9,54.5%20252.7,54.5%20252.7,10.4%20248.9,10.4%20'/%3e%3cpolygon%20class='st0'%20points='354.8,50.8%20354.5,50.8%20324.8,10.4%20318.7,10.4%20318.7,54.5%20322.5,54.5%20322.5,14.2%20322.9,14.2%20352.5,54.5%20358.6,54.5%20358.6,10.4%20354.8,10.4%20'/%3e%3crect%20x='388.9'%20y='10.4'%20class='st0'%20width='34.3'%20height='3.8'/%3e%3cpath%20class='st0'%20d='M392.7,37.7c0-1.6,1.3-2.9,2.9-2.9h21V31h-21c-3.7,0-6.7,3-6.7,6.7v16.8h34.3v-3.8h-30.5L392.7,37.7L392.7,37.7%20z'/%3e%3cpath%20class='st0'%20d='M33.5,33.7c-0.1,0.1-0.2,0.1-0.3,0.1s-0.2,0-0.3-0.1L16,10.4H9.9v44.1h3.8V14.2h0.4L29.8,36%20c0.8,1.1,2,1.7,3.4,1.7c1.3,0,2.6-0.6,3.4-1.7l15.7-21.7h0.4v40.3h3.8V10.4h-6.1L33.5,33.7z'/%3e%3cpath%20class='st0'%20d='M185.7,41.7c-3.4,6.3-10,10.2-17.2,10.2c-10.8,0-19.5-8.7-19.5-19.4s8.8-19.4,19.5-19.4%20c7.2,0,13.7,3.9,17.2,10.2l0.2,0.3l3.3-1.8l-0.2-0.4c-4.1-7.5-11.9-12.1-20.5-12.1c-12.9,0-23.3,10.4-23.3,23.2s10.5,23.2,23.3,23.2%20c8.6,0,16.4-4.7,20.5-12.2l0.2-0.4l-3.3-1.8L185.7,41.7z'/%3e%3cpath%20class='st0'%20d='M102.4,10.4l11.3,25.3H94.1c-2.6,0-5,1.6-6.1,4l-6.7,14.9h4.2l6-13.3c0.5-1,1.5-1.7,2.7-1.7h21.3l6.7,15h4.2%20l-19.6-44.2L102.4,10.4z'/%3e%3cpath%20class='st1'%20d='M486.7,45c2.8-3.9,4.4-8.7,4.4-13.6c0-16-16.3-28.2-33.1-21.1c-5,2.1-9,6.1-11.1,11.1%20c-7.2,16.8,5.1,33.1,21.1,33.1h26.8V45H486.7z%20M479.6,39.6l-5.4-7.3l-7.7,5.7l5.6,7.6l-4.3,0.1c-7.5,0-14-6.5-14-14%20c0-8.4,6.7-14.4,14.2-14.4c8.4,0,14.2,6.8,14.2,14.5C482.2,34.4,481.2,37.4,479.6,39.6z'/%3e%3c/svg%3e)
FUOTA API Overview
The MachineQ FUOTA (Firmware Update Over The Air) server sends firmware updates to one or many LoRaWAN devices. This page introduces the responsibilities split between the server and the target device, the LoRa Alliance packages the server implements, and the minimal command set a device must support to be updatable.
If you are new to the FUOTA process, we highly recommend starting with the Quick Start Guide, which walks through authenticating and running your first campaign end to end.
What the FUOTA Server Handles
The FUOTA server manages the full lifecycle of an over-the-air update:
- Update scheduling
- Multicast session setup
- Fragmentation setup
- Sending fragments
- Verifying that the device has applied the firmware update
What the Target Device Handles
The target device is responsible for the on-device portion of the update:
- Supporting the core FUOTA packages (listed below)
- Storing the fragments in flash memory
- Applying the firmware (with a bootloader)
Supported LoRa Alliance Packages
The FUOTA server follows the LoRa Alliance standards and currently implements version 1.0.0 of these packages:
| Package | Version |
|---|---|
| Fragmented Data Block Transport | v1.0.0 |
| Remote Multicast Session Setup | v1.0.0 |
| Firmware Management Protocol | v1.0.0 |
Minimal Required FUOTA Commands
Although we highly recommend full support of the FUOTA packages, the following commands are the minimum a device must support:
| Command | FPort | Specification Reference |
|---|---|---|
DevVersionReq |
203 | Firmware Management Protocol Specification, Section 3.2 |
McastGroupSetup |
200 | Remote Multicast Setup Specification, Section 4.3 |
McastClassCSession |
200 | Remote Multicast Setup Specification, Section 4.5 |
FragSessionSetup |
201 | Fragmented Data Block Transport Specification, Section 3.2 |
FragData |
201 | Fragmented Data Block Transport Specification, Section 3.4 |
Time Synchronization
The device must have a synchronized clock to perform the update. There are two ways to synchronize the clock:
- Using the
DeviceTimeReqMAC command (initiated by the device). The LoRaWAN 1.0.3 Specification adds this command, and the MachineQ Network Server supports it. - Using the Application Layer Clock Synchronization Specification package.
Note: Since most devices use MAC layer clock synchronization, the Application Layer Clock Synchronization Specification package is not currently supported. MQbridge and MQflex synchronize the clock automatically upon joining using
DeviceTimeReq.
What's Next?
- Quick Start Guide: Authenticate and run your first FUOTA campaign end to end.
- Gateway Selection: Learn how gateways are chosen automatically or manually for a campaign.
- Frequently Asked Questions: Answers to common questions about keys, classes, and campaign parameters.