Skip to content

Commit 40df44d

Browse files
ArduinoBotArduinoBot
committed
Deployed 0e5f629 to dev with MkDocs 1.3.0 and mike 1.1.2
1 parent a4ae5da commit 40df44d

File tree

72 files changed

+3076
-684
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+3076
-684
lines changed

‎dev/404.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1050,6 +1050,20 @@
10501050

10511051

10521052

1053+
1054+
1055+
1056+
1057+
1058+
<li class="md-nav__item">
1059+
<a href="/arduino-cli/dev/rpc/settings/" class="md-nav__link">
1060+
settings
1061+
</a>
1062+
</li>
1063+
1064+
1065+
1066+
10531067
</ul>
10541068
</nav>
10551069
</li>

‎dev/CONTRIBUTING/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1296,6 +1296,20 @@
12961296

12971297

12981298

1299+
1300+
1301+
1302+
1303+
1304+
<li class="md-nav__item">
1305+
<a href="../rpc/settings/" class="md-nav__link">
1306+
settings
1307+
</a>
1308+
</li>
1309+
1310+
1311+
1312+
12991313
</ul>
13001314
</nav>
13011315
</li>

‎dev/FAQ/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1130,6 +1130,20 @@
11301130

11311131

11321132

1133+
1134+
1135+
1136+
1137+
1138+
<li class="md-nav__item">
1139+
<a href="../rpc/settings/" class="md-nav__link">
1140+
settings
1141+
</a>
1142+
</li>
1143+
1144+
1145+
1146+
11331147
</ul>
11341148
</nav>
11351149
</li>

‎dev/UPGRADING/index.html

Lines changed: 16 additions & 196 deletions
Original file line numberDiff line numberDiff line change
@@ -284,55 +284,6 @@
284284
<nav class="md-nav" aria-label="0.36.0">
285285
<ul class="md-nav__list">
286286

287-
<li class="md-nav__item">
288-
<a href="#cli-changed-json-output-for-some-lib-core-config-board-and-sketch-commands" class="md-nav__link">
289-
CLI changed JSON output for some lib, core, config, board, and sketch commands.
290-
</a>
291-
292-
</li>
293-
294-
<li class="md-nav__item">
295-
<a href="#the-grpc-ccarduinoclicommandsv1platformrelease-has-been-changed" class="md-nav__link">
296-
The gRPC cc.arduino.cli.commands.v1.PlatformRelease has been changed.
297-
</a>
298-
299-
</li>
300-
301-
<li class="md-nav__item">
302-
<a href="#the-grpc-ccarduinoclicommandsv1platformsummary-has-been-changed" class="md-nav__link">
303-
The gRPC cc.arduino.cli.commands.v1.PlatformSummary has been changed.
304-
</a>
305-
306-
</li>
307-
308-
<li class="md-nav__item">
309-
<a href="#core-list-now-returns-only-the-latest-version-that-can-be-installed" class="md-nav__link">
310-
core list now returns only the latest version that can be installed.
311-
</a>
312-
313-
</li>
314-
315-
<li class="md-nav__item">
316-
<a href="#core-search-now-returns-the-latest-installable-version-of-a-core" class="md-nav__link">
317-
core search now returns the latest installable version of a core.
318-
</a>
319-
320-
</li>
321-
322-
<li class="md-nav__item">
323-
<a href="#core-upgrade-and-core-install-will-install-the-latest-compatible-version" class="md-nav__link">
324-
core upgrade and core install will install the latest compatible version.
325-
</a>
326-
327-
</li>
328-
329-
<li class="md-nav__item">
330-
<a href="#grpc-service-ccarduinoclisettingsv1-has-been-removed-and-all-rpc-calls-have-been-migrated-to-ccarduinoclicommandsv1" class="md-nav__link">
331-
gRPC service cc.arduino.cli.settings.v1 has been removed, and all RPC calls have been migrated to cc.arduino.cli.commands.v1
332-
</a>
333-
334-
</li>
335-
336287
<li class="md-nav__item">
337288
<a href="#grpc-ccarduinoclicommandsv1librarysearchrequest-message-has-been-changed" class="md-nav__link">
338289
gRPC cc.arduino.cli.commands.v1.LibrarySearchRequest message has been changed.
@@ -2214,6 +2165,20 @@
22142165

