Skip to content

Commit 22fc34a

Browse files
cmagliecmaglie
committed
Added "board config" flags and parameters
This is an alternative way to extended FQBN to pass board configuration options.
1 parent 634b77b commit 22fc34a

File tree

15 files changed

+227
-164
lines changed

15 files changed

+227
-164
lines changed

‎arduino/cores/packagemanager/package_manager.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,14 @@ func (pm *PackageManager) FindBoardsWithID(id string) []*cores.Board {
119119
// FindBoard search the board identified by boardArg (board alias or board fqbn).
120120
// It returns FQBN, RegistereBoard and Board or an error if not found.
121121
// The board may be present in registry but not installed, in this case o
122-
func (pm *PackageManager) FindBoard(boardArg string) (*cores.FQBN, *RegisteredBoard, *cores.Board, error) {
122+
func (pm *PackageManager) FindBoard(boardArg string, config []string) (*cores.FQBN, *RegisteredBoard, *cores.Board, error) {
123123
fqbn, registeredBoard, err := pm.Registry.FindBoard(boardArg)
124124
if err != nil {
125125
return fqbn, registeredBoard, nil, err
126126
}
127+
if config != nil {
128+
fqbn.SetConfigs(config)
129+
}
127130
board, err := pm.FindBoardWithFQBN(fqbn)
128131
return fqbn, registeredBoard, board, err
129132
}

‎arduino/cores/packagemanager/package_manager_test.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ func TestFindBoardWithFQBN(t *testing.T) {
4141
pm := packagemanager.NewPackageManager(customHardware, customHardware, customHardware, customHardware)
4242
pm.LoadHardwareFromDirectory(customHardware)
4343

44-
_, _, board, err := pm.FindBoard("arduino:avr:uno")
44+
_, _, board, err := pm.FindBoard("arduino:avr:uno", nil)
4545
require.Nil(t, err)
4646
require.NotNil(t, board)
4747
require.Equal(t, board.Name(), "Arduino/Genuino Uno")
4848

49-
_, _, board, err = pm.FindBoard("arduino:avr:mega")
49+
_, _, board, err = pm.FindBoard("arduino:avr:mega", nil)
5050
require.Nil(t, err)
5151
require.NotNil(t, board)
5252
require.Equal(t, board.Name(), "Arduino/Genuino Mega or Mega 2560")
@@ -178,7 +178,7 @@ func TestBoardOptionsFunctions(t *testing.T) {
178178
pm := packagemanager.NewPackageManager(customHardware, customHardware, customHardware, customHardware)
179179
pm.LoadHardwareFromDirectory(customHardware)
180180

181-
_, _, nano, err := pm.FindBoard("arduino:avr:nano")
181+
_, _, nano, err := pm.FindBoard("arduino:avr:nano", nil)
182182
require.Nil(t, err)
183183
require.NotNil(t, nano)
184184
require.Equal(t, nano.Name(), "Arduino Nano")
@@ -194,7 +194,7 @@ func TestBoardOptionsFunctions(t *testing.T) {
194194
expectedNanoCPUValues.Set("atmega168", "ATmega168")
195195
require.EqualValues(t, expectedNanoCPUValues, nanoCPUValues)
196196

197-
_, _, esp8266, err := pm.FindBoard("esp8266:esp8266:generic")
197+
_, _, esp8266, err := pm.FindBoard("esp8266:esp8266:generic", nil)
198198
require.Nil(t, err)
199199
require.NotNil(t, esp8266)
200200
require.Equal(t, esp8266.Name(), "Generic ESP8266 Module")
@@ -230,7 +230,7 @@ func TestFindToolsRequiredForBoard(t *testing.T) {
230230
loadIndex("http://arduino.esp8266.com/stable/package_esp8266com_index.json")
231231
loadIndex("https://adafruit.github.io/arduino-board-index/package_adafruit_index.json")
232232
require.NoError(t, pm.LoadHardware())
233-
_, _, esp32, err := pm.FindBoard("esp32:esp32:esp32")
233+
_, _, esp32, err := pm.FindBoard("esp32:esp32:esp32", nil)
234234
require.NoError(t, err)
235235
esptool231 := pm.FindToolDependency(&cores.ToolDependency{
236236
ToolPackager: "esp32",
@@ -266,7 +266,7 @@ func TestFindToolsRequiredForBoard(t *testing.T) {
266266
testConflictingToolsInDifferentPackages()
267267
testConflictingToolsInDifferentPackages()
268268

269-
_, _, feather, err := pm.FindBoard("adafruit:samd:adafruit_feather_m0_express")
269+
_, _, feather, err := pm.FindBoard("adafruit:samd:adafruit_feather_m0_express", nil)
270270
require.NoError(t, err)
271271
require.NotNil(t, feather)
272272
featherTools, err := pm.FindToolsRequiredForBoard(feather)

‎cli/board/details.go

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ package board
1818
import (
1919
"context"
2020
"fmt"
21+
"os"
22+
2123
"github.com/arduino/arduino-cli/cli/errorcodes"
2224
"github.com/arduino/arduino-cli/cli/feedback"
2325
"github.com/arduino/arduino-cli/cli/instance"
@@ -26,26 +28,29 @@ import (
2628
"github.com/arduino/arduino-cli/table"
2729
"github.com/fatih/color"
2830
"github.com/spf13/cobra"
29-
"os"
3031
)
3132

32-
var showFullDetails bool
33-
3433
func initDetailsCommand() *cobra.Command {
3534
var detailsCommand = &cobra.Command{
36-
Use: "details <FQBN>",
35+
Use: "details <FQBN | BOARD_ALIAS>",
3736
Short: "Print details about a board.",
3837
Long: "Show information about a board, in particular if the board has options to be specified in the FQBN.",
3938
Example: " " + os.Args[0] + " board details arduino:avr:nano",
4039
Args: cobra.ExactArgs(1),
4140
Run: runDetailsCommand,
4241
}
4342

44-
detailsCommand.Flags().BoolVarP(&showFullDetails, "full", "f", false, "Include full details in text output")
45-
43+
detailsCommand.Flags().BoolVarP(&detailsFlags.showFullDetails, "full", "f", false, "Include full details in text output")
44+
detailsFlags.boardConfig =
45+
detailsCommand.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")
4646
return detailsCommand
4747
}
4848

49+
var detailsFlags struct {
50+
showFullDetails bool
51+
boardConfig *[]string
52+
}
53+
4954
func runDetailsCommand(cmd *cobra.Command, args []string) {
5055
inst, err := instance.CreateInstance()
5156
if err != nil {
@@ -54,8 +59,9 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
5459
}
5560

5661
res, err := board.Details(context.Background(), &rpc.BoardDetailsReq{
57-
Instance: inst,
58-
Fqbn: args[0],
62+
Instance: inst,
63+
Board: args[0],
64+
BoardConfig: *detailsFlags.boardConfig,
5965
})
6066

6167
if err != nil {
@@ -131,7 +137,7 @@ func (dr detailsResult) String() string {
131137
t.AddRow() // get some space from above
132138
for _, tool := range details.ToolsDependencies {
133139
t.AddRow("Required tools:", tool.Packager+":"+tool.Name, "", tool.Version)
134-
if showFullDetails {
140+
if detailsFlags.showFullDetails {
135141
for _, sys := range tool.Systems {
136142
t.AddRow("", "OS:", "", sys.Host)
137143
t.AddRow("", "File:", "", sys.ArchiveFileName)

‎cli/compile/compile.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ import (
3333
)
3434

3535
var (
36-
boardArg string // Board Alias or Board FQBN
36+
boardArg string // Board Alias or Board FQBN
37+
boardConfig *[]string // Board Configuration
38+
3739
showProperties bool // Show all build preferences used instead of compiling.
3840
preprocess bool // Print preprocessed code to stdout.
3941
buildCachePath string // Builds of 'core.a' are saved into this path to be cached and reused.
@@ -64,6 +66,8 @@ func NewCommand() *cobra.Command {
6466
}
6567

6668
command.Flags().StringVarP(&boardArg, "board", "b", "", "Board Alias or Board FQBN (e.g. 'arduino:avr:uno')")
69+
boardConfig =
70+
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")
6771
command.Flags().StringVarP(&boardArg, "fqbn", "", "", "")
6872
command.Flags().MarkDeprecated("fqbn", "use --board instead.")
6973
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) {
107111
_, err = compile.Compile(context.Background(), &rpc.CompileReq{
108112
Instance: inst,
109113
Board: boardArg,
114+
BoardConfig: *boardConfig,
110115
SketchPath: sketchPath.String(),
111116
ShowProperties: showProperties,
112117
Preprocess: preprocess,

‎cli/upload/upload.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ import (
3030
)
3131

3232
var (
33-
boardArg string
33+
boardArg string
34+
boardConfig *[]string
35+
3436
port string
3537
verbose bool
3638
verify bool
@@ -49,6 +51,8 @@ func NewCommand() *cobra.Command {
4951
}
5052

5153
uploadCommand.Flags().StringVarP(&boardArg, "board", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
54+
boardConfig =
55+
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")
5256
uploadCommand.Flags().StringVarP(&boardArg, "fqbn", "", "", "")
5357
uploadCommand.Flags().MarkDeprecated("fqbn", "use --board instead.")
5458
uploadCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")

‎commands/board/details.go

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ package board
1818
import (
1919
"context"
2020
"errors"
21-
"fmt"
2221

23-
"github.com/arduino/arduino-cli/arduino/cores"
2422
"github.com/arduino/arduino-cli/commands"
2523
rpc "github.com/arduino/arduino-cli/rpc/commands"
2624
)
@@ -33,14 +31,18 @@ func Details(ctx context.Context, req *rpc.BoardDetailsReq) (*rpc.BoardDetailsRe
3331
return nil, errors.New("invalid instance")
3432
}
3533

36-
fqbn, err := cores.ParseFQBN(req.GetFqbn())
37-
if err != nil {
38-
return nil, fmt.Errorf("parsing fqbn: %s", err)
34+
boardArg := req.GetBoard()
35+
if boardArg == "" {
36+
boardArg = req.GetFqbn() // Deprecated: use FQBN for old client.
3937
}
4038

41-
boardPackage, boardPlatform, board, _, _, err := pm.ResolveFQBN(fqbn)
39+
fqbn, _, board, err := pm.FindBoard(boardArg, req.GetBoardConfig())
40+
boardPlatform := board.PlatformRelease
41+
boardPackage := boardPlatform.Platform.Package
42+
43+
// TODO: do not ignore *RegisteredBoard result, but output data from it?
4244
if err != nil {
43-
return nil, fmt.Errorf("loading board data: %s", err)
45+
return nil, err
4446
}
4547

4648
details := &rpc.BoardDetailsResp{}

‎commands/board/install.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func Install(ctx context.Context, req *rpc.BoardInstallReq,
3333
return nil, errors.New("invalid instance")
3434
}
3535

36-
fqbn, _, _, err := pm.FindBoard(req.GetBoard())
36+
fqbn, _, _, err := pm.FindBoard(req.GetBoard(), nil)
3737
if err != nil {
3838
return nil, errors.Errorf("board '%s' not found: %s", req.GetBoard(), err)
3939
}

‎commands/compile/compile.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
9696
return nil, errors.Errorf("no board provided")
9797
}
9898

99-
fqbn, _, _, err := pm.FindBoard(boardArg)
99+
fqbn, _, _, err := pm.FindBoard(boardArg, req.GetBoardConfig())
100100
if err != nil {
101101
return nil, errors.Errorf("board '%s' not found: %s", req.GetBoard(), err)
102102
}

‎commands/upload/upload.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func Upload(ctx context.Context, req *rpc.UploadReq, outStream io.Writer, errStr
8080
}
8181

8282
pm := commands.GetPackageManager(req.GetInstance().GetId())
83-
fqbn, _, _, err := pm.FindBoard(boardArg)
83+
fqbn, _, _, err := pm.FindBoard(boardArg, req.GetBoardConfig())
8484
if err != nil {
8585
return nil, errors.Errorf("board '%s' not found: %s", req.GetBoard(), err)
8686
}

0 commit comments

Comments
 (0)