Skip to content

Commit

Permalink
Deployed a47e35f to dev with MkDocs 1.3.0 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ArduinoBot committed Aug 23, 2023
1 parent 8bb2a14 commit 8f7eebb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
2 changes: 1 addition & 1 deletion dev/search/search_index.json

Large diffs are not rendered by default.

Binary file modified dev/sitemap.xml.gz
Binary file not shown.
27 changes: 25 additions & 2 deletions dev/sketch-project-file/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1202,6 +1202,13 @@
Building a sketch
</a>

</li>

<li class="md-nav__item">
<a href="#using-a-default-profile" class="md-nav__link">
Using a default profile
</a>

</li>

</ul>
Expand Down Expand Up @@ -1385,6 +1392,13 @@
Building a sketch
</a>

</li>

<li class="md-nav__item">
<a href="#using-a-default-profile" class="md-nav__link">
Using a default profile
</a>

</li>

</ul>
Expand Down Expand Up @@ -1506,6 +1520,8 @@ <h2 id="build-profiles">Build profiles<a class="headerlink" href="#build-profile
- ArduinoIoTCloud (1.0.2)
- Arduino_ConnectionHandler (0.6.4)
- TinyDHT sensor library (1.1.0)

default_profile: nanorp
</code></pre></div>
<h3 id="building-a-sketch">Building a sketch<a class="headerlink" href="#building-a-sketch" title="Permanent link">&para;</a></h3>
<p>When a sketch project file is present, it can be leveraged to compile the sketch with the <code>--profile/-m</code> flag in the
Expand All @@ -1520,21 +1536,28 @@ <h3 id="building-a-sketch">Building a sketch<a class="headerlink" href="#buildin
not be used in any way. In other words, the build is isolated from the system and will rely only on the resources
specified in the profile: this will ensure that the build is portable and reproducible independently from the platforms
and libraries installed in the system.</p>
<h3 id="using-a-default-profile">Using a default profile<a class="headerlink" href="#using-a-default-profile" title="Permanent link">&para;</a></h3>
<p>If a <code>default_profile</code> is specified in the <code>sketch.yaml</code> then the “classic” compile command:</p>
<div class="highlight"><pre><span></span><code>arduino-cli compile [sketch]
</code></pre></div>
<p>will, instead, trigger a profile-based build using the default profile indicated in the <code>sketch.yaml</code>.</p>
<h2 id="default-flags-for-arduino-cli-usage">Default flags for Arduino CLI usage<a class="headerlink" href="#default-flags-for-arduino-cli-usage" title="Permanent link">&para;</a></h2>
<p>The sketch project file may be used to set the default value for some command line flags of the Arduino CLI, in
particular:</p>
<ul>
<li>The <code>default_fqbn</code> key sets the default value for the <code>--fqbn</code> flag</li>
<li>The <code>default_port</code> key sets the default value for the <code>--port</code> flag</li>
<li>The <code>default_protocol</code> key sets the default value for the <code>--protocol</code> flag</li>
<li>The <code>default_profile</code> key sets the default value for the <code>--profile</code> flag</li>
</ul>
<p>For example:</p>
<div class="highlight"><pre><span></span><code>default_fqbn: arduino:avr:uno
default_port: /dev/ttyACM0
default_protocol: serial
default_profile: myprofile
</code></pre></div>
<p>With this configuration set, it is not necessary to specify the <code>--fqbn</code>, <code>--port</code>, or <code>--protocol</code> flags to the
<a href="../commands/arduino-cli_compile/"><code>arduino-cli compile</code></a> or <a href="../commands/arduino-cli_upload/"><code>arduino-cli upload</code></a>
<p>With this configuration set, it is not necessary to specify the <code>--fqbn</code>, <code>--port</code>, <code>--protocol</code> or <code>--profile</code> flags to
the <a href="../commands/arduino-cli_compile/"><code>arduino-cli compile</code></a> or <a href="../commands/arduino-cli_upload/"><code>arduino-cli upload</code></a>
commands when compiling or uploading the sketch.</p>


Expand Down

0 comments on commit 8f7eebb

Please sign in to comment.