From 1be4eabe5570e72dd081e2f50f91177e5641296d Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Wed, 29 May 2024 22:33:38 -0500 Subject: [PATCH 1/8] update balena etcher reference to point to 1.18.11 warn against versions older than 1.18.11 --- source/docs/installation/sw_install/gloworm.rst | 4 ++-- source/docs/installation/sw_install/orange-pi.rst | 4 ++-- source/docs/installation/sw_install/raspberry-pi.rst | 4 ++-- source/docs/installation/sw_install/snakeyes.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/source/docs/installation/sw_install/gloworm.rst b/source/docs/installation/sw_install/gloworm.rst index 77cfebb1..e208cd81 100644 --- a/source/docs/installation/sw_install/gloworm.rst +++ b/source/docs/installation/sw_install/gloworm.rst @@ -10,7 +10,7 @@ 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 `_ to flash an image onto the coprocessor. +Use the 1.18.11 version of `Balena Etcher `_ to flash an image onto the coprocessor. Run BalenaEtcher as an administrator. Select the downloaded ``.zip`` file. @@ -18,7 +18,7 @@ Select the compute module. If it doesn't show up after 30s try using another USB 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 the latest Balena Etcher will fix this issue. Final Steps ----------- diff --git a/source/docs/installation/sw_install/orange-pi.rst b/source/docs/installation/sw_install/orange-pi.rst index 9e4b8f31..a02f68df 100644 --- a/source/docs/installation/sw_install/orange-pi.rst +++ b/source/docs/installation/sw_install/orange-pi.rst @@ -12,11 +12,11 @@ Flashing the Pi Image --------------------- An 8GB or larger SD card is recommended. -Use `Balena 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 `_ 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 `_. -.. 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 the latest Balena Etcher will fix this issue. .. note:: If you are working on Linux, "dd" can be used in the command line to flash an image. diff --git a/source/docs/installation/sw_install/raspberry-pi.rst b/source/docs/installation/sw_install/raspberry-pi.rst index 0e950ee8..eca69619 100644 --- a/source/docs/installation/sw_install/raspberry-pi.rst +++ b/source/docs/installation/sw_install/raspberry-pi.rst @@ -12,11 +12,11 @@ Flashing the Pi Image --------------------- An 8GB or larger card is recommended. -Use `Balena 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 `_ 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 `_. -.. 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 the latest Balena Etcher will fix this issue. If you are using a non-standard Pi Camera connected to the CSI port, :ref:`additional configuration may be required. ` diff --git a/source/docs/installation/sw_install/snakeyes.rst b/source/docs/installation/sw_install/snakeyes.rst index fde6b7f7..aaf74bd6 100644 --- a/source/docs/installation/sw_install/snakeyes.rst +++ b/source/docs/installation/sw_install/snakeyes.rst @@ -10,11 +10,11 @@ Flashing the SnakeEyes Image ---------------------------- An 8GB or larger card is recommended. -Use `Balena 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 `_ 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 `_. -.. 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 the latest Balena Etcher will fix this issue. Final Steps ----------- From 8f1804581e26197e275106603133eb54945b835c Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Wed, 29 May 2024 22:39:30 -0500 Subject: [PATCH 2/8] update warning to advise updating to 1.18.11 --- source/docs/installation/sw_install/gloworm.rst | 2 +- source/docs/installation/sw_install/orange-pi.rst | 2 +- source/docs/installation/sw_install/raspberry-pi.rst | 2 +- source/docs/installation/sw_install/snakeyes.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/docs/installation/sw_install/gloworm.rst b/source/docs/installation/sw_install/gloworm.rst index e208cd81..2dfc3454 100644 --- a/source/docs/installation/sw_install/gloworm.rst +++ b/source/docs/installation/sw_install/gloworm.rst @@ -18,7 +18,7 @@ Select the compute module. If it doesn't show up after 30s try using another USB Hit flash. Wait for flashing to complete, then disconnect your USB C cable. -.. 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 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 ----------- diff --git a/source/docs/installation/sw_install/orange-pi.rst b/source/docs/installation/sw_install/orange-pi.rst index a02f68df..349f9f0b 100644 --- a/source/docs/installation/sw_install/orange-pi.rst +++ b/source/docs/installation/sw_install/orange-pi.rst @@ -16,7 +16,7 @@ Use the 1.18.11 version of `Balena Etcher `_. -.. 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 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. .. note:: If you are working on Linux, "dd" can be used in the command line to flash an image. diff --git a/source/docs/installation/sw_install/raspberry-pi.rst b/source/docs/installation/sw_install/raspberry-pi.rst index eca69619..d0cd9237 100644 --- a/source/docs/installation/sw_install/raspberry-pi.rst +++ b/source/docs/installation/sw_install/raspberry-pi.rst @@ -16,7 +16,7 @@ Use the 1.18.11 version of `Balena Etcher `_. -.. 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 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. If you are using a non-standard Pi Camera connected to the CSI port, :ref:`additional configuration may be required. ` diff --git a/source/docs/installation/sw_install/snakeyes.rst b/source/docs/installation/sw_install/snakeyes.rst index aaf74bd6..094ae053 100644 --- a/source/docs/installation/sw_install/snakeyes.rst +++ b/source/docs/installation/sw_install/snakeyes.rst @@ -14,7 +14,7 @@ Use the 1.18.11 version of `Balena Etcher `_. -.. 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 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. Final Steps ----------- From deb98367068d578f0ccff9205cb48c818fa58ddb Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Wed, 29 May 2024 22:54:25 -0500 Subject: [PATCH 3/8] add rpi as an alternative to balena etcher --- source/docs/installation/sw_install/orange-pi.rst | 4 ++++ source/docs/installation/sw_install/raspberry-pi.rst | 4 ++++ source/docs/installation/sw_install/snakeyes.rst | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/source/docs/installation/sw_install/orange-pi.rst b/source/docs/installation/sw_install/orange-pi.rst index 349f9f0b..a42546c2 100644 --- a/source/docs/installation/sw_install/orange-pi.rst +++ b/source/docs/installation/sw_install/orange-pi.rst @@ -18,6 +18,10 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ 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. If you're using an Orange Pi 5, that's it! Orange Pi 4 users will need to install PhotonVision (see below). diff --git a/source/docs/installation/sw_install/raspberry-pi.rst b/source/docs/installation/sw_install/raspberry-pi.rst index d0cd9237..6ce4e8a6 100644 --- a/source/docs/installation/sw_install/raspberry-pi.rst +++ b/source/docs/installation/sw_install/raspberry-pi.rst @@ -18,6 +18,10 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ 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. ` Final Steps diff --git a/source/docs/installation/sw_install/snakeyes.rst b/source/docs/installation/sw_install/snakeyes.rst index 094ae053..546e1f78 100644 --- a/source/docs/installation/sw_install/snakeyes.rst +++ b/source/docs/installation/sw_install/snakeyes.rst @@ -16,6 +16,10 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ 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 ----------- Insert the flashed microSD card into your Raspberry Pi and boot it up. The first boot may take a few minutes as the Pi expands the filesystem. Be sure not to unplug during this process. From e51661f0b3afff54b8487c2866c479ee5b2649c1 Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Thu, 30 May 2024 11:36:14 -0500 Subject: [PATCH 4/8] Update link to libcamera documentation --- source/docs/hardware/picamconfig.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/hardware/picamconfig.rst b/source/docs/hardware/picamconfig.rst index 4e053a8c..c4509605 100644 --- a/source/docs/hardware/picamconfig.rst +++ b/source/docs/hardware/picamconfig.rst @@ -52,4 +52,4 @@ Save the file, close the editor, and eject the drive. The boot configuration sho Additional Information ---------------------- -See `the libcamera documentation `_ for more details on configuring cameras. +See `the libcamera documentation `_ for more details on configuring cameras. From 18efbebde7f86c33b368c72d2071a1e455ee31ce Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Thu, 30 May 2024 11:59:47 -0500 Subject: [PATCH 5/8] Update Raspberry Pi Imager URL --- source/docs/installation/sw_install/orange-pi.rst | 2 +- source/docs/installation/sw_install/raspberry-pi.rst | 2 +- source/docs/installation/sw_install/snakeyes.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/docs/installation/sw_install/orange-pi.rst b/source/docs/installation/sw_install/orange-pi.rst index a42546c2..30142c6b 100644 --- a/source/docs/installation/sw_install/orange-pi.rst +++ b/source/docs/installation/sw_install/orange-pi.rst @@ -18,7 +18,7 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ to flash the image. +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. diff --git a/source/docs/installation/sw_install/raspberry-pi.rst b/source/docs/installation/sw_install/raspberry-pi.rst index 6ce4e8a6..1da50a79 100644 --- a/source/docs/installation/sw_install/raspberry-pi.rst +++ b/source/docs/installation/sw_install/raspberry-pi.rst @@ -18,7 +18,7 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ to flash the image. +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. diff --git a/source/docs/installation/sw_install/snakeyes.rst b/source/docs/installation/sw_install/snakeyes.rst index 546e1f78..00ee1817 100644 --- a/source/docs/installation/sw_install/snakeyes.rst +++ b/source/docs/installation/sw_install/snakeyes.rst @@ -16,7 +16,7 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ to flash the image. +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. From d32af967d01d42af45697bd836f7dc1941c7ba55 Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Thu, 30 May 2024 12:14:47 -0500 Subject: [PATCH 6/8] updates to pass lint check --- source/docs/hardware/picamconfig.rst | 2 +- source/docs/installation/sw_install/orange-pi.rst | 2 +- source/docs/installation/sw_install/raspberry-pi.rst | 2 +- source/docs/installation/sw_install/snakeyes.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/docs/hardware/picamconfig.rst b/source/docs/hardware/picamconfig.rst index c4509605..085d795f 100644 --- a/source/docs/hardware/picamconfig.rst +++ b/source/docs/hardware/picamconfig.rst @@ -52,4 +52,4 @@ Save the file, close the editor, and eject the drive. The boot configuration sho Additional Information ---------------------- -See `the libcamera documentation `_ for more details on configuring cameras. +See `the libcamera documentation `_ for more details on configuring cameras. diff --git a/source/docs/installation/sw_install/orange-pi.rst b/source/docs/installation/sw_install/orange-pi.rst index 30142c6b..c99805c1 100644 --- a/source/docs/installation/sw_install/orange-pi.rst +++ b/source/docs/installation/sw_install/orange-pi.rst @@ -18,7 +18,7 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ to flash the image. +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. diff --git a/source/docs/installation/sw_install/raspberry-pi.rst b/source/docs/installation/sw_install/raspberry-pi.rst index 1da50a79..7dd61740 100644 --- a/source/docs/installation/sw_install/raspberry-pi.rst +++ b/source/docs/installation/sw_install/raspberry-pi.rst @@ -18,7 +18,7 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ to flash the image. +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. diff --git a/source/docs/installation/sw_install/snakeyes.rst b/source/docs/installation/sw_install/snakeyes.rst index 00ee1817..971a32f5 100644 --- a/source/docs/installation/sw_install/snakeyes.rst +++ b/source/docs/installation/sw_install/snakeyes.rst @@ -16,7 +16,7 @@ For more detailed instructions on using Etcher, please see the `Etcher website < .. 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 `_ to flash the image. +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. From 9350ada355053f21198a1266ea2198d55ed92b9e Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Thu, 30 May 2024 12:51:41 -0500 Subject: [PATCH 7/8] fix #346 --- source/docs/pipelines/output.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/pipelines/output.rst b/source/docs/pipelines/output.rst index b5ab9e9b..3ec552c5 100644 --- a/source/docs/pipelines/output.rst +++ b/source/docs/pipelines/output.rst @@ -13,7 +13,7 @@ This section also includes a switch to enable processing and sending multiple ta .. raw:: html From 99bc55a7e47963940824ba7791d3ad825080962a Mon Sep 17 00:00:00 2001 From: Sam948-byte Date: Thu, 30 May 2024 16:36:17 -0500 Subject: [PATCH 8/8] add raspberry pi link to exclude for linkcheck --- source/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/conf.py b/source/conf.py index fe71374c..0b350a83 100644 --- a/source/conf.py +++ b/source/conf.py @@ -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/' +] \ No newline at end of file