Skip to content

Commit e58c06a

Browse files
ArduinoBotArduinoBot
committed
Deployed ae68728 to dev with MkDocs 1.6.1 and mike 1.1.2
1 parent ffeb440 commit e58c06a

File tree

79 files changed

+12598
-3398
lines changed

Some content is hidden

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

79 files changed

+12598
-3398
lines changed

‎dev/404.html

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313

1414
<link rel="icon" href="/arduino-cli/dev/assets/images/favicon.png">
15-
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-7.3.6">
15+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-7.3.6">
1616

1717

1818

@@ -573,6 +573,20 @@
573573

574574

575575

576+
<li class="md-nav__item">
577+
<a href="/arduino-cli/dev/commands/arduino-cli_config_get/" class="md-nav__link">
578+
config get
579+
</a>
580+
</li>
581+
582+
583+
584+
585+
586+
587+
588+
589+
576590
<li class="md-nav__item">
577591
<a href="/arduino-cli/dev/commands/arduino-cli_config_remove/" class="md-nav__link">
578592
config remove
@@ -741,6 +755,20 @@
741755

742756

743757

758+
<li class="md-nav__item">
759+
<a href="/arduino-cli/dev/commands/arduino-cli_debug_check/" class="md-nav__link">
760+
debug check
761+
</a>
762+
</li>
763+
764+
765+
766+
767+
768+
769+
770+
771+
744772
<li class="md-nav__item">
745773
<a href="/arduino-cli/dev/commands/arduino-cli_lib/" class="md-nav__link">
746774
lib
@@ -1254,6 +1282,21 @@
12541282

12551283

12561284

1285+
1286+
1287+
1288+
1289+
1290+
1291+
1292+
<li class="md-nav__item">
1293+
<a href="/arduino-cli/dev/versioning/" class="md-nav__link">
1294+
Backward compatibility policy
1295+
</a>
1296+
</li>
1297+
1298+
1299+
12571300
</ul>
12581301
</nav>
12591302
</div>

‎dev/CONTRIBUTING/index.html

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<link rel="canonical" href="https://arduino.github.io/arduino-cli/dev/CONTRIBUTING/">
1515

1616
<link rel="icon" href="../assets/images/favicon.png">
17-
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-7.3.6">
17+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-7.3.6">
1818

1919

2020

@@ -819,6 +819,20 @@
819819

820820

821821

822+
<li class="md-nav__item">
823+
<a href="../commands/arduino-cli_config_get/" class="md-nav__link">
824+
config get
825+
</a>
826+
</li>
827+
828+
829+
830+
831+
832+
833+
834+
835+
822836
<li class="md-nav__item">
823837
<a href="../commands/arduino-cli_config_remove/" class="md-nav__link">
824838
config remove
@@ -987,6 +1001,20 @@
9871001

9881002

9891003

1004+
<li class="md-nav__item">
1005+
<a href="../commands/arduino-cli_debug_check/" class="md-nav__link">
1006+
debug check
1007+
</a>
1008+
</li>
1009+
1010+
1011+
1012+
1013+
1014+
1015+
1016+
1017+
9901018
<li class="md-nav__item">
9911019
<a href="../commands/arduino-cli_lib/" class="md-nav__link">
9921020
lib
@@ -1500,6 +1528,21 @@
15001528

15011529

15021530

