Skip to content

Commit 2a33e30

Browse files
silvanocerzasilvanocerza
committed
Change index format to differentiate upload commands by OS
1 parent 552564b commit 2a33e30

File tree

7 files changed

+113
-56
lines changed

7 files changed

+113
-56
lines changed

‎generator/generator.py‎

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ def create_firmware_data(binary, module, version):
7171
}
7272

7373

74-
def get_uploader_id(tools, tool_executable):
74+
def get_uploader_id(tools, tool_name):
7575
for t in tools:
76-
if t["name"] == tool_executable:
76+
if t["name"] == tool_name:
7777
packager = t["packager"]
7878
name = t["name"]
7979
version = t["version"]
@@ -118,15 +118,27 @@ def create_upload_data(fqbn, installed_cores): # noqa: C901
118118
installed_json_data = json.load(f)
119119

120120
if f"{tool}.cmd" in platform_upload_data:
121-
tool_executable = platform_upload_data[f"{tool}.cmd"]
121+
tool_executable_generic = platform_upload_data[f"{tool}.cmd"]
122+
tool_executable_linux = platform_upload_data.get(f"{tool}.cmd.linux", tool_executable_generic)
123+
tool_executable_windows = platform_upload_data.get(f"{tool}.cmd.windows", "")
124+
tool_executable_macosx = platform_upload_data.get(f"{tool}.cmd.macosx", "")
125+
tool_name = tool_executable_generic
122126
elif f"{tool}.cmd.path" in platform_upload_data:
123-
tool_executable = platform_upload_data[f"{tool}.cmd.path"].split("/")[-1]
127+
tool_executable_generic = "/".join(platform_upload_data[f"{tool}.cmd.path"].split("/")[1:])
128+
tool_executable_linux = platform_upload_data.get(f"{tool}.cmd.path.linux", tool_executable_generic)
129+
tool_executable_windows = platform_upload_data.get(f"{tool}.cmd.path.windows", "")
130+
tool_executable_macosx = platform_upload_data.get(f"{tool}.cmd.path.macosx", "")
131+
tool_name = tool_executable_generic.split("/")[-1]
124132

125-
if tool_executable == "rp2040load":
126-
tool_executable = "rp2040tools"
133+
tool_config_path = ""
134+
if f"{tool}.config.path" in platform_upload_data:
135+
tool_config_path = "/".join(platform_upload_data[f"{tool}.config.path"].split("/")[1:])
136+
137+
if tool_name == "rp2040load":
138+
tool_name = "rp2040tools"
127139

128140
tools = installed_json_data["packages"][0]["platforms"][0]["toolsDependencies"]
129-
upload_data["uploader"] = get_uploader_id(tools, tool_executable)
141+
upload_data["uploader"] = get_uploader_id(tools, tool_name)
130142

131143
if "upload.use_1200bps_touch" in board_upload_data:
132144
upload_data["upload.use_1200bps_touch"] = bool(board_upload_data["upload.use_1200bps_touch"])
@@ -140,6 +152,7 @@ def create_upload_data(fqbn, installed_cores): # noqa: C901
140152
.replace("{path}/{cmd}", "{uploader}")
141153
.replace("{cmd.path}", "{uploader}")
142154
.replace("{build.path}/{build.project_name}", "{loader.sketch}")
155+
.replace("{config.path}", f"{{tool_dir}}/{tool_config_path}")
143156
.replace('\\"', "")
144157
)
145158

@@ -163,7 +176,22 @@ def create_upload_data(fqbn, installed_cores): # noqa: C901
163176
for k, v in {**board_upload_data, **params}.items():
164177
command = command.replace(f"{{{k}}}", v)
165178

166-
upload_data["uploader.command"] = command
179+
# This is ugly as hell and I don't care
180+
upload_data["uploader.command"] = {}
181+
if tool_executable_linux:
182+
upload_data["uploader.command"]["linux"] = command.replace(
183+
f"{{uploader}}", f"{{tool_dir}}/{tool_executable_linux}"
184+
)
185+
186+
if tool_executable_windows:
187+
upload_data["uploader.command"]["windows"] = command.replace(
188+
f"{{uploader}}", f"{{tool_dir}}\\{tool_executable_windows}"
189+
)
190+
191+
if tool_executable_macosx:
192+
upload_data["uploader.command"]["macosx"] = command.replace(
193+
f"{{uploader}}", f"{{tool_dir}}/{tool_executable_macosx}"
194+
)
167195