22152166

22162167

2168+
2169+
2170+
2171+
2172+
2173+
<li class="md-nav__item">
2174+
<a href="../rpc/settings/" class="md-nav__link">
2175+
settings
2176+
</a>
2177+
</li>
2178+
2179+
2180+
2181+
22172182
</ul>
22182183
</nav>
22192184
</li>
@@ -2453,55 +2418,6 @@
24532418
<nav class="md-nav" aria-label="0.36.0">
24542419
<ul class="md-nav__list">
24552420

2456-
<li class="md-nav__item">
2457-
<a href="#cli-changed-json-output-for-some-lib-core-config-board-and-sketch-commands" class="md-nav__link">
2458-
CLI changed JSON output for some lib, core, config, board, and sketch commands.
2459-
</a>
2460-
2461-
</li>
2462-
2463-
<li class="md-nav__item">
2464-
<a href="#the-grpc-ccarduinoclicommandsv1platformrelease-has-been-changed" class="md-nav__link">
2465-
The gRPC cc.arduino.cli.commands.v1.PlatformRelease has been changed.
2466-
</a>
2467-
2468-
</li>
2469-
2470-
<li class="md-nav__item">
2471-
<a href="#the-grpc-ccarduinoclicommandsv1platformsummary-has-been-changed" class="md-nav__link">
2472-
The gRPC cc.arduino.cli.commands.v1.PlatformSummary has been changed.
2473-
</a>
2474-
2475-
</li>
2476-
2477-
<li class="md-nav__item">
2478-
<a href="#core-list-now-returns-only-the-latest-version-that-can-be-installed" class="md-nav__link">
2479-
core list now returns only the latest version that can be installed.
2480-
</a>
2481-
2482-
</li>
2483-
2484-
<li class="md-nav__item">
2485-
<a href="#core-search-now-returns-the-latest-installable-version-of-a-core" class="md-nav__link">
2486-
core search now returns the latest installable version of a core.
2487-
</a>
2488-
2489-
</li>
2490-
2491-
<li class="md-nav__item">
2492-
<a href="#core-upgrade-and-core-install-will-install-the-latest-compatible-version" class="md-nav__link">
2493-
core upgrade and core install will install the latest compatible version.
2494-
</a>
2495-
2496-
</li>
2497-
2498-
<li class="md-nav__item">
2499-
<a href="#grpc-service-ccarduinoclisettingsv1-has-been-removed-and-all-rpc-calls-have-been-migrated-to-ccarduinoclicommandsv1" class="md-nav__link">
2500-
gRPC service cc.arduino.cli.settings.v1 has been removed, and all RPC calls have been migrated to cc.arduino.cli.commands.v1
2501-
</a>
2502-
2503-
</li>
2504-
25052421
<li class="md-nav__item">
25062422
<a href="#grpc-ccarduinoclicommandsv1librarysearchrequest-message-has-been-changed" class="md-nav__link">
25072423
gRPC cc.arduino.cli.commands.v1.LibrarySearchRequest message has been changed.
@@ -3587,102 +3503,6 @@
35873503
<h1 id="upgrading">Upgrading<a class="headerlink" href="#upgrading" title="Permanent link">&para;</a></h1>
35883504
<p>Here you can find a list of migration guides to handle breaking changes between releases of the CLI.</p>
35893505
<h2 id="0360">0.36.0<a class="headerlink" href="#0360" title="Permanent link">&para;</a></h2>
3590-
<h3 id="cli-changed-json-output-for-some-lib-core-config-board-and-sketch-commands">CLI changed JSON output for some <code>lib</code>, <code>core</code>, <code>config</code>, <code>board</code>, and <code>sketch</code> commands.<a class="headerlink" href="#cli-changed-json-output-for-some-lib-core-config-board-and-sketch-commands" title="Permanent link">&para;</a></h3>
3591-
<ul>
3592-
<li>
3593-
<p><code>arduino-cli lib list --format json</code> results are now wrapped under <code>installed_libraries</code> key</p>
3594-
<div class="highlight"><pre><span></span><code>{ &quot;installed_libraries&quot;: [ {...}, {...} ] }
3595-
</code></pre></div>
3596-
</li>
3597-
</ul>
3598-
<ul>
3599-
<li>
3600-
<p><code>arduino-cli lib examples --format json</code> results are now wrapped under <code>examples</code> key</p>
3601-
<div class="highlight"><pre><span></span><code>{ &quot;examples&quot;: [ {...}, {...} ] }
3602-
</code></pre></div>
3603-
</li>
3604-
</ul>
3605-
<ul>
3606-
<li>
3607-
<p><code>arduino-cli core search --format json</code> and <code>arduino-cli core list --format json</code> results are now wrapped under
3608-
<code>platforms</code> key</p>
3609-
<div class="highlight"><pre><span></span><code>{ &quot;platforms&quot;: [ {...}, {...} ] }
3610-
</code></pre></div>
3611-
</li>
3612-
</ul>
3613-
<ul>
3614-
<li>
3615-
<p><code>arduino-cli config init --format json</code> now correctly returns a json object containg the config path</p>
3616-
<div class="highlight"><pre><span></span><code>{ &quot;config_path&quot;: &quot;/home/user/.arduino15/arduino-cli.yaml&quot; }
3617-
</code></pre></div>
3618-
</li>
3619-
</ul>
3620-
<ul>
3621-
<li>
3622-
<p><code>arduino-cli config dump --format json</code> results are now wrapped under <code>config</code> key</p>
3623-
<div class="highlight"><pre><span></span><code>{ &quot;config&quot;: { ... } }
3624-
</code></pre></div>
3625-
</li>
3626-
</ul>
3627-
<ul>
3628-
<li>
3629-
<p><code>arduino-cli board search --format json</code> results are now wrapped under <code>boards</code> key</p>
3630-
<div class="highlight"><pre><span></span><code>{ &quot;boards&quot;: [ {...}, {...} ] }
3631-
</code></pre></div>
3632-
</li>
3633-
</ul>
3634-
<ul>
3635-
<li>
3636-
<p><code>arduino-cli board list --format json</code> results are now wrapped under <code>detected_ports</code> key</p>
3637-
<div class="highlight"><pre><span></span><code>{ &quot;detected_ports&quot;: [ {...}, {...} ] }
3638-
</code></pre></div>
3639-
</li>
3640-
</ul>
3641-
<ul>
3642-
<li>
3643-
<p><code>arduino-cli sketch new</code> now correctly returns a json object containing the sketch path</p>
3644-
<div class="highlight"><pre><span></span><code>{ &quot;sketch_path&quot;: &quot;/tmp/my_sketch&quot; }
3645-
</code></pre></div>
3646-
</li>
3647-
</ul>
3648-
<h3 id="the-grpc-ccarduinoclicommandsv1platformrelease-has-been-changed">The gRPC <code>cc.arduino.cli.commands.v1.PlatformRelease</code> has been changed.<a class="headerlink" href="#the-grpc-ccarduinoclicommandsv1platformrelease-has-been-changed" title="Permanent link">&para;</a></h3>
3649-
<p>We've added a new field called <code>compatible</code>. This field indicates if the current platform release is installable or not.
3650-
It may happen that a platform doesn't have a dependency available for an OS/ARCH, in such cases, if we try to install
3651-
the platform it will fail. The new field can be used to know upfront if a specific release is installable.</p>
3652-
<h3 id="the-grpc-ccarduinoclicommandsv1platformsummary-has-been-changed">The gRPC <code>cc.arduino.cli.commands.v1.PlatformSummary</code> has been changed.<a class="headerlink" href="#the-grpc-ccarduinoclicommandsv1platformsummary-has-been-changed" title="Permanent link">&para;</a></h3>
3653-
<p>We've modified the behavior of <code>latest_version</code>. Now this field indicates the latest version that can be installed in
3654-
the current OS/ARCH.</p>
3655-
<h3 id="core-list-now-returns-only-the-latest-version-that-can-be-installed"><code>core list</code> now returns only the latest version that can be installed.<a class="headerlink" href="#core-list-now-returns-only-the-latest-version-that-can-be-installed" title="Permanent link">&para;</a></h3>
3656-
<p>Previously, we showed the latest version without checking if all the dependencies were available in the current OS/ARCH.
3657-
Now, the latest version will always point to an installable one even if a newer incompatible one is present.</p>
3658-
<h3 id="core-search-now-returns-the-latest-installable-version-of-a-core"><code>core search</code> now returns the latest installable version of a core.<a class="headerlink" href="#core-search-now-returns-the-latest-installable-version-of-a-core" title="Permanent link">&para;</a></h3>
3659-
<p>We now show in the <code>version</code> column the latest installable version. If none are available then we show a <code>n/a</code> label.
3660-
The corresponding command with <code>--format json</code> now returns the same output of
3661-
<code>arduino-cli core search --all --format json</code>.</p>
3662-
<h3 id="core-upgrade-and-core-install-will-install-the-latest-compatible-version"><code>core upgrade</code> and <code>core install</code> will install the latest compatible version.<a class="headerlink" href="#core-upgrade-and-core-install-will-install-the-latest-compatible-version" title="Permanent link">&para;</a></h3>
3663-
<p>Previously, we'd have tried the installation/upgrade of a core even if all the required tools weren't available in the
3664-
current OS/ARCH. Now we check this upfront, and allowing the installation of incompatible versions only if a user
3665-
explicitly provides it like: <code>core install arduino:renesas_uno@1.0.2</code></p>
3666-
<h3 id="grpc-service-ccarduinoclisettingsv1-has-been-removed-and-all-rpc-calls-have-been-migrated-to-ccarduinoclicommandsv1">gRPC service <code>cc.arduino.cli.settings.v1</code> has been removed, and all RPC calls have been migrated to <code>cc.arduino.cli.commands.v1</code><a class="headerlink" href="#grpc-service-ccarduinoclisettingsv1-has-been-removed-and-all-rpc-calls-have-been-migrated-to-ccarduinoclicommandsv1" title="Permanent link">&para;</a></h3>
3667-
<p>The service <code>cc.arduino.cli.settings.v1</code> no longer exists and all existing RPC calls have been moved to the
3668-
<code>cc.arduino.cli.commands.v1</code> service adding a <code>Settings</code> prefix to the names of all messages. The existing RPC calls:</p>
3669-
<ul>
3670-
<li><code>rpc GetAll(GetAllRequest) returns (GetAllResponse)</code></li>
3671-
<li><code>rpc Merge(MergeRequest) returns (MergeResponse)</code></li>
3672-
<li><code>rpc GetValue(GetValueRequest) returns (GetValueResponse)</code></li>
3673-
<li><code>rpc SetValue(SetValueRequest) returns (SetValueResponse)</code></li>
3674-
<li><code>rpc Write(WriteRequest) returns (WriteResponse)</code></li>
3675-
<li><code>rpc Delete(DeleteRequest) returns (DeleteResponse)</code></li>
3676-
</ul>
3677-
<p>are now renamed to:</p>
3678-
<ul>
3679-
<li><code>rpc SettingsGetAll(SettingsGetAllRequest) returns (SettingsGetAllResponse)</code></li>
3680-
<li><code>rpc SettingsMerge(SettingsMergeRequest) returns (SettingsMergeResponse)</code></li>
3681-
<li><code>rpc SettingsGetValue(SettingsGetValueRequest) returns (SettingsGetValueResponse)</code></li>
3682-
<li><code>rpc SettingsSetValue(SettingsSetValueRequest) returns (SettingsSetValueResponse)</code></li>
3683-
<li><code>rpc SettingsWrite(SettingsWriteRequest) returns (SettingsWriteResponse)</code></li>
3684-
<li><code>rpc SettingsDelete(SettingsDeleteRequest) returns (SettingsDeleteResponse)</code></li>
3685-
</ul>
36863506
<h3 id="grpc-ccarduinoclicommandsv1librarysearchrequest-message-has-been-changed">gRPC <code>cc.arduino.cli.commands.v1.LibrarySearchRequest</code> message has been changed.<a class="headerlink" href="#grpc-ccarduinoclicommandsv1librarysearchrequest-message-has-been-changed" title="Permanent link">&para;</a></h3>
36873507
<p>The <code>query</code> field has been removed, use <code>search_args</code> instead.</p>
36883508
<h3 id="cli-core-list-and-core-search-changed-json-output">CLI <code>core list</code> and <code>core search</code> changed JSON output.<a class="headerlink" href="#cli-core-list-and-core-search-changed-json-output" title="Permanent link">&para;</a></h3>
@@ -3842,7 +3662,7 @@ <h3 id="cli-debug-info-changed-json-output">CLI <code>debug --info</code> change
38423662
<span class="w"> </span><span class="nt">&quot;executable&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/tmp/arduino/sketches/002050EAA7EFB9A4FC451CDFBC0FA2D3/Blink.ino.elf&quot;</span><span class="p">,</span>
38433663
<span class="w"> </span><span class="nt">&quot;toolchain&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;gcc&quot;</span><span class="p">,</span>
38443664
<span class="w"> </span><span class="nt">&quot;toolchain_path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/home/user/.arduino15/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4/bin/&quot;</span><span class="p">,</span>
3845-
<span class="w"> </span><span class="nt">&quot;toolchain_prefix&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arm-none-eabi&quot;</span><span class="p">,</span>
3665+
<span class="w"> </span><span class="nt">&quot;toolchain_prefix&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arm-none-eabi-&quot;</span><span class="p">,</span>
38463666
<span class="w"> </span><span class="nt">&quot;server&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;openocd&quot;</span><span class="p">,</span>
38473667
<span class="w"> </span><span class="nt">&quot;server_path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/bin/openocd&quot;</span><span class="p">,</span>
38483668
<span class="w"> </span><span class="nt">&quot;server_configuration&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
@@ -5544,7 +5364,7 @@ <h3 id="changes-in-debug-command">Changes in <code>debug</code> command<a class=
55445364
<div class="highlight"><pre><span></span><code>debug.executable={build.path}/{build.project_name}.elf
55455365
debug.toolchain=gcc
55465366
debug.toolchain.path={runtime.tools.arm-none-eabi-gcc-7-2017q4.path}/bin/
5547-
debug.toolchain.prefix=arm-none-eabi
5367+
debug.toolchain.prefix=arm-none-eabi-
55485368
debug.server=openocd
55495369
debug.server.openocd.path={runtime.tools.openocd-0.10.0-arduino7.path}/bin/
55505370
debug.server.openocd.scripts_dir={runtime.tools.openocd-0.10.0-arduino7.path}/share/openocd/scripts/

