Skip to content

Commit

Permalink
Add doc build snapshot nightly
Browse files Browse the repository at this point in the history
  • Loading branch information
pionix-compiler committed Sep 13, 2024
1 parent ed2304a commit 6c0d89e
Show file tree
Hide file tree
Showing 8 changed files with 94 additions and 74 deletions.
38 changes: 26 additions & 12 deletions docs/latest/_sources/hardware/pionix_belay_box.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -166,27 +166,37 @@ Yocto-based image including EVerest in form of BaseCamp.

Now to the steps to flash the board:

(1) Download the latest stable image and the matching .bmap file:
(a) https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2
(b) https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap
**STEP 1: Downloading**

(2) Power up the BelayBox or - if the Yak is used alone - apply 12 V to the
"12 IN" pins.
Download the latest stable image and the matching .bmap file:

* https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2
* https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap

**STEP 2: Powering up**

Power up the BelayBox or - if the Yak is used alone - apply 12 V to
the "12 IN" pins.

The red power LED on the Yak should light up constantly now.

(3) Connect the Yak board via Micro-USB to the host system.
**STEP 3: Connect Yak to host system**

(4) Enable the CM4 storage mode so that the eMMC becomes available to the host
system:
Connect the Yak board via Micro-USB to the host system.

.. code-block:: bash
**STEP 4: Enabling CM4 storage mode**

Enable the CM4 storage mode so that the eMMC becomes available to
the host system:

.. code-block:: bash
sudo rpiboot
The green LED on the Yak board should light up constantly now.

(5) To find the eMMC device, do:
**STEP 5: Finding the eMMC device**

To find the eMMC device, do:

.. code-block:: bash
Expand All @@ -200,7 +210,9 @@ where X can be any letter.
Make sure to select the correct device as data loss can occure if the wrong
device is selected!

(6) Make sure the .wic.bz2 file and the .bmap file are in the same directory
**STEP 6: Flash the eMMC**

Make sure the .wic.bz2 file and the .bmap file are in the same directory
and flash the eMMC. In the command below, replace <image file>.bz2 with your
downloaded image file and replace "X" according to your eMMC device.

Expand All @@ -215,7 +227,9 @@ After roughly nine minutes the flashing should have finished.
activates the external antenna support. Running a flashed Yak without the
WiFi antenna mounted can result in damage of the WiFi chip.

(7) Disconnect the eMMC device, power off and unplug the "boot" jumper from the
**STEP 7: Finishing**

Disconnect the eMMC device, power off and unplug the "boot" jumper from the
Yak board.

