update firmware of wifi101 and wifiNINA to latest stable version

Author: Alberto Iannaccone

demo/app.jsx

@@ -50,6 +50,17 @@ const handleBootloaderMode = (e, port) => {
   daemon.setBootloaderMode(port);
 };
 
+const handleUpdateFirmware = (e, boardId, port, wifiModule) => {
+  e.preventDefault();
+  daemon.updateFirmware(boardId, port, wifiModule).then(response => {
+    console.log('Firmware updated successfully!')
+    console.log(response)
+  }).catch(reason => {
+    console.log('Something went wrong when trying to update the firmware')
+    console.error(reason)
+  });
+};
+
 const handleDownloadTool = e => {
   e.preventDefault();
   const toolname = document.getElementById('toolname');
@@ -179,6 +190,10 @@ class App extends React.Component {
           close
       </a> - <a href="#" onClick={(e) => handleBootloaderMode(e, device.Name)}>
           bootloader mode
+      </a> - <a href="#" onClick={(e) => handleUpdateFirmware(e, 'mkrwifi1010', device.Name, 'wifiNina')}>
+          Wifi NINA update firmware
+      </a> - <a href="#" onClick={(e) => handleUpdateFirmware(e, 'mkr1000', device.Name, 'wifi101')}>
+          Wifi 101 update firmware
       </a>
     </li>);
 

src/daemon.js

@@ -25,8 +25,36 @@ import {
   takeUntil, filter, startWith, first, distinctUntilChanged
 } from 'rxjs/operators';
 
+const versionsMap = {
+  wifi101: {
+    latestVersion: 'WINC1500 19.5.4',
+    loaderPath: null,
+    latestVersionPath: null
+  },
+  wifiNina: {
+    latestVersion: 'NINA 1.2.2',
+    loaderPath: null,
+    latestVersionPath: null
+  }
+};
+
 const POLLING_INTERVAL = 1500;
 
+/* The status of the Firmware Updater Tool */
+const FWUToolStatusEnum = Object.freeze({
+  NOPE: 'NOPE',
+  OK: 'OK',
+  CHECKING: 'CHECKING',
+  ERROR: 'ERROR DOWNLOADING TOOL'
+});
+
+/* The signatures needed to run the commands to use the Firmware Updater Tool */
+const signaturesEnum = Object.freeze({
+  GET_FIRMWARE_INFO: 'aceffd98d331df0daa5bb3308bb49a95767d77e7a1557c07a0ec544d2f41c3ec67269f01ce9a63e01f3b43e087ab8eb22b7f1d34135b6686e8ce27d4b5dc083ec8e6149df11880d32486448a71280ef3128efccbd45a84dbd7990a9420a65ee86b3822edba3554fa8e6ca11aec12d4dd99ad072285b98bfdf7b2b64f677da50feb8bddef25a36f52d7605078487d8a5d7cbdc84bfa65d510cee97b46baefea149139a9a6ed4b545346040536e33d850e6ad84c83fe605f677e2ca77439de3fa42350ce504ad9a49cf62c6751d4c2a284500d2c628cd52cd73b4c3e7ef08ae823eb8941383f9c6ff0686da532369d3b266ded8fdd33cca1a128068a4795920f25',
+  UPLOAD_FIRMWARE_BOSSAC: 'b2137435f74601a0b1b090ca1592b14199c1c79c87cecac4bb168456b570f17b635f438f5cd80649a101ab27085394e4a0e92f41a2b1b65932789eee8c3ebf39633a503a8a53d3291944afe10ff88f6ea06b0fd7fd7de6d70b302df3a92091a2abe2691ad1aeee051e4bb69f6afa3bd41e643855769347dca018804ae97bcb1331df796fd8921a11b333b45bebe430d323ddd151a907e8fb0e875a45d093cdb4332ec3dbd72a50341b538e058b3f25d4a528bea514b96b8e0701032d64232b7141c62f2231352f4197a1011292a4c3e900c133824e148f3703ea8374873d9097578146819e62685f1a8cbc442dd435ea603136c86ecf028df39fd10a8b3499c6',
+  UPLOAD_FIRMWARE_AVRDUDE: '68ed3d9abdc7c77d01223d09c7ae55b08b8ff94f2a42d21a672effb4bdeeb12b10177e831805b3037d9f8d38e8eeeb8327b6c4691731a2a146cfd12398e5a12596e097160ae8d84fc488650ee57439f7fcd83f27d01e9834de555ceec7dc6951b3be5e5a3507752dce8e4ba1f6f9e6494162d537009db899882b9c4fca0868ad446b82fdeabf93bc30c5a39f8fe9c25e799842a10f4171e2896a0e19667b34258f06494663a4a102bcf9fd61d1ff8ebec18204bbd1a66de3e0b53e257ce521b41999dc82428539086ae9a4a5ea7112d87c05a2782cdace0e6576b162294f9ba47c658cc40999ba31be8a129689a703f6c4182055a600b6e41d450fad2896180d'
+});
+
 export default class Daemon {
   constructor(boardsUrl = 'https://builder.arduino.cc/v3/boards') {
     this.BOARDS_URL = boardsUrl;
@@ -78,6 +106,12 @@ export default class Daemon {
     this.downloadingError = this.downloading.pipe(filter(download => download.status === this.DOWNLOAD_ERROR))
       .pipe(first())
       .pipe(takeUntil(this.downloadingDone));
+
+    this.downloadingDone.subscribe(() => {
+      this.FWUToolStatus = FWUToolStatusEnum.OK;
+    });
+
+    this.FWUToolStatus = FWUToolStatusEnum.NOPE;
   }
 
   notifyUploadError(err) {
@@ -177,4 +211,175 @@ export default class Daemon {
     });
     this.openSerialMonitor(port, 1200);
   }
+
+  getFirmwareInfo(boardId, port, wifiModule) {
+    return new Promise((resolve, reject) => {
+      let versionsList = [];
+      let firmwareInfoMessagesSubscription;
+
+      const handleFirmwareInfoMessage = message => {
+        switch (message.ProgrammerStatus) {
+          case 'Starting':
+            break;
+          case 'Busy':
+            if (message.Msg.indexOf('Flashing with command:') >= 0) {
+              return;
+            }
+            const versions = JSON.parse(message.Msg);
+            Object.keys(versions).forEach(v => {
+              if (versions[v][0].IsLoader) {
+                versionsMap[wifiModule].loaderPath = versions[v][0].Path;
+              }
+              else {
+                versionsList = [...versionsList, ...versions[v]];
+              }
+            });
+            const latestVersion = versionsList.find(version => version.Name === versionsMap[wifiModule].latestVersion)
+            versionsMap[wifiModule].latestVersionPath = latestVersion.Path;
+            break;
+          case 'Error':
+            return reject(`Couldn't get firmware info: ${message}`)
+            firmwareInfoMessagesSubscription.unsubscribe();
+            break;
+          case 'Done':
+            firmwareInfoMessagesSubscription.unsubscribe();
+            return resolve(versionsList);
+            break;
+          default:
+            break;
+        }
+      }
+    
+      if (this.FWUToolStatus !== FWUToolStatusEnum.OK) {
+        return reject(`Can't get firmware info: couldn't find firmware updater tool`)
+      }
+
+      firmwareInfoMessagesSubscription = this.appMessages.subscribe(message => {
+        if (message.ProgrammerStatus) {
+          handleFirmwareInfoMessage(message);
+        }
+      });
+      const data = {
+        board: boardId,
+        port,
+        commandline: `"{runtime.tools.fwupdater.path}/updater" -get_available_for {network.password}`,
+        signature: signaturesEnum.GET_FIRMWARE_INFO,
+        extra: {
+          auth: {
+            password: boardId
+          }
+        },
+        filename: 'ListFirmwareVersionsInfo.bin'
+      };
+  
+      return fetch(`${this.pluginURL}/upload`, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'text/plain; charset=utf-8'
+        },
+        body: JSON.stringify(data)
+      }).then(response => {
+        if (!response.ok) {
+          return reject(`Error fetching ${this.pluginURL}/upload`);
+        }
+      }).catch(reason => {
+        return reject(`Coudln't list firmware versions info.`);
+      });  
+    }) 
+  }
+
+  /*
+    wifiModule can be either 'wifiNina' or 'wifi101'
+  */
+  updateFirmware(boardId, port, wifiModule) {
+    return new Promise((resolve, reject) => {
+      if (!port) {
+        return reject(`Can't update Firmware: no port selected.`);
+      }
+      this.getFirmwareInfo(boardId, port, wifiModule).then(versionsList => {
+        if (!versionsMap[wifiModule] && !versionsMap[wifiModule].latestVersion) {
+          return reject(`Can't update Firmware: couldn't find module '${wifiModule}'`);
+        }
+        const latestVersion = versionsList.find(version => version.Name === versionsMap[wifiModule].latestVersion);
+        if (!latestVersion) {
+          return reject(`Can't update Firmware: couldn't find version '${versionsMap[wifiModule].latestVersion}' for module '${versionsMap[wifiModule]}'`);
+        }
+
+        let updateFirmwareMessagesSubscription;
+        
+        const handleFirmwareUpdateMessage = message => {
+          switch (message.ProgrammerStatus) {
+            case 'Error':
+              return reject(`Can't update Firmware: ${message.Msg}`)
+              updateFirmwareMessagesSubscription.unsubscribe();
+              break;
+            case 'Done':
+              return resolve();
+              updateFirmwareMessagesSubscription.unsubscribe();
+              break;
+            default:
+              break;
+          }
+        }
+
+        updateFirmwareMessagesSubscription = this.appMessages.subscribe(message => {
+          if (message.ProgrammerStatus) {
+            handleFirmwareUpdateMessage(message);
+          }
+        });
+
+        let addresses = '';
+        const rootCertificates = [{
+          domain: 'arduino.cc',
+          port: 443
+        }];
+    
+        rootCertificates.forEach(address => {
+          if (address.domain && address.port) {
+            addresses += `-address ${address.domain}:${address.port} `;
+          }
+        });
+
+        const isUsingAvrdude = boardId === 'uno2018';
+        const programmer = isUsingAvrdude ? '{runtime.tools.avrdude}/bin/avrdude' : '{runtime.tools.bossac}/bossac';
+
+        const loaderPath = versionsMap[wifiModule].loaderPath;
+        if (!loaderPath) {
+          return reject(`Can't update Firmware: invalid loaderPath`);
+        }
+
+        const data = {
+          board: boardId,
+          port,
+          commandline: `"{runtime.tools.fwupdater.path}/updater" -flasher {network.password} -firmware {upload.verbose} -port {serial.port} -restore_binary "{build.path}/{build.project_name}.bin" -programmer ${programmer}`,
+          hex: '',
+          extra: {
+            auth: {
+              password: loaderPath
+            },
+            verbose: true,
+            params_verbose: `${versionsMap[wifiModule].latestVersionPath} ${addresses}` // eslint-disable-line camelcase
+          },
+          signature: isUsingAvrdude ? signaturesEnum.UPLOAD_FIRMWARE_AVRDUDE : signaturesEnum.UPLOAD_FIRMWARE_BOSSAC,
+          filename: 'CheckFirmwareVersion.bin'
+        };
+
+        fetch(`${this.pluginURL}/upload`, {
+          method: 'POST',
+          headers: {
+            'Content-Type': 'text/plain; charset=utf-8'
+          },
+          body: JSON.stringify(data)
+        }).then(response => {
+          if (!response.ok) {
+            return reject(`Can't update Firmware: Error fetching ${this.pluginURL}/upload`);
+          }
+        }).catch(reason => {
+          return reject(`Can't update Firmware: ${reason}`)
+        });
+      }).catch(reason => {
+        return reject(reason)
+      });
+    })
+  }
 }

src/socket-daemon.js

@@ -209,6 +209,7 @@ export default class SocketDaemon extends Daemon {
       if (!driversRequested) {
         this.downloadTool('windows-drivers', 'latest', 'arduino');
         this.downloadTool('bossac', '1.7.0', 'arduino');
+        this.downloadTool('fwupdater', 'latest', 'arduino');
         driversRequested = false;
       }