8000 Deployed 9595aa0 to dev with MkDocs 1.2.3 and mike 1.0.1 · arduino/arduino-fwuploader@d0bd514 · GitHub
[go: up one dir, main page]
Skip to content

Commit d0bd514

Browse files
ArduinoBotArduinoBot
committed
Deployed 9595aa0 to dev with MkDocs 1.2.3 and mike 1.0.1
1 parent df76226 commit d0bd514

File tree

12 files changed

+71
-102
lines changed

12 files changed

+71
-102
lines changed

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -530,16 +530,14 @@ <h2 id="arduino-fwuploader">arduino-fwuploader<a class="headerlink" href="#ardui
530530
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
531531
<p>Arduino Firmware Uploader (arduino-fwuploader).</p>
532532
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
533-
<div class="highlight"><pre><span></span><code> arduino-fwuploader &lt;command&gt; [flags...]
534-
</code></pre></div>
533+
<p><code>arduino-fwuploader &lt;command&gt; [flags...]</code></p>
535534
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
536-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
535+
<p><code>--format string The output format, can be {text|json}. (default "text")
537536
-h, --help help for arduino-fwuploader
538537
--log-file string Path to the file where logs will be written
539538
--log-format string The output format for the logs, can be {text|json}.
540-
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
541-
-v, --verbose Print the logs on the standard output.
542-
</code></pre></div>
539+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
540+
-v, --verbose Print the logs on the standard output.</code></p>
543541
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
544542
<ul>
545543
<li><a href="../arduino-fwuploader_certificates/">arduino-fwuploader certificates</a> - Commands to operate on certificates.</li>

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

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -544,18 +544,15 @@ <h2 id="arduino-fwuploader-certificates">arduino-fwuploader certificates<a class
544544
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
545545
<p>A subset of commands to perform various certificates operations.</p>
546546
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
547-
<div class="highlight"><pre><span></span><code> arduino-fwuploader certificates ...
548-
</code></pre></div>
547+
<p><code>arduino-fwuploader certificates ...</code></p>
549548
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
550-
<div class="highlight"><pre><span></span><code> -h, --help help for certificates
551-
</code></pre></div>
549+
<p><code>-h, --help help for certificates</code></p>
552550
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
553-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
551+
<p><code>--format string The output format, can be {text|json}. (default "text")
554552
--log-file string Path to the file where logs will be written
555553
--log-format string The output format for the logs, can be {text|json}.
556-
--log-lev 10000 el string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
557-
-v, --verbose Print the logs on the standard output.
558-
</code></pre></div>
554+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
555+
-v, --verbose Print the logs on the standard output.</code></p>
559556
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
560557
<ul>
561558
<li><a href="../arduino-fwuploader/">arduino-fwuploader</a> - arduino-fwuploader.</li>

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -543,27 +543,25 @@ <h2 id="arduino-fwuploader-certificates-flash">arduino-fwuploader certificates f
543543
<p>Flashes certificates to board.</p>
544544
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
545545
<p>Flashes specified certificates to board at specified address.</p>
546-
<div class="highlight"><pre><span></span><code>arduino-fwuploader certificates flash [flags]
547-
</code></pre></div>
546+
<p><code>arduino-fwuploader certificates flash [flags]</code></p>
548547
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
549-
<div class="highlight"><pre><span></span><code> arduino-fwuploader certificates flash --fqbn arduino:samd:mkr1000 --address COM10 --url arduino.cc:443 --file /home/me/Digicert.cer
548+
<p>```
549+
arduino-fwuploader certificates flash --fqbn arduino:samd:mkr1000 --address COM10 --url arduino.cc:443 --file /home/me/Digicert.cer
550550
arduino-fwuploader certificates flash -b arduino:samd:mkr1000 -a COM10 -u arduino.cc:443 -u google.com:443
551-
arduino-fwuploader certificates flash -b arduino:samd:mkr1000 -a COM10 -f /home/me/VeriSign.cer -f /home/me/Digicert.cer
552-
</code></pre></div>
551+
arduino-fwuploader certificates flash -b arduino:samd:mkr1000 -a COM10 -f /home/me/VeriSign.cer -f /home/me/Digicert.cer</p>
552+
<p>```</p>
553553
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
554-
<div class="highlight"><pre><span></span><code> -a, --address string Upload port, e.g.: COM10, /dev/ttyACM0
554+
<p><code>-a, --address string Upload port, e.g.: COM10, /dev/ttyACM0
555555
-f, --file strings List of paths to certificate file, e.g.: /home/me/Digicert.cer
556556
-b, --fqbn string Fully Qualified Board Name, e.g.: arduino:samd:mkr1000, arduino:mbed_nano:nanorp2040connect
557557
-h, --help help for flash
558-
-u, --url strings List of urls to download root certificates, e.g.: arduino.cc:443
559-
</code></pre></div>
558+
-u, --url strings List of urls to download root certificates, e.g.: arduino.cc:443</code></p>
560559
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
561-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
560+
<p><code>--format string The output format, can be {text|json}. (default "text")
562561
--log-file string Path to the file where logs will be written
563562
--log-format string The output format for the logs, can be {text|json}.
564-
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
565-
-v, --verbose Print the logs on the standard output.
566-
</code></pre></div>
563+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
564+
-v, --verbose Print the logs on the standard output.</code></p>
567565
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
568566
<ul>
569567
<li><a href="../arduino-fwuploader_certificates/">arduino-fwuploader certificates</a> - Commands to operate on certificates.</li>

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

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -544,18 +544,15 @@ <h2 id="arduino-fwuploader-firmware">arduino-fwuploader firmware<a class="header
544544
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
545545
<p>A subset of commands to perform various firmware operations.</p>
546546
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
547-
<div class="highlight"><pre><span></span><code> arduino-fwuploader firmware ...
548-
</code></pre></div>
547+
<p><code>arduino-fwuploader firmware ...</code></p>
549548
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
550-
<div class="highlight"><pre><span></span><code> -h, --help help for firmware
551-
</code></pre></div>
549+
<p><code>-h, --help help for firmware</code></p>
552550
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
553-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
551+
<p><code>--format string The output format, can be {text|json}. (default "text")
554552
--log-file string Path to the file where logs will be written
555553
--log-format string The output format for the logs, can be {text|json}.
556-
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
557-
-v, --verbose Print the logs on the standard output.
558-
</code></pre></div>
554+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
555+
-v, --verbose Print the logs on the standard output.</code></p>
559556
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
560557
<ul>
561558
<li><a href="../arduino-fwuploader/">arduino-fwuploader</a> - arduino-fwuploader.</li>

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -544,29 +544,27 @@ <h2 id="arduino-fwuploader-firmware-flash">arduino-fwuploader firmware flash<a c
544544
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
545545
<p>Flashes specified module firmware to board at specified address. Module name and version can be omitted to install
546546
latest version.</p>
547-
<div class="highlight"><pre><span></span><code>arduino-fwuploader firmware flash [flags]
548-
</code></pre></div>
547+
<p><code>arduino-fwuploader firmware flash [flags]</code></p>
549548
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
550-
<div class="highlight"><pre><span></span><code> arduino-fwuploader firmware flash --fqbn arduino:samd:mkr1000 --address COM10 --module WINC1500@19.5.2
549+
<p>```
550+
arduino-fwuploader firmware flash --fqbn arduino:samd:mkr1000 --address COM10 --module WINC1500<a class="magiclink magiclink-github magiclink-mention" href="https://github.com/19" title="GitHub User: 19">@19</a>.5.2
551551
arduino-fwuploader firmware flash -b arduino:samd:mkr1000 -a COM10 -m WINC15000
552552
arduino-fwuploader firmware flash -b arduino:samd:mkr1000 -a COM10
553-
arduino-fwuploader firmware flash -b arduino:samd:mkr1000 -a COM10 -i firmware.bin
554-
</code></pre></div>
553+
arduino-fwuploader firmware flash -b arduino:samd:mkr1000 -a COM10 -i firmware.bin</p>
554+
<p>```</p>
555555
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
556-
<div class="highlight"><pre><span></span><code> -a, --address string Upload port, e.g.: COM10, /dev/ttyACM0
556+
<p><code>-a, --address string Upload port, e.g.: COM10, /dev/ttyACM0
557557
-b, --fqbn string Fully Qualified Board Name, e.g.: arduino:samd:mkr1000, arduino:mbed_nano:nanorp2040connect
558558
-h, --help help for flash
559559
-i, --input-file string Path of the firmware to upload
560560
-m, --module string Firmware module ID, e.g.: WINC1500, NINA
561-
--retries uint8 Number of retries in case of upload failure (default 9) (default 9)
562-
</code></pre></div>
561+
--retries uint8 Number of retries in case of upload failure (default 9) (default 9)</code></p>
563562
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
564-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
563+
<p><code>--format string The output format, can be {text|json}. (default "text")
565564
--log-file string Path to the file where logs will be written
566565
--log-format string The output format for the logs, can be {text|json}.
567-
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
568-
-v, --verbose Print the logs on the standard output.
569-
</code></pre></div>
566+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
567+
-v, --verbose Print the logs on the standard output.</code></p>
570568
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
571569
<ul>
572570
<li><a href="../arduino-fwuploader_firmware/">arduino-fwuploader firmware</a> - Commands to operate on firmwares.</li>