.. image:: img/yak-assembly-9.jpg
Expand Down
4 changes: 2 additions & 2 deletions docs/latest/appendix/02_snapshot.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2024.6.0</span>
<span class="nt">everest</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/EVerest.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7481fe82f79eb5d9dc62d279a1ea5fadb37120f7</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5bdbca95d32f22b9cb94b1584c25e59268fa32d7</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
<span class="nt">everest-core</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/everest-core.git</span>
Expand All @@ -73,7 +73,7 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.3.1</span>
<span class="nt">everest.github.io</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:everest/everest.github.io.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a705378d48f603891bc9b033fd29b6f86fde4cd8</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ed2304afcb00a3dae15e1a29def1bec9a5c21744</span>
<span class="nt">ext-mbedtls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cmake_condition</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EVEREST_DEPENDENCY_ENABLED_MBEDTLS</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/ext-mbedtls.git</span>
Expand Down
40 changes: 18 additions & 22 deletions docs/latest/hardware/pionix_belay_box.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,30 +178,24 @@ <h3><span class="section-number">11.2.2. </span>Flashing the Yak Board<a class="
<a class="reference external" href="https://github.com/PionixPublic/yeti-yak-sdk">Yeti-Yak-SDK repository</a>.</p>
</div>
<p>Now to the steps to flash the board:</p>
<ol class="arabic simple">
<li><p>Download the latest stable image and the matching .bmap file:</p></li>
</ol>
<blockquote>
<div><ol class="loweralpha simple">
<p><strong>STEP 1: Downloading</strong></p>
<p>Download the latest stable image and the matching .bmap file:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2">https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2</a></p></li>
<li><p><a class="reference external" href="https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap">https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap</a></p></li>
</ol>
</div></blockquote>
<p>(2) Power up the BelayBox or - if the Yak is used alone - apply 12 V to the
“12 IN” pins.</p>
</ul>
<p><strong>STEP 2: Powering up</strong></p>
<p>Power up the BelayBox or - if the Yak is used alone - apply 12 V to
the “12 IN” pins.</p>
<p>The red power LED on the Yak should light up constantly now.</p>
<ol class="arabic simple" start="3">
<li><p>Connect the Yak board via Micro-USB to the host system.</p></li>
</ol>
<p>(4) Enable the CM4 storage mode so that the eMMC becomes available to the host
system:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>rpiboot
</pre></div>
</div>
<p><strong>STEP 3: Connect Yak to host system</strong></p>
<p>Connect the Yak board via Micro-USB to the host system.</p>
<p><strong>STEP 4: Enabling CM4 storage mode</strong></p>
<p>Enable the CM4 storage mode so that the eMMC becomes available to
the host system:</p>
<p>The green LED on the Yak board should light up constantly now.</p>
<ol class="arabic simple" start="5">
<li><p>To find the eMMC device, do:</p></li>
</ol>
<p><strong>STEP 5: Finding the eMMC device</strong></p>
<p>To find the eMMC device, do:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>lsblk
</pre></div>
</div>
Expand All @@ -212,7 +206,8 @@ <h3><span class="section-number">11.2.2. </span>Flashing the Yak Board<a class="
<p>Make sure to select the correct device as data loss can occure if the wrong
device is selected!</p>
</div>
<p>(6) Make sure the .wic.bz2 file and the .bmap file are in the same directory
<p><strong>STEP 6: Flash the eMMC</strong></p>
<p>Make sure the .wic.bz2 file and the .bmap file are in the same directory
and flash the eMMC. In the command below, replace &lt;image file&gt;.bz2 with your
downloaded image file and replace “X” according to your eMMC device.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>bmaptool<span class="w"> </span>copy<span class="w"> </span>&lt;image<span class="w"> </span>file&gt;.bz2<span class="w"> </span>/dev/sdX
Expand All @@ -225,7 +220,8 @@ <h3><span class="section-number">11.2.2. </span>Flashing the Yak Board<a class="
activates the external antenna support. Running a flashed Yak without the
WiFi antenna mounted can result in damage of the WiFi chip.</p>
</div>
<p>(7) Disconnect the eMMC device, power off and unplug the “boot” jumper from the
<p><strong>STEP 7: Finishing</strong></p>
<p>Disconnect the eMMC device, power off and unplug the “boot” jumper from the
Yak board.</p>
<img alt="../_images/yak-assembly-9.jpg" src="../_images/yak-assembly-9.jpg" />
<p>With the raspberry CM4, it can be that the overlay filesystem sometimes does
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/searchindex.js

Large diffs are not rendered by default.

38 changes: 26 additions & 12 deletions docs/nightly/_sources/hardware/pionix_belay_box.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -166,27 +166,37 @@ Yocto-based image including EVerest in form of BaseCamp.

Now to the steps to flash the board:

(1) Download the latest stable image and the matching .bmap file:
(a) https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2
(b) https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap
**STEP 1: Downloading**

(2) Power up the BelayBox or - if the Yak is used alone - apply 12 V to the
"12 IN" pins.
Download the latest stable image and the matching .bmap file:

* https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2
* https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap

**STEP 2: Powering up**

Power up the BelayBox or - if the Yak is used alone - apply 12 V to
the "12 IN" pins.

The red power LED on the Yak should light up constantly now.

(3) Connect the Yak board via Micro-USB to the host system.
**STEP 3: Connect Yak to host system**

(4) Enable the CM4 storage mode so that the eMMC becomes available to the host
system:
Connect the Yak board via Micro-USB to the host system.

.. code-block:: bash
**STEP 4: Enabling CM4 storage mode**

Enable the CM4 storage mode so that the eMMC becomes available to
the host system:

.. code-block:: bash
sudo rpiboot
The green LED on the Yak board should light up constantly now.

(5) To find the eMMC device, do:
**STEP 5: Finding the eMMC device**

To find the eMMC device, do:

.. code-block:: bash
Expand All @@ -200,7 +210,9 @@ where X can be any letter.
Make sure to select the correct device as data loss can occure if the wrong
device is selected!

(6) Make sure the .wic.bz2 file and the .bmap file are in the same directory
**STEP 6: Flash the eMMC**

Make sure the .wic.bz2 file and the .bmap file are in the same directory
and flash the eMMC. In the command below, replace <image file>.bz2 with your
downloaded image file and replace "X" according to your eMMC device.

Expand All @@ -215,7 +227,9 @@ After roughly nine minutes the flashing should have finished.
activates the external antenna support. Running a flashed Yak without the
WiFi antenna mounted can result in damage of the WiFi chip.

(7) Disconnect the eMMC device, power off and unplug the "boot" jumper from the
**STEP 7: Finishing**

Disconnect the eMMC device, power off and unplug the "boot" jumper from the
Yak board.

