Add initial attempt at firmware downloads

Author: malcolm-sparkfun

kernel/src/constants.ts

@@ -4,7 +4,8 @@ export interface FirmwareOption {
   url: string;
 }
 
-export const firmwareOptions: Record<string, FirmwareOption> = {
+// Optionally in the future could switch to initialize with this and make it align with a recent-ish release...
+export const defaultFirmwareOptions: Record<string, FirmwareOption> = {
   'auto': {
     name: 'Auto detection',
     url: ''

kernel/src/services/FirmwareService.ts

@@ -1,30 +1,90 @@
-import { firmwareOptions } from '../constants'
+import { FirmwareOption } from '../constants'
 import { DeviceService } from './DeviceService';
 
 export class FirmwareService {
   private firmwareString: string | null = null;
   private firmwareBlob: Blob | null = null;
   private selectedFirmwareId: string = 'Auto';
+  // Should make firmwareOptions a private variable and use getters to access it.
+  // This way we can add logic to the getters if we need to in the future. Default to empty record.
+  private firmwareOptions: Record<string, FirmwareOption> = {};
 
   constructor(private deviceService: DeviceService) {
     const savedSelection = localStorage.getItem('selectedFirmwareId');
+    // Get the firmware options from GitHub (or local files).
+    // Maybe we'll add an explicit button for updating the firmware options in the future...
+    // We'll initialize our private firmwareOptions here with the reqFirmwareOptionsGitHub() method.
+    this.reqFirmwareOptionsGitHub().then((res) => {
+      this.firmwareOptions = res;
+    })
+  
     if (savedSelection) {
       this.selectedFirmwareId = savedSelection;
     } else {
       this.selectedFirmwareId = 'auto';
     }
   }
 
-  getFirmwareOptions(){
+  // We'll use this method to fetch the firmware options from GitHub.
+  // We could alternatively use local files in ../binaries/ so we aren't sending a request to GitHub every time.
+  private async reqFirmwareOptionsGitHub(): Promise<Record<string, FirmwareOption>> {
+    const releases = await fetch('https://api.github.com/repos/sparkfun/micropython/releases', {
+      method: 'GET'
+    });
+
+    if (!releases.ok) {
+      throw new Error(`Failed to fetch releases: ${releases.status} ${releases.statusText}`);
+    }
+    const releasesData = await releases.json();
+    const firmwareOptions: Record<string, FirmwareOption> = {};
+
+    firmwareOptions['auto'] = {
+      name: 'Auto detection',
+      url: ''
+    };
+
+    // Take the first release and iterate through the assets to populate the firmware options.
+    const latestRelease = releasesData[0];
+    if (latestRelease && latestRelease.assets) {
+      latestRelease.assets.forEach((asset: any) => {
+        // We should make the name the full name of the asset but the key the firmwareId (the board name in lowercase with dashes and an optional "m" prefix for minimal).
+        const firmwareName = asset.name;
+        var firmwareId = firmwareName.replace(/\.uf2|\.zip/g, '').toLowerCase().replace(/_/g, '-');
+
+        if (firmwareName.startsWith('MINIMAL_')) {
+          firmwareId = 'm-' + firmwareId.replace('minimal-', '');
+        }
+        const firmwareUrl = asset.browser_download_url;
+
+        const firmwareOption: FirmwareOption = {
+          name: firmwareName,
+          url: firmwareUrl
+        };
+        firmwareOptions[firmwareId] = firmwareOption;
+      });
+    }
+    
+    // Add the local firmware option.
+    firmwareOptions['local'] = {
+      name: 'Local firmware upload',
+      url: ''
+    };
+
     return firmwareOptions;
   }
 
+  // This is where we can add our logic of fetching from GitHub.
+  // We could alternatively use local files in ../binaries/ so we aren't sending a request to GitHub every time.
+  getFirmwareOptions(){
+    return this.firmwareOptions;
+  }
+
   getSelectedFirmwareId(): string {
     return this.selectedFirmwareId;
   }
 
   setSelectedFirmwareId(id: string): void {
-    if (id in firmwareOptions){
+    if (id in this.firmwareOptions) {
       this.selectedFirmwareId = id;
       this.firmwareString = null;
       this.firmwareBlob = null;
@@ -67,8 +127,9 @@ export class FirmwareService {
     return this.downloadSpecificFirmware(firmwareId);
   }
 
+  // TODO: This is where we can add our logic of fetching from GitHub
   private async downloadSpecificFirmware(firmwareId: string): Promise<string> {
-    const selectedFirmware = firmwareOptions[firmwareId]
+    const selectedFirmware = this.firmwareOptions[firmwareId]
     if (!selectedFirmware || !selectedFirmware.url) {
       throw new Error(`Invalid firmware selection or no URL for: ${firmwareId}`);
     }