1531+
1532+
1533+
1534+
1535+
1536+
1537+
1538+
<li class="md-nav__item">
1539+
<a href="../versioning/" class="md-nav__link">
1540+
Backward compatibility policy
1541+
</a>
1542+
</li>
1543+
1544+
1545+
15031546
</ul>
15041547
</nav>
15051548
</div>
@@ -1768,7 +1811,7 @@ <h1 id="how-to-contribute">How to contribute<a class="headerlink" href="#how-to-
17681811
<td>Issue report (read the <a href="#issue-reports">issue guidelines</a>)</td>
17691812
</tr>
17701813
<tr>
1771-
<td>Beta testing</td>
1814+
<td>Testing</td>
17721815
<td>Try out the <a href="https://arduino.github.io/arduino-cli/latest/installation/#nightly-builds">nightly build</a></td>
17731816
</tr>
17741817
<tr>
@@ -1777,7 +1820,7 @@ <h1 id="how-to-contribute">How to contribute<a class="headerlink" href="#how-to-
17771820
</tr>
17781821
<tr>
17791822
<td>Translations for Arduino CLI</td>
1780-
<td><a href="https://www.transifex.com/arduino-1/arduino-cli/">transifex</a></td>
1823+
<td>Use the <a href="https://www.transifex.com/arduino-1/arduino-cli/">transifex</a> platform</td>
17811824
</tr>
17821825
<tr>
17831826
<td>Monetary</td>
@@ -1842,13 +1885,7 @@ <h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites"
18421885
</ul>
18431886
<p>If you're working on the gRPC interface you will also have to:</p>
18441887
<ul>
1845-
<li>download and install the <a href="https://github.com/protocolbuffers/protobuf/releases">protoc</a> compiler (use the version required to match the generated code, please note that
1846-
the latest releases does not follow semantic versioning anymore so, for example, the version 4.24.3 must be searched
1847-
as 24.3 dropping the major number)</li>
1848-
<li>install <code>protoc-gen-go</code> using: <code>go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.31.0</code> (use the version
1849-
required to match the generated code)</li>
1850-
<li>install <code>protoc-gen-go-grpc</code> using: <code>go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0</code> (use the version
1851-
required to match the generated code)</li>
1888+
<li>download and install <a href="https://buf.build/docs/installation/">buf</a> our tool to compile and generate proto files</li>
18521889
</ul>
18531890
<h3 id="building-the-source-code">Building the source code<a class="headerlink" href="#building-the-source-code" title="Permanent link">&para;</a></h3>
18541891
<p>From the project folder root, just run:</p>
@@ -1990,7 +2027,7 @@ <h3 id="internationalization-i18n">Internationalization (i18n)<a class="headerli
19902027

19912028
<span class="kn">import</span><span class="w"> </span><span class="p">(</span>
19922029
<span class="w"> </span><span class="s">&quot;fmt&quot;</span>
1993-
<span class="w"> </span><span class="s">&quot;github.com/arduino/arduino-cli/i18n&quot;</span>
2030+
<span class="w"> </span><span class="s">&quot;github.com/arduino/arduino-cli/internal/i18n&quot;</span>
19942031
<span class="p">)</span>
19952032

19962033
<span class="kd">func</span><span class="w"> </span><span class="nx">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>

‎dev/FAQ/index.html

Lines changed: 71 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<link rel="canonical" href="https://arduino.github.io/arduino-cli/dev/FAQ/">
1515

1616
<link rel="icon" href="../assets/images/favicon.png">
17-
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-7.3.6">
17+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-7.3.6">
1818

1919

2020

@@ -365,6 +365,13 @@
365365
How to change monitor configuration?
366366
</a>
367367

368+
</li>
369+
370+
<li class="md-nav__item">
371+
<a href="#permission-denied-error-in-sketch-upload" class="md-nav__link">
372+
"Permission denied" error in sketch upload
373+
</a>
374+
368375
</li>
369376

370377
<li class="md-nav__item">
@@ -653,6 +660,20 @@
653660

654661

655662

663+
<li class="md-nav__item">
664+
<a href="../commands/arduino-cli_config_get/" class="md-nav__link">
665+
config get
666+
</a>
667+
</li>
668+
669+
670+
671+
672+
673+
674+
675+
676+
656677
<li class="md-nav__item">
657678
<a href="../commands/arduino-cli_config_remove/" class="md-nav__link">
658679
config remove
@@ -821,6 +842,20 @@
821842

822843

823844

845+
<li class="md-nav__item">
846+
<a href="../commands/arduino-cli_debug_check/" class="md-nav__link">
847+
debug check
848+
</a>
849+
</li>
850+
851+
852+
853+
854+
855+
856+
857+
858+
824859
<li class="md-nav__item">
825860
<a href="../commands/arduino-cli_lib/" class="md-nav__link">
826861
lib
@@ -1334,6 +1369,21 @@
13341369

13351370

13361371

1372+
1373+
1374+
1375+
1376+
1377+
1378+
1379+
<li class="md-nav__item">
1380+
<a href="../versioning/" class="md-nav__link">
1381+
Backward compatibility policy
1382+
</a>
1383+
</li>
1384+
1385+
1386+
13371387
</ul>
13381388
</nav>
13391389
</div>
@@ -1392,6 +1442,13 @@
13921442
How to change monitor configuration?
13931443
</a>
13941444

1445+
</li>
1446+
1447+
<li class="md-nav__item">
1448+
<a href="#permission-denied-error-in-sketch-upload" class="md-nav__link">
1449+
"Permission denied" error in sketch upload
1450+
</a>
1451+
13951452
</li>
13961453