.. image:: img/yak-assembly-9.jpg
Expand Down
4 changes: 2 additions & 2 deletions docs/nightly/appendix/02_snapshot.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2024.6.0</span>
<span class="nt">everest</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/EVerest.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7481fe82f79eb5d9dc62d279a1ea5fadb37120f7</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5bdbca95d32f22b9cb94b1584c25e59268fa32d7</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
<span class="nt">everest-core</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/everest-core.git</span>
Expand All @@ -73,7 +73,7 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.3.1</span>
<span class="nt">everest.github.io</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:everest/everest.github.io.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a705378d48f603891bc9b033fd29b6f86fde4cd8</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ed2304afcb00a3dae15e1a29def1bec9a5c21744</span>
<span class="nt">ext-mbedtls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cmake_condition</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EVEREST_DEPENDENCY_ENABLED_MBEDTLS</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/ext-mbedtls.git</span>
Expand Down
40 changes: 18 additions & 22 deletions docs/nightly/hardware/pionix_belay_box.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,30 +178,24 @@ <h3><span class="section-number">11.2.2. </span>Flashing the Yak Board<a class="
<a class="reference external" href="https://github.com/PionixPublic/yeti-yak-sdk">Yeti-Yak-SDK repository</a>.</p>
</div>
<p>Now to the steps to flash the board:</p>
<ol class="arabic simple">
<li><p>Download the latest stable image and the matching .bmap file:</p></li>
</ol>
<blockquote>
<div><ol class="loweralpha simple">
<p><strong>STEP 1: Downloading</strong></p>
<p>Download the latest stable image and the matching .bmap file:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2">https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bz2</a></p></li>
<li><p><a class="reference external" href="https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap">https://pionix-update.de/belaybox-basecamp-demo/stable/belaybox-image-raspberrypi4-20240912100805.rootfs.wic.bmap</a></p></li>
</ol>
</div></blockquote>
<p>(2) Power up the BelayBox or - if the Yak is used alone - apply 12 V to the
“12 IN” pins.</p>
</ul>
<p><strong>STEP 2: Powering up</strong></p>
<p>Power up the BelayBox or - if the Yak is used alone - apply 12 V to
the “12 IN” pins.</p>
<p>The red power LED on the Yak should light up constantly now.</p>
<ol class="arabic simple" start="3">
<li><p>Connect the Yak board via Micro-USB to the host system.</p></li>
</ol>
<p>(4) Enable the CM4 storage mode so that the eMMC becomes available to the host
system:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>rpiboot
</pre></div>
</div>
<p><strong>STEP 3: Connect Yak to host system</strong></p>
<p>Connect the Yak board via Micro-USB to the host system.</p>
<p><strong>STEP 4: Enabling CM4 storage mode</strong></p>
<p>Enable the CM4 storage mode so that the eMMC becomes available to
the host system:</p>
<p>The green LED on the Yak board should light up constantly now.</p>
<ol class="arabic simple" start="5">
<li><p>To find the eMMC device, do:</p></li>
</ol>
<p><strong>STEP 5: Finding the eMMC device</strong></p>
<p>To find the eMMC device, do:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>lsblk
</pre></div>
</div>
Expand All @@ -212,7 +206,8 @@ <h3><span class="section-number">11.2.2. </span>Flashing the Yak Board<a class="
<p>Make sure to select the correct device as data loss can occure if the wrong
device is selected!</p>
</div>
<p>(6) Make sure the .wic.bz2 file and the .bmap file are in the same directory
<p><strong>STEP 6: Flash the eMMC</strong></p>
<p>Make sure the .wic.bz2 file and the .bmap file are in the same directory
and flash the eMMC. In the command below, replace &lt;image file&gt;.bz2 with your
downloaded image file and replace “X” according to your eMMC device.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>bmaptool<span class="w"> </span>copy<span class="w"> </span>&lt;image<span class="w"> </span>file&gt;.bz2<span class="w"> </span>/dev/sdX
Expand All @@ -225,7 +220,8 @@ <h3><span class="section-number">11.2.2. </span>Flashing the Yak Board<a class="
activates the external antenna support. Running a flashed Yak without the
WiFi antenna mounted can result in damage of the WiFi chip.</p>
</div>
<p>(7) Disconnect the eMMC device, power off and unplug the “boot” jumper from the
<p><strong>STEP 7: Finishing</strong></p>
<p>Disconnect the eMMC device, power off and unplug the “boot” jumper from the
Yak board.</p>
<img alt="../_images/yak-assembly-9.jpg" src="../_images/yak-assembly-9.jpg" />
<p>With the raspberry CM4, it can be that the overlay filesystem sometimes does
Expand Down
2 changes: 1 addition & 1 deletion docs/nightly/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 6c0d89e

Please sign in to comment.