Skip to content

Commit 39899ce

Browse files
committed
Added migration docs
1 parent 419974f commit 39899ce

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

docs/UPGRADING.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,112 @@ removed, in its place:
9393

9494
`Context.Sketch` types has been changed from `Sketch` to `sketch.Sketch`.
9595

96+
### Change in `board details` response (gRPC and JSON output)
97+
98+
The `board details` output WRT board identification properties has changed, before it was:
99+
100+
```
101+
$ arduino-cli board details arduino:samd:mkr1000
102+
Board name: Arduino MKR1000
103+
FQBN: arduino:samd:mkr1000
104+
Board version: 1.8.11
105+
Debugging supported: ✔
106+
107+
Official Arduino board: ✔
108+
109+
Identification properties: VID:0x2341 PID:0x824e
110+
VID:0x2341 PID:0x024e
111+
VID:0x2341 PID:0x804e
112+
VID:0x2341 PID:0x004e
113+
[...]
114+
115+
$ arduino-cli board details arduino:samd:mkr1000 --format json
116+
[...]
117+
"identification_prefs": [
118+
{
119+
"usb_id": {
120+
"vid": "0x2341",
121+
"pid": "0x804e"
122+
}
123+
},
124+
{
125+
"usb_id": {
126+
"vid": "0x2341",
127+
"pid": "0x004e"
128+
}
129+
},
130+
{
131+
"usb_id": {
132+
"vid": "0x2341",
133+
"pid": "0x824e"
134+
}
135+
},
136+
{
137+
"usb_id": {
138+
"vid": "0x2341",
139+
"pid": "0x024e"
140+
}
141+
}
142+
],
143+
[...]
144+
```
145+
146+
now the properties have been renamed from `identification_prefs` to `identification_properties` and they are no more
147+
specific to USB but they can theoretically be any set of key/values:
148+
149+
```
150+
$ arduino-cli board details arduino:samd:mkr1000
151+
Board name: Arduino MKR1000
152+
FQBN: arduino:samd:mkr1000
153+
Board version: 1.8.11
154+
Debugging supported: ✔
155+
156+
Official Arduino board: ✔
157+
158+
Identification properties: vid=0x2341
159+
pid=0x804e
160+
161+
Identification properties: vid=0x2341
162+
pid=0x004e
163+
164+
Identification properties: vid=0x2341
165+
pid=0x824e
166+
167+
Identification properties: vid=0x2341
168+
pid=0x024e
169+
[...]
170+
171+
$ arduino-cli board details arduino:samd:mkr1000 --format json
172+
[...]
173+
"identification_properties": [
174+
{
175+
"properties": {
176+
"pid": "0x804e",
177+
"vid": "0x2341"
178+
}
179+
},
180+
{
181+
"properties": {
182+
"pid": "0x004e",
183+
"vid": "0x2341"
184+
}
185+
},
186+
{
187+
"properties": {
188+
"pid": "0x824e",
189+
"vid": "0x2341"
190+
}
191+
},
192+
{
193+
"properties": {
194+
"pid": "0x024e",
195+
"vid": "0x2341"
196+
}
197+
}
198+
]
199+
}
200+
```
201+
96202
### Change of behaviour of gRPC `Init` function
97203

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

0 commit comments

Comments
 (0)