Skip to content

Commit a58f8b5

Browse files
committed
[skip changelog] Add missing breaking change to UPGRADING.md
1 parent feffb70 commit a58f8b5

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

Diff for: docs/UPGRADING.md

+56
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,62 @@ Here you can find a list of migration guides to handle breaking changes between
44

55
## 0.19.0
66

7+
### `board list` command JSON output change
8+
9+
The `board list` command JSON output has been changed quite a bit, from:
10+
11+
```
12+
$ arduino-cli board list --format json
13+
[
14+
{
15+
"address": "/dev/ttyACM1",
16+
"protocol": "serial",
17+
"protocol_label": "Serial Port (USB)",
18+
"boards": [
19+
{
20+
"name": "Arduino Uno",
21+
"fqbn": "arduino:avr:uno",
22+
"vid": "0x2341",
23+
"pid": "0x0043"
24+
}
25+
],
26+
"serial_number": "954323132383515092E1"
27+
}
28+
]
29+
```
30+
31+
to:
32+
33+
```
34+
$ arduino-cli board list --format json
35+
[
36+
{
37+
"matching_boards": [
38+
{
39+
"name": "Arduino Uno",
40+
"fqbn": "arduino:avr:uno"
41+
}
42+
],
43+
"port": {
44+
"address": "/dev/ttyACM1",
45+
"label": "/dev/ttyACM1",
46+
"protocol": "serial",
47+
"protocol_label": "Serial Port (USB)",
48+
"properties": {
49+
"pid": "0x0043",
50+
"serialNumber": "954323132383515092E1",
51+
"vid": "0x2341"
52+
}
53+
}
54+
}
55+
]
56+
```
57+
58+
The `boards` array has been renamed `matching_boards`, each contained object will now contain only `name` and `fqbn`.
59+
Properties that can be used to identify a board are now moved to the new `properties` object, it can contain any key
60+
name. `pid`, `vid` and `serialNumber` have been moved to `properties`. The new `label` field is the name of the `port`
61+
if it should be displayed in a GUI.
62+
763
### gRPC interface `DebugConfigRequest`, `UploadRequest`, `UploadUsingProgrammerRequest`, `BurnBootloaderRequest`, `DetectedPort` field changes
864

965
`DebugConfigRequest`, `UploadRequest`, `UploadUsingProgrammerRequest` and `BurnBootloaderRequest` had their `port` field

0 commit comments

Comments
 (0)