Skip to content

Commit 69beb2d

Browse files
committed
Added migration docs
1 parent 3f19751 commit 69beb2d

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

Diff for: docs/UPGRADING.md

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

55
## Unreleased
66

7+
### Change in `board details` response (gRPC and JSON output)
8+
9+
The `board details` output WRT board identification properties has changed, before it was:
10+
11+
```
12+
$ arduino-cli board details arduino:samd:mkr1000
13+
Board name: Arduino MKR1000
14+
FQBN: arduino:samd:mkr1000
15+
Board version: 1.8.11
16+
Debugging supported: ✔
17+
18+
Official Arduino board: ✔
19+
20+
Identification properties: VID:0x2341 PID:0x824e
21+
VID:0x2341 PID:0x024e
22+
VID:0x2341 PID:0x804e
23+
VID:0x2341 PID:0x004e
24+
[...]
25+
26+
$ arduino-cli board details arduino:samd:mkr1000 --format json
27+
[...]
28+
"identification_prefs": [
29+
{
30+
"usb_id": {
31+
"vid": "0x2341",
32+
"pid": "0x804e"
33+
}
34+
},
35+
{
36+
"usb_id": {
37+
"vid": "0x2341",
38+
"pid": "0x004e"
39+
}
40+
},
41+
{
42+
"usb_id": {
43+
"vid": "0x2341",
44+
"pid": "0x824e"
45+
}
46+
},
47+
{
48+
"usb_id": {
49+
"vid": "0x2341",
50+
"pid": "0x024e"
51+
}
52+
}
53+
],
54+
[...]
55+
```
56+
57+
now the properties have been renamed from `identification_prefs` to `identification_properties` and they are no more
58+
specific to USB but they can theoretically be any set of key/values:
59+
60+
```
61+
$ arduino-cli board details arduino:samd:mkr1000
62+
Board name: Arduino MKR1000
63+
FQBN: arduino:samd:mkr1000
64+
Board version: 1.8.11
65+
Debugging supported: ✔
66+
67+
Official Arduino board: ✔
68+
69+
Identification properties: vid=0x2341
70+
pid=0x804e
71+
72+
Identification properties: vid=0x2341
73+
pid=0x004e
74+
75+
Identification properties: vid=0x2341
76+
pid=0x824e
77+
78+
Identification properties: vid=0x2341
79+
pid=0x024e
80+
[...]
81+
82+
$ arduino-cli board details arduino:samd:mkr1000 --format json
83+
[...]
84+
"identification_properties": [
85+
{
86+
"properties": {
87+
"pid": "0x804e",
88+
"vid": "0x2341"
89+
}
90+
},
91+
{
92+
"properties": {
93+
"pid": "0x004e",
94+
"vid": "0x2341"
95+
}
96+
},
97+
{
98+
"properties": {
99+
"pid": "0x824e",
100+
"vid": "0x2341"
101+
}
102+
},
103+
{
104+
"properties": {
105+
"pid": "0x024e",
106+
"vid": "0x2341"
107+
}
108+
}
109+
]
110+
}
111+
```
112+
7113
### Change of behaviour of gRPC `Init` function
8114

9115
Previously the `Init` function was used to both create a new `CoreInstance` and initialize it, so that the internal

0 commit comments

Comments
 (0)