168196
return upload_data
169197

‎indexes/download/testdata/module_firmware_index.json‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@
4141
"uploader": "arduino:bossac@1.7.0-arduino3",
4242
"upload.use_1200bps_touch": true,
4343
"upload.wait_for_upload_port": true,
44-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
44+
"uploader.command": {
45+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
46+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
47+
}
4548
},
4649
{
4750
"fqbn": "arduino:samd:mkrwifi1010",
@@ -148,7 +151,10 @@
148151
"uploader": "arduino:bossac@1.7.0-arduino3",
149152
"upload.use_1200bps_touch": true,
150153
"upload.wait_for_upload_port": true,
151-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
154+
"uploader.command": {
155+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
156+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
157+
}
152158
},
153159
{
154160
"fqbn": "arduino:samd:nano_33_iot",
@@ -255,7 +261,10 @@
255261
"uploader": "arduino:bossac@1.7.0-arduino3",
256262
"upload.use_1200bps_touch": true,
257263
"upload.wait_for_upload_port": true,
258-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
264+
"uploader.command": {
265+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
266+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
267+
}
259268
},
260269
{
261270
"fqbn": "arduino:samd:mkrvidor4000",
@@ -357,7 +366,10 @@
357366
"uploader": "arduino:bossac@1.7.0-arduino3",
358367
"upload.use_1200bps_touch": true,
359368
"upload.wait_for_upload_port": true,
360-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -I -U true -i -e -w \"{loader.sketch}.bin\" -R"
369+
"uploader.command": {
370+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -I -U true -i -e -w \"{loader.sketch}.bin\" -R",
371+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -I -U true -i -e -w \"{loader.sketch}.bin\" -R"
372+
}
361373
},
362374
{
363375
"fqbn": "arduino:megaavr:uno2018",
@@ -448,7 +460,9 @@
448460
"module": "NINA",
449461
"name": "Arduino Uno WiFi Rev2",
450462
"uploader": "arduino:avrdude@6.3.0-arduino17",
451-
"uploader.command": "\"{uploader}\" \"-C{config.path}\" -v -patmega4809 -cxplainedmini_updi -Pusb -b115200 -e -D \"-Uflash:w:{loader.sketch}.hex:i\" \"-Ufuse2:w:0x01:m\" \"-Ufuse5:w:0xC9:m\" \"-Ufuse8:w:0x02:m\" "
463+
"uploader.command": {
464+
"linux": "\"{tool_dir}/bin/avrdude\" \"-C{tool_dir}/etc/avrdude.conf\" -v -patmega4809 -cxplainedmini_updi -Pusb -b115200 -e -D \"-Uflash:w:{loader.sketch}.hex:i\" \"-Ufuse2:w:0x01:m\" \"-Ufuse5:w:0xC9:m\" \"-Ufuse8:w:0x02:m\" "
465+
}
452466
},
453467
{
454468
"fqbn": "arduino:samd:mkrnb1500",
@@ -485,7 +499,10 @@
485499
"uploader": "arduino:bossac@1.7.0-arduino3",
486500
"upload.use_1200bps_touch": true,
487501
"upload.wait_for_upload_port": true,
488-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
502+
"uploader.command": {
503+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
504+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
505+
}
489506
},
490507
{
491508
"fqbn": "arduino:mbed_nano:nanorp2040connect",
@@ -508,6 +525,8 @@
508525
"uploader": "arduino:rp2040tools@1.0.2",
509526
"upload.use_1200bps_touch": true,
510527
"upload.wait_for_upload_port": true,
511-
"uploader.command": "\"{uploader}\" -v -D \"{loader.sketch}.elf\""
528+
"uploader.command": {
529+
"linux": "\"{tool_dir}/rp2040load\" -v -D \"{loader.sketch}.elf\""
530+
}
512531
}
513532
]

‎indexes/download/testdata/module_firmware_index.json.sig‎

0 Bytes
Binary file not shown.

