Added "board config" flags and parameters

This is an alternative way to extended FQBN to pass board configuration
options.

Author: cmaglie

arduino/cores/packagemanager/package_manager.go

@@ -119,11 +119,14 @@ func (pm *PackageManager) FindBoardsWithID(id string) []*cores.Board {
 // FindBoard search the board identified by boardArg (board alias or board fqbn).
 // It returns FQBN, RegistereBoard and Board or an error if not found.
 // The board may be present in registry but not installed, in this case o
-func (pm *PackageManager) FindBoard(boardArg string) (*cores.FQBN, *RegisteredBoard, *cores.Board, error) {
+func (pm *PackageManager) FindBoard(boardArg string, config []string) (*cores.FQBN, *RegisteredBoard, *cores.Board, error) {
 	fqbn, registeredBoard, err := pm.Registry.FindBoard(boardArg)
 	if err != nil {
 		return fqbn, registeredBoard, nil, err
 	}
+	if config != nil {
+		fqbn.SetConfigs(config)
+	}
 	board, err := pm.FindBoardWithFQBN(fqbn)
 	return fqbn, registeredBoard, board, err
 }

arduino/cores/packagemanager/package_manager_test.go

@@ -41,12 +41,12 @@ func TestFindBoardWithFQBN(t *testing.T) {
 	pm := packagemanager.NewPackageManager(customHardware, customHardware, customHardware, customHardware)
 	pm.LoadHardwareFromDirectory(customHardware)
 
-	_, _, board, err := pm.FindBoard("arduino:avr:uno")
+	_, _, board, err := pm.FindBoard("arduino:avr:uno", nil)
 	require.Nil(t, err)
 	require.NotNil(t, board)
 	require.Equal(t, board.Name(), "Arduino/Genuino Uno")
 
-	_, _, board, err = pm.FindBoard("arduino:avr:mega")
+	_, _, board, err = pm.FindBoard("arduino:avr:mega", nil)
 	require.Nil(t, err)
 	require.NotNil(t, board)
 	require.Equal(t, board.Name(), "Arduino/Genuino Mega or Mega 2560")
@@ -178,7 +178,7 @@ func TestBoardOptionsFunctions(t *testing.T) {
 	pm := packagemanager.NewPackageManager(customHardware, customHardware, customHardware, customHardware)
 	pm.LoadHardwareFromDirectory(customHardware)
 
-	_, _, nano, err := pm.FindBoard("arduino:avr:nano")
+	_, _, nano, err := pm.FindBoard("arduino:avr:nano", nil)
 	require.Nil(t, err)
 	require.NotNil(t, nano)
 	require.Equal(t, nano.Name(), "Arduino Nano")
@@ -194,7 +194,7 @@ func TestBoardOptionsFunctions(t *testing.T) {
 	expectedNanoCPUValues.Set("atmega168", "ATmega168")
 	require.EqualValues(t, expectedNanoCPUValues, nanoCPUValues)
 
-	_, _, esp8266, err := pm.FindBoard("esp8266:esp8266:generic")
+	_, _, esp8266, err := pm.FindBoard("esp8266:esp8266:generic", nil)
 	require.Nil(t, err)
 	require.NotNil(t, esp8266)
 	require.Equal(t, esp8266.Name(), "Generic ESP8266 Module")
@@ -230,7 +230,7 @@ func TestFindToolsRequiredForBoard(t *testing.T) {
 	loadIndex("http://arduino.esp8266.com/stable/package_esp8266com_index.json")
 	loadIndex("https://adafruit.github.io/arduino-board-index/package_adafruit_index.json")
 	require.NoError(t, pm.LoadHardware())
-	_, _, esp32, err := pm.FindBoard("esp32:esp32:esp32")
+	_, _, esp32, err := pm.FindBoard("esp32:esp32:esp32", nil)
 	require.NoError(t, err)
 	esptool231 := pm.FindToolDependency(&cores.ToolDependency{
 		ToolPackager: "esp32",
@@ -266,7 +266,7 @@ func TestFindToolsRequiredForBoard(t *testing.T) {
 	testConflictingToolsInDifferentPackages()
 	testConflictingToolsInDifferentPackages()
 
-	_, _, feather, err := pm.FindBoard("adafruit:samd:adafruit_feather_m0_express")
+	_, _, feather, err := pm.FindBoard("adafruit:samd:adafruit_feather_m0_express", nil)
 	require.NoError(t, err)
 	require.NotNil(t, feather)
 	featherTools, err := pm.FindToolsRequiredForBoard(feather)

cli/board/board.go

@@ -34,7 +34,7 @@ func NewCommand() *cobra.Command {
 	}
 
 	boardCommand.AddCommand(initAttachCommand())
-	boardCommand.AddCommand(detailsCommand)
+	boardCommand.AddCommand(initDetailsCommand())
 	boardCommand.AddCommand(initListCommand())
 	boardCommand.AddCommand(listAllCommand)
 	boardCommand.AddCommand(initInstallCommand())

cli/board/details.go

@@ -29,13 +29,22 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var detailsCommand = &cobra.Command{
-	Use:     "details <FQBN>",
-	Short:   "Print details about a board.",
-	Long:    "Show information about a board, in particular if the board has options to be specified in the FQBN.",
-	Example: "  " + os.Args[0] + " board details arduino:avr:nano",
-	Args:    cobra.ExactArgs(1),
-	Run:     runDetailsCommand,
+func initDetailsCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "details <FQBN | BOARD_ALIAS>",
+		Short:   "Print details about a board.",
+		Long:    "Show information about a board, in particular if the board has options to be specified in the FQBN.",
+		Example: "  " + os.Args[0] + " board details arduino:avr:nano",
+		Args:    cobra.ExactArgs(1),
+		Run:     runDetailsCommand,
+	}
+	detailsFlags.boardConfig =
+		cmd.Flags().StringSliceP("board-conf", "c", nil, "set a board configuration value. The flag can be used multiple times.\n"+"Example: "+os.Args[0]+" board details arduino:avr:nano -c cpu=atmega168")
+	return cmd
+}
+
+var detailsFlags struct {
+	boardConfig *[]string
 }
 
 func runDetailsCommand(cmd *cobra.Command, args []string) {
@@ -46,8 +55,9 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
 	}
 
 	res, err := board.Details(context.Background(), &rpc.BoardDetailsReq{
-		Instance: inst,
-		Fqbn:     args[0],
+		Instance:    inst,
+		Board:       args[0],
+		BoardConfig: *detailsFlags.boardConfig,
 	})
 
 	if err != nil {

cli/compile/compile.go

@@ -33,7 +33,9 @@ import (
 )
 
 var (
-	boardArg           string   // Board Alias or Board FQBN
+	boardArg    string    // Board Alias or Board FQBN
+	boardConfig *[]string // Board Configuration
+
 	showProperties     bool     // Show all build preferences used instead of compiling.
 	preprocess         bool     // Print preprocessed code to stdout.
 	buildCachePath     string   // Builds of 'core.a' are saved into this path to be cached and reused.
@@ -64,6 +66,8 @@ func NewCommand() *cobra.Command {
 	}
 
 	command.Flags().StringVarP(&boardArg, "board", "b", "", "Board Alias or Board FQBN (e.g. 'arduino:avr:uno')")
+	boardConfig =
+		command.Flags().StringSliceP("board-conf", "c", nil, "set a board configuration value. The flag can be used multiple times.\n"+"Example: "+os.Args[0]+" board details arduino:avr:nano -c cpu=atmega168")
 	command.Flags().StringVarP(&boardArg, "fqbn", "", "", "")
 	command.Flags().MarkDeprecated("fqbn", "use --board instead.")
 	command.Flags().BoolVar(&showProperties, "show-properties", false, "Show all build properties used instead of compiling.")
@@ -107,6 +111,7 @@ func run(cmd *cobra.Command, args []string) {
 	_, err = compile.Compile(context.Background(), &rpc.CompileReq{
 		Instance:         inst,
 		Board:            boardArg,
+		BoardConfig:      *boardConfig,
 		SketchPath:       sketchPath.String(),
 		ShowProperties:   showProperties,
 		Preprocess:       preprocess,

cli/upload/upload.go

@@ -30,7 +30,9 @@ import (
 )
 
 var (
-	boardArg   string
+	boardArg    string
+	boardConfig *[]string
+
 	port       string
 	verbose    bool
 	verify     bool
@@ -49,6 +51,8 @@ func NewCommand() *cobra.Command {
 	}
 
 	uploadCommand.Flags().StringVarP(&boardArg, "board", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
+	boardConfig =
+		uploadCommand.Flags().StringSliceP("board-conf", "c", nil, "set a board configuration value. The flag can be used multiple times.\n"+"Example: "+os.Args[0]+" board details arduino:avr:nano -c cpu=atmega168")
 	uploadCommand.Flags().StringVarP(&boardArg, "fqbn", "", "", "")
 	uploadCommand.Flags().MarkDeprecated("fqbn", "use --board instead.")
 	uploadCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")

commands/board/details.go

@@ -18,9 +18,7 @@ package board
 import (
 	"context"
 	"errors"
-	"fmt"
 
-	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
 )
@@ -32,14 +30,14 @@ func Details(ctx context.Context, req *rpc.BoardDetailsReq) (*rpc.BoardDetailsRe
 		return nil, errors.New("invalid instance")
 	}
 
-	fqbn, err := cores.ParseFQBN(req.GetFqbn())
-	if err != nil {
-		return nil, fmt.Errorf("parsing fqbn: %s", err)
+	boardArg := req.GetBoard()
+	if boardArg == "" {
+		boardArg = req.GetFqbn() // Deprecated: use FQBN for old client.
 	}
-
-	_, _, board, _, _, err := pm.ResolveFQBN(fqbn)
+	fqbn, _, board, err := pm.FindBoard(boardArg, req.GetBoardConfig())
+	// TODO: do not ignore *RegisteredBoard result, but output data from it?
 	if err != nil {
-		return nil, fmt.Errorf("loading board data: %s", err)
+		return nil, err
 	}
 
 	details := &rpc.BoardDetailsResp{}

commands/board/install.go

@@ -35,7 +35,7 @@ func Install(ctx context.Context, req *rpc.BoardInstallReq,
 		return nil, errors.New("invalid instance")
 	}
 
-	fqbn, _, _, err := pm.FindBoard(req.GetBoard())
+	fqbn, _, _, err := pm.FindBoard(req.GetBoard(), nil)
 	if err != nil {
 		return nil, errors.Errorf("board '%s' not found: %s", req.GetBoard(), err)
 	}

commands/compile/compile.go

@@ -96,7 +96,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		return nil, errors.Errorf("no board provided")
 	}
 
-	fqbn, _, _, err := pm.FindBoard(boardArg)
+	fqbn, _, _, err := pm.FindBoard(boardArg, req.GetBoardConfig())
 	if err != nil {
 		return nil, errors.Errorf("board '%s' not found: %s", req.GetBoard(), err)
 	}

commands/upload/upload.go

@@ -80,7 +80,7 @@ func Upload(ctx context.Context, req *rpc.UploadReq, outStream io.Writer, errStr
 	}
 
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
-	fqbn, _, _, err := pm.FindBoard(boardArg)
+	fqbn, _, _, err := pm.FindBoard(boardArg, req.GetBoardConfig())
 	if err != nil {
 		return nil, errors.Errorf("board '%s' not found: %s", req.GetBoard(), err)
 	}