‎dev/command-line-completion/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1150,6 +1150,20 @@
11501150

11511151

11521152

1153+
1154+
1155+
1156+
1157+
1158+
<li class="md-nav__item">
1159+
<a href="../rpc/settings/" class="md-nav__link">
1160+
settings
1161+
</a>
1162+
</li>
1163+
1164+
1165+
1166+
11531167
</ul>
11541168
</nav>
11551169
</li>

‎dev/commands/arduino-cli/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,6 +1131,20 @@
11311131

11321132

11331133

1134+
1135+
1136+
1137+
1138+
1139+
<li class="md-nav__item">
1140+
<a href="../../rpc/settings/" class="md-nav__link">
1141+
settings
1142+
</a>
1143+
</li>
1144+
1145+
1146+
1147+
11341148
</ul>
11351149
</nav>
11361150
</li>

‎dev/commands/arduino-cli_board/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,6 +1138,20 @@
11381138

11391139

11401140

1141+
1142+
1143+
1144+
1145+
1146+
<li class="md-nav__item">
1147+
<a href="../../rpc/settings/" class="md-nav__link">
1148+
settings
1149+
</a>
1150+
</li>
1151+
1152+
1153+
1154+
11411155
</ul>
11421156
</nav>
11431157
</li>

0 commit comments

Comments
 (0)