‎indexes/firmwareindex/firmwareindex.go‎

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ package firmwareindex
2222
import (
2323
"encoding/json"
2424
"fmt"
25+
"runtime"
2526

2627
"github.com/arduino/arduino-cli/arduino/security"
2728
"github.com/arduino/go-paths-helper"
@@ -32,21 +33,27 @@ import (
3233

3334
// Index represents Boards struct as seen from module_firmware_index.json file.
3435
type Index struct {
35-
Boards []*indexBoard
36+
Boards []*IndexBoard
3637
IsTrusted bool
3738
}
3839

3940
// indexPackage represents a single entry from module_firmware_index.json file.
40-
type indexBoard struct {
41-
Fqbn string `json:"fqbn,required"`
42-
Firmwares []*IndexFirmware `json:"firmware,required"`
43-
LoaderSketch *IndexLoaderSketch `json:"loader_sketch,required"`
44-
Module string `json:"module,required"`
45-
Name string `json:"name,required"`
46-
Uploader string `json:"uploader,required"`
47-
UploadTouch bool `json:"upload.use_1200bps_touch"`
48-
UploadWait bool `json:"upload.wait_for_upload_port"`
49-
UploaderCommand string `json:"uploader.command,required"`
41+
type IndexBoard struct {
42+
Fqbn string `json:"fqbn,required"`
43+
Firmwares []*IndexFirmware `json:"firmware,required"`
44+
LoaderSketch *IndexLoaderSketch `json:"loader_sketch,required"`
45+
Module string `json:"module,required"`
46+
Name string `json:"name,required"`
47+
Uploader string `json:"uploader,required"`
48+
UploadTouch bool `json:"upload.use_1200bps_touch"`
49+
UploadWait bool `json:"upload.wait_for_upload_port"`
50+
UploaderCommand *IndexUploaderCommand `json:"uploader.command,required"`
51+
}
52+
53+
type IndexUploaderCommand struct {
54+
Linux string `json:"linux,required"`
55+
Windows string `json:"windows"`
56+
Macosx string `json:"macosx"`
5057
}
5158

5259
// IndexFirmware represents a single Firmware version from module_firmware_index.json file.
@@ -172,14 +179,14 @@ func (i *Index) GetLoaderSketchURL(fqbn string) (string, error) {
172179
return "", fmt.Errorf("invalid FQBN: %s", fqbn)
173180
}
174181

175-
// GetUploaderCommand will take the board's fqbn and return the command used for upload
176-
func (i *Index) GetUploaderCommand(fqbn string) (string, error) {
177-
for _, board := range i.Boards {
178-
if board.Fqbn == fqbn {
179-
return board.UploaderCommand, nil
180-
}
182+
func (b *IndexBoard) GetUploaderCommand() string {
183+
if runtime.GOOS == "windows" && b.UploaderCommand.Windows != "" {
184+
return b.UploaderCommand.Linux
185+
} else if runtime.GOOS == "darwin" && b.UploaderCommand.Macosx != "" {
186+
return b.UploaderCommand.Macosx
181187
}
182-
return "", fmt.Errorf("invalid FQBN: %s", fqbn)
188+
// The linux uploader command is considere to be the generic one
189+
return b.UploaderCommand.Linux
183190
}
184191

185192
// GetModule will take the board's fqbn and return the name of the module

‎indexes/firmwareindex/firmwareindex_test.go‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -91,22 +91,6 @@ func TestGetLoaderSketchURL(t *testing.T) {
9191
require.Empty(t, result)
9292
}
9393

94-
func TestGetUploaderCommand(t *testing.T) {
95-
indexFile := paths.New("testdata/module_firmware_index.json")
96-
t.Logf("testing with index: %s", indexFile)
97-
index, e := LoadIndexNoSign(indexFile)
98-
require.NoError(t, e)
99-
require.NotEmpty(t, index)
100-
101-
result, err := index.GetUploaderCommand("arduino:samd:mkr1000")
102-
require.NoError(t, err)
103-
require.NotEmpty(t, result)
104-
105-
result, err = index.GetUploaderCommand("arduino:samd:mkr1001")
106-
require.Error(t, err)
107-
require.Empty(t, result)
108-
}
109-
11094
func TestGetModule(t *testing.T) {
11195
indexFile := paths.New("testdata/module_firmware_index.json")
11296
t.Logf("testing with index: %s", indexFile)

‎indexes/firmwareindex/testdata/module_firmware_index.json‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@
4141
"uploader": "arduino:bossac@1.7.0-arduino3",
4242
"upload.use_1200bps_touch": true,
4343
"upload.wait_for_upload_port": true,
44-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
44+
"uploader.command": {
45+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
46+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
47+
}
4548
},
4649
{
4750
"fqbn": "arduino:samd:mkrwifi1010",
@@ -148,7 +151,10 @@
148151
"uploader": "arduino:bossac@1.7.0-arduino3",
149152
"upload.use_1200bps_touch": true,
150153
"upload.wait_for_upload_port": true,
151-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
154+
"uploader.command": {
155+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
156+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
157+
}
152158
},
153159
{
154160
"fqbn": "arduino:samd:nano_33_iot",
@@ -255,7 +261,10 @@
255261
"uploader": "arduino:bossac@1.7.0-arduino3",
256262
"upload.use_1200bps_touch": true,
257263
"upload.wait_for_upload_port": true,
258-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
264+
"uploader.command": {
265+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
266+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
267+
}
259268
},
260269
{
261270
"fqbn": "arduino:samd:mkrvidor4000",
@@ -357,7 +366,10 @@
357366
"uploader": "arduino:bossac@1.7.0-arduino3",
358367
"upload.use_1200bps_touch": true,
359368
"upload.wait_for_upload_port": true,
360-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -I -U true -i -e -w \"{loader.sketch}.bin\" -R"
369+
"uploader.command": {
370+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -I -U true -i -e -w \"{loader.sketch}.bin\" -R",
371+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -I -U true -i -e -w \"{loader.sketch}.bin\" -R"
372+
}
361373
},
362374
{
363375
"fqbn": "arduino:megaavr:uno2018",
@@ -448,7 +460,9 @@
448460
"module": "NINA",
449461
"name": "Arduino Uno WiFi Rev2",
450462
"uploader": "arduino:avrdude@6.3.0-arduino17",
451-
"uploader.command": "\"{uploader}\" \"-C{config.path}\" -v -patmega4809 -cxplainedmini_updi -Pusb -b115200 -e -D \"-Uflash:w:{loader.sketch}.hex:i\" \"-Ufuse2:w:0x01:m\" \"-Ufuse5:w:0xC9:m\" \"-Ufuse8:w:0x02:m\" "
463+
"uploader.command": {
464+
"linux": "\"{tool_dir}/bin/avrdude\" \"-C{tool_dir}/etc/avrdude.conf\" -v -patmega4809 -cxplainedmini_updi -Pusb -b115200 -e -D \"-Uflash:w:{loader.sketch}.hex:i\" \"-Ufuse2:w:0x01:m\" \"-Ufuse5:w:0xC9:m\" \"-Ufuse8:w:0x02:m\" "
465+
}
452466
},
453467
{
454468
"fqbn": "arduino:samd:mkrnb1500",
@@ -485,7 +499,10 @@
485499
"uploader": "arduino:bossac@1.7.0-arduino3",
486500
"upload.use_1200bps_touch": true,
487501
"upload.wait_for_upload_port": true,
488-
"uploader.command": "\"{uploader}\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
502+
"uploader.command": {
503+
"linux": "\"{tool_dir}/bossac\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R",
504+
"windows": "\"{tool_dir}\\bossac.exe\" -i -d --port={serial.port.file} -U true -i -e -w -v \"{loader.sketch}.bin\" -R"
505+
}
489506
},
490507
{
491508
"fqbn": "arduino:mbed_nano:nanorp2040connect",
@@ -508,6 +525,8 @@
508525
"uploader": "arduino:rp2040tools@1.0.2",
509526
"upload.use_1200bps_touch": true,
510527
"upload.wait_for_upload_port": true,
511-
"uploader.command": "\"{uploader}\" -v -D \"{loader.sketch}.elf\""
528+
"uploader.command": {
529+
"linux": "\"{tool_dir}/rp2040load\" -v -D \"{loader.sketch}.elf\""
530+
}
512531
}
513532
]

‎indexes/firmwareindex/testdata/module_firmware_index.json.sig‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)