Add get_available_for flag

Author: facchinm

cli/main.go

@@ -1,13 +1,18 @@
 package main
 
 import (
+	"encoding/json"
 	"flag"
-	"github.com/arduino-libraries/FirmwareUpdater/utils/context"
-	"github.com/arduino-libraries/FirmwareUpdater/modules/nina"
-	"github.com/arduino-libraries/FirmwareUpdater/modules/winc"
-	"github.com/arduino-libraries/FirmwareUpdater/modules/sara"
+	"fmt"
 	"log"
+	"os"
 	"strings"
+
+	"github.com/arduino-libraries/FirmwareUpdater/modules/nina"
+	"github.com/arduino-libraries/FirmwareUpdater/modules/sara"
+	"github.com/arduino-libraries/FirmwareUpdater/modules/winc"
+	"github.com/arduino-libraries/FirmwareUpdater/utils"
+	"github.com/arduino-libraries/FirmwareUpdater/utils/context"
 )
 
 var ctx context.Context
@@ -22,18 +27,25 @@ func init() {
 	flag.StringVar(&ctx.BinaryToRestore, "restore_binary", "", "firmware upload binary (precompiled for the right target)")
 	flag.StringVar(&ctx.ProgrammerPath, "programmer", "", "path of programmer in use (avrdude/bossac)")
 	flag.StringVar(&ctx.Model, "model", "", "module model (winc, nina or sara)")
+	flag.StringVar(&ctx.Compatible, "get_available_for", "", "Ask for available firmwares matching a given board")
 }
 
 func main() {
 	flag.Parse()
 
+	if ctx.Compatible != "" {
+		el, _ := json.Marshal(utils.GetCompatibleWith(ctx.Compatible))
+		fmt.Println(string(el))
+		os.Exit(0)
+	}
+
 	if ctx.PortName == "" {
 		log.Fatal("Please specify a serial port")
 	}
 
 	if ctx.Model == "nina" || strings.Contains(ctx.FirmwareFile, "NINA") || strings.Contains(ctx.FWUploaderBinary, "NINA") {
 		nina.Run(ctx)
-	} else if ctx.Model == "winc" || strings.Contains(ctx.FirmwareFile, "WINC") || strings.Contains(ctx.FWUploaderBinary, "WINC"){
+	} else if ctx.Model == "winc" || strings.Contains(ctx.FirmwareFile, "WINC") || strings.Contains(ctx.FWUploaderBinary, "WINC") {
 		winc.Run(ctx)
 	} else {
 		sara.Run(ctx)

utils/context/context.go

@@ -25,6 +25,7 @@ type Context struct {
 	BinaryToRestore  string
 	ProgrammerPath   string
 	Model            string
+	Compatible       string
 }
 
 type Programmer interface {

utils/utils.go

@@ -0,0 +1,81 @@
+package utils
+
+import (
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+type firmware struct {
+	Path     string
+	Name     string
+	IsLoader bool
+}
+
+type combo struct {
+	match  string
+	prefer string
+	avoid  string
+	loader string
+}
+
+func isPreferred(existing bool, path string, board combo) bool {
+	if path == "" {
+		return false
+	}
+	if board.avoid != "" && strings.Contains(path, board.avoid) {
+		return false
+	}
+	if existing && !strings.Contains(path, board.prefer) {
+		return false
+	}
+	return true
+}
+
+func GetCompatibleWith(name string) map[string][]firmware {
+
+	files := make(map[string][]firmware)
+
+	knownBoards := make(map[string]combo)
+	knownBoards["mkr1000"] = combo{match: "(WINC1500)*(3a0)", loader: "WINC1500/Firmware*"}
+	knownBoards["mkrwifi1010"] = combo{match: "(NINA)", loader: "NINA/Firmware*(mkrwifi)*", avoid: "uno"}
+	knownBoards["mkrvidor4000"] = combo{match: "(NINA)", loader: "NINA/Firmware*(mkrvidor)*", avoid: "uno"}
+	knownBoards["uno2018"] = combo{match: "(NINA)", loader: "NINA/Firmware*(unowifi)*", prefer: "uno"}
+	knownBoards["mkrnb1500"] = combo{match: "SARA", loader: "SARA/SerialSARAPassthrough*"}
+
+	listAll := false
+
+	if knownBoards[strings.ToLower(name)].match == "" {
+		listAll = true
+	}
+
+	exePath, _ := os.Executable()
+	root := filepath.Dir(exePath)
+	root = filepath.Join(root, "..", "firmwares")
+
+	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
+		unixPath := filepath.ToSlash(path)
+		parts := strings.Split(unixPath, "/")
+		fancyName := parts[len(parts)-3] + " " + parts[len(parts)-2]
+		loader := regexp.MustCompile(knownBoards[name].loader)
+		fw := regexp.MustCompile(knownBoards[name].match)
+		f := firmware{
+			Path:     path,
+			Name:     fancyName,
+			IsLoader: loader.MatchString(path) && !listAll,
+		}
+		folder := filepath.Dir(path)
+		lowerPath, _ := filepath.Rel(root, path)
+		lowerPath = strings.ToLower(lowerPath)
+		_, alreadyPopulated := files[folder]
+		if listAll || ((fw.MatchString(path) || f.IsLoader) && isPreferred(alreadyPopulated, lowerPath, knownBoards[name])) {
+			files[folder] = append(files[folder], f)
+		}
+		return nil
+	})
+	if err != nil {
+		return files
+	}
+	return files
+}