Skip to content

Commit 81e2584

Browse files
committed
Deployed 1f8d0f6 to 0.35 with MkDocs 1.3.0 and mike 1.1.2
1 parent 971b497 commit 81e2584

File tree

77 files changed

+310
-310
lines changed

Some content is hidden

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

77 files changed

+310
-310
lines changed

0.35/CONTRIBUTING/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2033,8 +2033,8 @@ <h3 id="about-easyjson-golang-library">About <code>easyjson</code> golang librar
20332033
changes in the generated code.</p>
20342034
<h3 id="additional-settings">Additional settings<a class="headerlink" href="#additional-settings" title="Permanent link">&para;</a></h3>
20352035
<p>If you need to push a commit that's only shipping documentation changes or example files, thus a complete no-op for the
2036-
test suite, please start the commit message with the string <strong>[skip ci]</strong> to skip the build and give that slot to
2037-
someone else who does need it.</p>
2036+
test suite, please start the commit message with the string <strong>[skip ci]</strong> to skip the build and give that slot to someone
2037+
else who does need it.</p>
20382038
<p>If your PR doesn't need to be included in the changelog, please start the commit message and PR title with the string
20392039
<strong>[skip changelog]</strong></p>
20402040

0.35/integration-options/index.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1470,8 +1470,8 @@ <h1 id="the-three-pillars-of-the-arduino-cli">The three pillars of the Arduino C
14701470
compile, verify and upload sketches to Arduino boards and that’s capable of managing all the software and tools needed
14711471
in the process. But don’t get fooled by its name: Arduino CLI can do much more than the average console application, as
14721472
shown by <a href="https://github.com/arduino/arduino-ide">Arduino IDE 2.x</a> and <a href="https://cloud.arduino.cc/home">Arduino Cloud</a>, which rely on it for similar purposes but each one in a
1473-
completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining
1474-
how we designed the software so that it can be effectively leveraged under different scenarios.</p>
1473+
completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining how
1474+
we designed the software so that it can be effectively leveraged under different scenarios.</p>
14751475
<h2 id="the-first-pillar-command-line-interface">The first pillar: command line interface<a class="headerlink" href="#the-first-pillar-command-line-interface" title="Permanent link">&para;</a></h2>
14761476
<h3 id="console-applications-for-humans">Console applications for humans<a class="headerlink" href="#console-applications-for-humans" title="Permanent link">&para;</a></h3>
14771477
<p>As you might expect, the first way to use the Arduino CLI is from a terminal and by a human, and user experience plays a
@@ -1495,15 +1495,14 @@ <h3 id="console-applications-for-robots">Console applications for robots<a class
14951495
like.</p>
14961496
<p><img alt="JSON output screenshot" src="../img/CLI_JSON_output_screenshot.png" /></p>
14971497
<p>Even if not related to software design, one last feature that’s worth mentioning is the availability of a one-line
1498-
<a href="../installation/#use-the-install-script">installation script</a> that can be used to make the latest version of the Arduino CLI available on most systems with an
1499-
HTTP client like curl or wget and a shell like bash.</p>
1498+
<a href="../installation/#use-the-install-script">installation script</a> that can be used to make the latest version of the Arduino CLI available on most systems with an HTTP
1499+
client like curl or wget and a shell like bash.</p>
15001500
<p>For more information on Arduino CLI's command line interface, see the <a href="../commands/arduino-cli/">command reference</a>.</p>
15011501
<h2 id="the-second-pillar-grpc-interface">The second pillar: gRPC interface<a class="headerlink" href="#the-second-pillar-grpc-interface" title="Permanent link">&para;</a></h2>
15021502
<p><a href="https://grpc.io/">gRPC</a> is a high performance <a href="https://en.wikipedia.org/wiki/Remote_procedure_call">RPC</a> framework that can efficiently connect client and server applications. The Arduino
1503-
CLI can act as a gRPC server (we call it <a href="../commands/arduino-cli_daemon/">daemon mode</a>), exposing a set of procedures that implement the very same set
1504-
of features of the command line interface and waiting for clients to connect and use them. To give an idea, the
1505-
following is some <a href="https://go.dev/">Golang</a> code capable of retrieving the version number of a remote running Arduino CLI server
1506-
instance:</p>
1503+
CLI can act as a gRPC server (we call it <a href="../commands/arduino-cli_daemon/">daemon mode</a>), exposing a set of procedures that implement the very same set of
1504+
features of the command line interface and waiting for clients to connect and use them. To give an idea, the following is
1505+
some <a href="https://go.dev/">Golang</a> code capable of retrieving the version number of a remote running Arduino CLI server instance:</p>
15071506
<p><img alt="gRPC interface screenshot" src="../img/CLI_gRPC_interface_screenshot.png" /></p>
15081507
<p>gRPC is language agnostic: even if the example is written in Golang, the programming language used for the client can be
15091508
Python, JavaScript or any of the many <a href="https://grpc.io/docs/languages/">supported ones</a>, leading to a variety of possible
@@ -1518,8 +1517,8 @@ <h2 id="the-third-pillar-embedding">The third pillar: embedding<a class="headerl
15181517
a common Golang API, a set of functions that abstract all the functionalities offered by the Arduino CLI, so that when
15191518
we provide a fix or a new feature, they are automatically available to both the command line and gRPC interfaces. The
15201519
source modules implementing this API can be imported in other Golang programs to embed a full-fledged Arduino CLI. For
1521-
example, this is how some backend services powering <a href="https://cloud.arduino.cc/home">Arduino Cloud</a> can compile sketches and manage libraries. Just to
1522-
give you a taste of what it means to embed the Arduino CLI, here is how to search for a core using the API:</p>
1520+
example, this is how some backend services powering <a href="https://cloud.arduino.cc/home">Arduino Cloud</a> can compile sketches and manage libraries. Just to give
1521+
you a taste of what it means to embed the Arduino CLI, here is how to search for a core using the API:</p>
15231522
<p><img alt="Go library interface screenshot" src="../img/CLI_Go_library_interface_screenshot.png" /></p>
15241523
<p>Embedding the Arduino CLI is limited to Golang applications and requires a deep knowledge of its internals. For the
15251524
average use case, the gRPC interface might be a better alternative. Nevertheless, this remains a valid option that we
@@ -1528,7 +1527,8 @@ <h2 id="conclusions">Conclusions<a class="headerlink" href="#conclusions" title=
15281527
<p>You can start playing with the Arduino CLI right away. The code is open source and <a href="https://github.com/arduino/arduino-cli">the repo</a>
15291528
contains <a href="https://github.com/arduino/arduino-cli/blob/master/client_example">example code showing how to implement a gRPC client</a>. If you’re curious about how we
15301529
designed the low level API, have a look at the <a href="https://github.com/arduino/arduino-cli/tree/master/commands">commands package</a> and don’t hesitate to leave feedback on the <a href="https://github.com/arduino/arduino-cli/issues">issue
1531-
tracker</a> if you’ve got a use case that doesn’t fit one of the three pillars.</p>
1530+
tracker</a>
1531+
if you’ve got a use case that doesn’t fit one of the three pillars.</p>
15321532

15331533

15341534

0 commit comments

Comments
 (0)