‎dev/commands/arduino-fwuploader_firmware_get-version/index.html

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -543,24 +543,22 @@ <h2 id="arduino-fwuploader-firmware-get-version">arduino-fwuploader firmware get
543543
<p>Gets the version of the firmware the board is using.</p>
544544
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
545545
<p>Flashes a sketch to a board to obtain the firmware version used by the board</p>
546-
<div class="highlight"><pre><span></span><code>arduino-fwuploader firmware get-version [flags]
547-
</code></pre></div>
546+
<p><code>arduino-fwuploader firmware get-version [flags]</code></p>
548547
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
549-
<div class="highlight"><pre><span></span><code> arduino-fwuploader firmware get-version --fqbn arduino:samd:mkr1000 --address COM10
550-
arduino-fwuploader firmware get-version -b arduino:samd:mkr1000 -a COM10
551-
</code></pre></div>
548+
<p>```
549+
arduino-fwuploader firmware get-version --fqbn arduino:samd:mkr1000 --address COM10
550+
arduino-fwuploader firmware get-version -b arduino:samd:mkr1000 -a COM10</p>
551+
<p>```</p>
552552
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
553-
<div class="highlight"><pre><span></span><code> -a, --address string Upload port, e.g.: COM10, /dev/ttyACM0
553+
<p><code>-a, --address string Upload port, e.g.: COM10, /dev/ttyACM0
554554
-b, --fqbn string Fully Qualified Board Name, e.g.: arduino:samd:mkr1000, arduino:mbed_nano:nanorp2040connect
555-
-h, --help help for get-version
556-
</code></pre></div>
555+
-h, --help help for get-version</code></p>
557556
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
558-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
557+
<p><code>--format string The output format, can be {text|json}. (default "text")
559558
--log-file string Path to the file where logs will be written
560559
--log-format string The output format for the logs, can be {text|json}.
561-
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
562-
-v, --verbose Print the logs on the standard output.
563-
</code></pre></div>
560+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
561+
-v, --verbose Print the logs on the standard output.</code></p>
564562
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
565563
<ul>
566564
<li><a href="../arduino-fwuploader_firmware/">arduino-fwuploader firmware</a> - Commands to operate on firmwares.</li>

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

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -543,22 +543,18 @@ <h2 id="arduino-fwuploader-firmware-list">arduino-fwuploader firmware list<a cla
543543
<p>List available firmwares</p>
544544
<h3 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h3>
545545
<p>Displays the availale firmwares, is it possible to filter results for a specific board.</p>
546-
<div class="highlight"><pre><span></span><code>arduino-fwuploader firmware list [flags]
547-
</code></pre></div>
546+
<p><code>arduino-fwuploader firmware list [flags]</code></p>
548547
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
549-
<div class="highlight"><pre><span></span><code> arduino-fwuploader firmware list -b arduino:samd:mkr1000
550-
</code></pre></div>
548+
<p><code>arduino-fwuploader firmware list -b arduino:samd:mkr1000</code></p>
551549
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
552-
<div class="highlight"><pre><span></span><code> -b, --fqbn string Filter result for the specified board FQBN
553-
-h, --help help for list
554-
</code></pre></div>
550+
<p><code>-b, --fqbn string Filter result for the specified board FQBN
551+
-h, --help help for list</code></p>
555552
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
556-
<div class="highlight"><pre><span></span><code> --format string The output format, can be {text|json}. (default &quot;text&quot;)
553+
<p><code>--format string The output format, can be {text|json}. (default "text")
557554
--log-file string Path to the file where logs will be written
558555
--log-format string The output format for the logs, can be {text|json}.
559-
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default &quot;info&quot;)
560-
-v, --verbose Print the logs on the standard output.
561-
</code></pre></div>
556+
--log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
557+
-v, --verbose Print the logs on the standard output.</code></p>
562558
<h3 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h3>
563559
<ul>
564560
<li><a href="../arduino-fwuploader_firmware/">arduino-fwuploader firmware</a> - Commands to operate on firmwares.</li>

0 commit comments

Comments
 (0)
0