Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
Update balena etcher references to point to 1.18.11 closes #357 (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam948-byte authored May 30, 2024
1 parent e89c2af commit 5fa174f
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 10 deletions.
6 changes: 6 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,9 @@ def setup(app):
suppress_warnings = ['epub.unknown_project_files']

sphinx_tabs_valid_builders = ['epub', 'linkcheck']

# Excluded links for linkcheck
# These should be periodically checked by hand to ensure that they are still functional
linkcheck_ignore = [
'https://www.raspberrypi.com/software/'
]
2 changes: 1 addition & 1 deletion source/docs/hardware/picamconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Save the file, close the editor, and eject the drive. The boot configuration sho
Additional Information
----------------------

See `the libcamera documentation <https://github.com/raspberrypi/documentation/blob/develop/documentation/asciidoc/computers/camera/rpicam_apps_getting_started.adoc>`_ for more details on configuring cameras.
See `the libcamera documentation <https://github.com/raspberrypi/documentation/blob/679fab721855a3e8f17aa51819e5c2a7c447e98d/documentation/asciidoc/computers/camera/rpicam_configuration.adoc>`_ for more details on configuring cameras.
4 changes: 2 additions & 2 deletions source/docs/installation/sw_install/gloworm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Flashing the Gloworm Image
--------------------------
Plug a USB C cable from your computer into the USB C port on Gloworm labeled with a download icon.

Use `Balena Etcher <https://www.balena.io/etcher/>`_ to flash an image onto the coprocessor.
Use the 1.18.11 version of `Balena Etcher <https://github.com/balena-io/etcher/releases/tag/v1.18.11>`_ to flash an image onto the coprocessor.

Run BalenaEtcher as an administrator. Select the downloaded ``.zip`` file.

Select the compute module. If it doesn't show up after 30s try using another USB port, initialization may take a while. If prompted, install the recommended missing drivers.

Hit flash. Wait for flashing to complete, then disconnect your USB C cable.

.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Gloworm. Updating to the latest Balena Etcher will fix this issue.
.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Gloworm. Updating to 1.18.11 will fix this issue.

Final Steps
-----------
Expand Down
8 changes: 6 additions & 2 deletions source/docs/installation/sw_install/orange-pi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ Flashing the Pi Image
---------------------
An 8GB or larger SD card is recommended.

Use `Balena Etcher <https://www.balena.io/etcher/>`_ to flash an image onto a Orange Pi. Select the downloaded image file, select your microSD card, and flash.
Use the 1.18.11 version of `Balena Etcher <https://github.com/balena-io/etcher/releases/tag/v1.18.11>`_ to flash an image onto a Orange Pi. Select the downloaded image file, select your microSD card, and flash.

For more detailed instructions on using Etcher, please see the `Etcher website <https://www.balena.io/etcher/>`_.

.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Orange Pi. Updating to the latest Balena Etcher will fix this issue.
.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Orange Pi. Updating to 1.18.11 will fix this issue.

Alternatively, you can use the `Raspberry Pi Imager <https://www.raspberrypi.com/software/>`_ to flash the image.

Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash.

.. note:: If you are working on Linux, "dd" can be used in the command line to flash an image.

Expand Down
8 changes: 6 additions & 2 deletions source/docs/installation/sw_install/raspberry-pi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ Flashing the Pi Image
---------------------
An 8GB or larger card is recommended.

Use `Balena Etcher <https://www.balena.io/etcher/>`_ to flash an image onto a Raspberry Pi. Select the downloaded ``.tar.xz`` file, select your microSD card, and flash.
Use the 1.18.11 version of `Balena Etcher <https://github.com/balena-io/etcher/releases/tag/v1.18.11>`_ to flash an image onto a Raspberry Pi. Select the downloaded ``.tar.xz`` file, select your microSD card, and flash.

For more detailed instructions on using Etcher, please see the `Etcher website <https://www.balena.io/etcher/>`_.

.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to the latest Balena Etcher will fix this issue.
.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to 1.18.11 will fix this issue.

Alternatively, you can use the `Raspberry Pi Imager <https://www.raspberrypi.com/software/>`_ to flash the image.

Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash.

If you are using a non-standard Pi Camera connected to the CSI port, :ref:`additional configuration may be required. <docs/hardware/picamconfig:Pi Camera Configuration>`

Expand Down
8 changes: 6 additions & 2 deletions source/docs/installation/sw_install/snakeyes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,15 @@ Flashing the SnakeEyes Image
----------------------------
An 8GB or larger card is recommended.

Use `Balena Etcher <https://www.balena.io/etcher/>`_ to flash an image onto a Raspberry Pi. Select the downloaded ``.zip`` file, select your microSD card, and flash.
Use the 1.18.11 version of `Balena Etcher <https://github.com/balena-io/etcher/releases/tag/v1.18.11>`_ to flash an image onto a Raspberry Pi. Select the downloaded ``.zip`` file, select your microSD card, and flash.

For more detailed instructions on using Etcher, please see the `Etcher website <https://www.balena.io/etcher/>`_.

.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to the latest Balena Etcher will fix this issue.
.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to 1.18.11 will fix this issue.

Alternatively, you can use the `Raspberry Pi Imager <https://www.raspberrypi.com/software/>`_ to flash the image.

Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash.

Final Steps
-----------
Expand Down
2 changes: 1 addition & 1 deletion source/docs/pipelines/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section also includes a switch to enable processing and sending multiple ta
.. raw:: html

<video width="85%" controls>
<source src="../../../_static/assets/offsetandmultiple.mp4" type="video/mp4">
<source src="../../_static/assets/offsetandmultiple.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>

Expand Down

0 comments on commit 5fa174f

Please sign in to comment.