13971454
<li class="md-nav__item">
@@ -1429,21 +1486,31 @@ <h2 id="arduino-nanounomega-is-not-detected">Arduino Nano/Uno/Mega is not detect
14291486
USB2Serial chip, but we don’t know which board that chip is on.</li>
14301487
</ul>
14311488
<h2 id="whats-the-fqbn-string">What's the FQBN string?<a class="headerlink" href="#whats-the-fqbn-string" title="Permanent link">&para;</a></h2>
1432-
<p>For a deeper understanding of how FQBN works, you should understand the <a href="../platform-specification/">Arduino platform specification</a>.</p>
1489+
<p>FQBN stands for Fully Qualified Board Name. It has the following format:
1490+
<code>VENDOR:ARCHITECTURE:BOARD_ID[:MENU_ID=OPTION_ID[,MENU2_ID=OPTION_ID ...]]</code>, with each <code>MENU_ID=OPTION_ID</code> being an
1491+
optional key-value pair configuration. The <code>VENDOR</code> and <code>ARCHITECTURE</code> parts can be empty. For a deeper understanding of
1492+
how FQBN works, you should understand the <a href="../platform-specification/">Arduino platform specification</a>.</p>
14331493
<h2 id="how-to-set-multiple-board-options">How to set multiple board options?<a class="headerlink" href="#how-to-set-multiple-board-options" title="Permanent link">&para;</a></h2>
14341494
<p>Additional board options have to be separated by commas (instead of colon):</p>
14351495
<p><code>$ arduino-cli compile --fqbn "esp8266:esp8266:generic:xtal=160,baud=57600" TestSketch</code></p>
14361496
<h2 id="where-is-the-serial-monitor">Where is the Serial Monitor?<a class="headerlink" href="#where-is-the-serial-monitor" title="Permanent link">&para;</a></h2>
14371497
<p>The serial monitor is available through the <a href="../commands/arduino-cli_monitor/">monitor command</a>. By the way, the functionality provided
14381498
by this command is very limited and you may want to look for other tools if you need more advanced functionality.</p>
1439-
<p>There are many excellent serial terminals to chose from. On Linux or macOS, you may already have <a href="https://www.gnu.org/software/screen/manual/screen.html">screen</a>
1440-
installed. On Windows, a good choice for command line usage is Plink, included with <a href="https://www.chiark.greenend.org.uk/~sgtatham/putty/">PuTTY</a>.</p>
1499+
<p>There are many excellent serial terminals to chose from. On Linux or macOS, you may already have <code>screen</code> installed. On
1500+
Windows, a good choice for command line usage is Plink, included with <a href="https://www.chiark.greenend.org.uk/~sgtatham/putty/">PuTTY</a>.</p>
14411501
<h2 id="how-to-change-monitor-configuration">How to change monitor configuration?<a class="headerlink" href="#how-to-change-monitor-configuration" title="Permanent link">&para;</a></h2>
14421502
<p><a href="../pluggable-monitor-specification/#describe-command">Configuration parameters</a> of the monitor can be obtained by executing the following command:</p>
14431503
<p><code>$ arduino-cli monitor -p &lt;port&gt; --describe</code></p>
14441504
<p>These parameters can be modified by passing a list of <code>&lt;key&gt;=&lt;desiredValue&gt;</code> pairs to the <code>--config</code> flag. For example,
14451505
when using a serial port, the monitor baud rate can be set to 4800 with the following command:</p>
14461506
<p><code>$ arduino-cli monitor -p &lt;port&gt; --config baudrate=4800</code></p>
1507+
<h2 id="permission-denied-error-in-sketch-upload">"Permission denied" error in sketch upload<a class="headerlink" href="#permission-denied-error-in-sketch-upload" title="Permanent link">&para;</a></h2>
1508+
<p>This problem might happen on some Linux systems, and can be solved by setting up serial port permissions. First, search
1509+
for the port your board is connected to, with the command:</p>
1510+
<p><code>$ arduino-cli board list</code></p>
1511+
<p>Then add your user to the group with the following command, replacing <code>&lt;username&gt;</code> with your username and <code>&lt;group&gt;</code> with
1512+
your group name. Logging out and in again is necessary for the changes to take effect.</p>
1513+
<p><code>$ sudo usermod -a -G &lt;group&gt; &lt;username&gt;</code></p>
14471514
<h2 id="additional-assistance">Additional assistance<a class="headerlink" href="#additional-assistance" title="Permanent link">&para;</a></h2>
14481515
<p>If your question wasn't answered, feel free to ask on <a href="https://forum.arduino.cc/c/software/arduino-cli/89">Arduino CLI's forum board</a>.</p>
14491516

0 commit comments

Comments
 (0)