From fce576baedbdb5b39ea36644aba3032c078aa10f Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Tue, 25 Oct 2022 13:52:28 -0400
Subject: [PATCH] Fixed a bunch of spelling and linking errors
---
boards/beaglebone/ai-64/ch04.rst | 2 +-
boards/beaglebone/ai-64/ch11.rst | 2 +-
boards/beaglebone/ai/ch12.rst | 1 +
boards/beaglebone/black/ch07.rst | 8 ++++++--
boards/beaglebone/blue/accessories.rst | 7 ++++++-
boards/beaglebone/blue/tests.rst | 2 +-
boards/pocketbeagle/original/ch06.rst | 5 ++---
.../beaglebone-cookbook/02sensors/sensors.rst | 2 +-
books/beaglebone-cookbook/09capes/capes.rst | 12 ++++++++----
books/beaglebone-cookbook/10parts/parts.rst | 4 +---
books/beaglebone-cookbook/code | 2 +-
books/pru-cookbook/06io/io.rst | 2 +-
books/pru-cookbook/08ai/ai.rst | 2 +-
books/pru-cookbook/projects.rst | 18 ++++++++++++------
intro/contribution/git-usage.rst | 2 +-
intro/support/getting-started.rst | 2 +-
projects/simppru/examples/read_counter.rst | 2 +-
17 files changed, 46 insertions(+), 29 deletions(-)
diff --git a/boards/beaglebone/ai-64/ch04.rst b/boards/beaglebone/ai-64/ch04.rst
index 866f1a78..4ea164d9 100644
--- a/boards/beaglebone/ai-64/ch04.rst
+++ b/boards/beaglebone/ai-64/ch04.rst
@@ -27,7 +27,7 @@ BeagleBone AI-64 is manufactured and warranted by partners listed at https://bea
* Mark Yoder, professor at Rose-Hulman Institute of Technology
* Kathy Giori, product engineer at ZEDEDA
-See `bbb.io/about <bbb.io/about>`_
+See `bbb.io/about <https://beagleboard.org/about>`_
BeagleBone AI-64 has been designed by Seeed Studio (Seeed Development Limited) under guidance from BeagleBoard.org Foundation.
diff --git a/boards/beaglebone/ai-64/ch11.rst b/boards/beaglebone/ai-64/ch11.rst
index 3298d419..a458bd15 100644
--- a/boards/beaglebone/ai-64/ch11.rst
+++ b/boards/beaglebone/ai-64/ch11.rst
@@ -11,7 +11,7 @@ All support for this design is through BeagleBoard.org community at: link: `Beag
Hardware Design
------------------
-You can find all BeagleBone AI-64 hardware files `here <https://git.beagleboard.org/beagleboard/beaglebone-ai-64/-/tree/master/hw>`_ .
+You can find all BeagleBone AI-64 hardware files `here <https://git.beagleboard.org/beagleboard/beaglebone-ai-64>`_ under the `hw` folder.
.. _software-updates:
diff --git a/boards/beaglebone/ai/ch12.rst b/boards/beaglebone/ai/ch12.rst
index a5700477..b225f981 100644
--- a/boards/beaglebone/ai/ch12.rst
+++ b/boards/beaglebone/ai/ch12.rst
@@ -30,6 +30,7 @@ the equipment.
This Class A or B digital apparatus complies with Canadian ICES-003.
Changes or modifications not expressly approved by the party responsible
for compliance could void the user’s authority to operate the equipment.
+
Cet appareil numérique de la classe A ou B est conforme à la norme
NMB-003 du Canada. Les changements ou les modifications pas expressément
approuvés par la partie responsible de la conformité ont pu vider
diff --git a/boards/beaglebone/black/ch07.rst b/boards/beaglebone/black/ch07.rst
index de80c32a..57022518 100644
--- a/boards/beaglebone/black/ch07.rst
+++ b/boards/beaglebone/black/ch07.rst
@@ -1175,7 +1175,11 @@ Serial cable is recommended as shown in *Figure 55* below.
The cable can be purchased from several different places and must be the
3.3V version TTL-232R-3V3. Information on the cable itself can be found
-direct from FTDI at: `pdf <http://www.ftdichip.com/Support/Documents/DataSheets/Cables/DS_TTL232R_CABLES.pdf>`_
+direct from FTDI at: `pdf <https://ftdichip.com/wp-content/uploads/2020/07/DS_USB_RS232_CABLES.pdf>`_
+
+.. note:
+
+ #TODO#: move accessory links to a single common document for all boards.
Pin 1 of the cable is the black wire. That must align with the pin 1 on
the board which is designated by the white dot next to the connector on
@@ -1183,7 +1187,7 @@ the board.
Refer to the support WIKI `http://elinux.org/BeagleBoneBlack <http://elinux.org/BeagleBoneBlack>`_ for more sources of this cable and other options that will work.
-Table is the pinout of the connector as reflected in the schematic. It is the same as the FTDI cable which can be found at `http://www.ftdichip.com/Support/Documents/DataSheets/Cables/DS_TTL-232R_CABLES.pdf <http://www.ftdichip.com/Support/Documents/DataSheets/Cables/DS_TTL-232R_CABLES.pdf>`_ with the exception that only three pins are used on the board. The pin numbers are defined in *Table 14*. The signals are from the perspective of the board.
+Table is the pinout of the connector as reflected in the schematic. It is the same as the FTDI cable which can be found at `https://ftdichip.com/wp-content/uploads/2020/07/DS_USB_RS232_CABLES.pdf <https://ftdichip.com/wp-content/uploads/2020/07/DS_USB_RS232_CABLES.pdf>`_ with the exception that only three pins are used on the board. The pin numbers are defined in *Table 14*. The signals are from the perspective of the board.
.. list-table:: J1 Serial Header Pins
:header-rows: 1
diff --git a/boards/beaglebone/blue/accessories.rst b/boards/beaglebone/blue/accessories.rst
index 9bb37a61..3a44db18 100644
--- a/boards/beaglebone/blue/accessories.rst
+++ b/boards/beaglebone/blue/accessories.rst
@@ -3,6 +3,10 @@
Accessories
###############
+.. note::
+
+ #TODO#: We are going to work on a unified accessories page for all the boards and it should replace this.
+
.. _chassis_and_kits:
Chassis and kits
@@ -251,7 +255,8 @@ I2C devices
==============
- See
- `One-Liner-Module-Tests#Grove_I2C_modules <One-Liner-Module-Tests#Grove_I2C_modules>`__
+ :ref:`One-Liner-Module-Tests#i2c <beaglebone-blue-one-liner-tests>`__
+- See :ref:`bone101_i2c`.
.. _uart_devices:
diff --git a/boards/beaglebone/blue/tests.rst b/boards/beaglebone/blue/tests.rst
index 6b89d828..944b9efe 100644
--- a/boards/beaglebone/blue/tests.rst
+++ b/boards/beaglebone/blue/tests.rst
@@ -9,7 +9,7 @@ ADC
- `Grove Rotary Angle
Sensor <http://wiki.seeed.cc/Grove-Rotary_Angle_Sensor/>`__
See output on adc_1
- `source <https://github.com/StrawsonDesign/Robotics_Cape_Installer/blob/master/examples/rc_test_adc/rc_test_adc.c>`__
+ `source <https://git.beagleboard.org/beagleboard/librobotcontrol/-/blob/v1.1/examples/src/rc_test_adc.c>`__
.. code:: bash
diff --git a/boards/pocketbeagle/original/ch06.rst b/boards/pocketbeagle/original/ch06.rst
index 39c36f61..e0ee74f7 100644
--- a/boards/pocketbeagle/original/ch06.rst
+++ b/boards/pocketbeagle/original/ch06.rst
@@ -195,8 +195,7 @@ Additional documentation is located on the Texas Instruments website at
and also located at
`http://github.com/beagleboard/am335x_pru_package. <http://github.com/beagleboard/am335x_pru_package>`__
-Example projects using the PRU-ICSS can be found at
-`processors.wiki.ti.com/index.php/PRU_Projects <http://processors.wiki.ti.com/index.php/PRU_Projects>`__.
+Example projects using the PRU-ICSS can be found in :ref:`pru-cookbook-home`.
.. _pru_icss_features:
@@ -313,4 +312,4 @@ chart separately.
| P2.34 | PRU0_5 | C13 | B3 | | | pr1_pru0_pru_r30_5 (Output) | pr1_pru0_pru_r31_5 (Input) | |
+-------------+-------------+-----------------+-----------+------------------------------+---------------------------+------------------------------+-------------------------------+----------------------------------------------+
| P2.35 | A5/86 | U5 | F3 | | | pr1_pru1_pru_r30_8 (Output) | pr1_pru1_pru_r31_8 (Input) | |
- +-------------+-------------+-----------------+-----------+------------------------------+---------------------------+------------------------------+-------------------------------+----------------------------------------------+
\ No newline at end of file
+ +-------------+-------------+-----------------+-----------+------------------------------+---------------------------+------------------------------+-------------------------------+----------------------------------------------+
diff --git a/books/beaglebone-cookbook/02sensors/sensors.rst b/books/beaglebone-cookbook/02sensors/sensors.rst
index 79a3bf0e..d957ff08 100644
--- a/books/beaglebone-cookbook/02sensors/sensors.rst
+++ b/books/beaglebone-cookbook/02sensors/sensors.rst
@@ -684,7 +684,7 @@ tools to test the device. Because these are Linux command-line tools,
you have to use *2* as the bus number. *i2cdetect*, shown in :ref:`js_i2cTools`,
shows which |I2C| devices are on the bus. The *-r* flag indicates which bus to use.
Our TMP101 is appearing at address *0x498*. You can use the *i2cget* command to read
-the value. It returns the temperature in hexidecimal and degrees C.
+the value. It returns the temperature in hexadecimal and degrees C.
In this example, 0x18 = 24{deg}C, which is 75.2{deg}F. (Hmmm, the office is a bit warm today.)
Try warming up the TMP101 with your finger and running *i2cget* again.
diff --git a/books/beaglebone-cookbook/09capes/capes.rst b/books/beaglebone-cookbook/09capes/capes.rst
index 8374b0a9..a67a7417 100644
--- a/books/beaglebone-cookbook/09capes/capes.rst
+++ b/books/beaglebone-cookbook/09capes/capes.rst
@@ -796,7 +796,7 @@ and PCB shown in :ref:`capes_miniDisplay_pcb`.
PCB for MiniDisplay cape
.. note::
- #TODO#: The MiniDisplay cape is not currently available, so this example should be udpated.
+ #TODO#: The MiniDisplay cape is not currently available, so this example should be updated.
A good starting point is to take the PCB layout for the MiniDisplay and edit it for your project.
The connectors for +P8+ and +P9+ are already in place and ready to go.
@@ -1153,10 +1153,14 @@ Solution
---------
Complete capes have an |I2C| EEPROM on board that contains configuration information that is read at boot time.
-`Adventures in BeagleBone Cape EEPROMs <http://bit.ly/1Fb64uF>`_ gives a helpful description of two methods for
-programming the EEPROM. `How to Roll your own BeagleBone Capes <http://bit.ly/1E5M7RJ>`_ is a good four-part
+`Adventures in BeagleBone Cape EEPROMs <https://web.archive.org/web/20190108195421/http://azkeller.com:80/blog/?p=62>`_ gives a helpful description of two methods for
+programming the EEPROM. `How to Roll your own BeagleBone Capes <https://web.archive.org/web/20200222204651/http://papermint-designs.com/community/taxonomy/term/68>`_ is a good four-part
series on creating a cape, including how to wire and program the EEPROM.
+.. note::
+
+ The current effort to document how to enable software for a cape is on-going at https://docs.beagleboard.org/latest/boards/capes.
+
.. _capes_production:
Putting Your Cape Design into Production
@@ -1172,7 +1176,7 @@ Solution
---------
`CircuitHub <https://circuithub.com/>`_ offers a great tool to get a quick quote on assembled PCBs.
-To make things simple, I downloaded the `CircuitCo MiniDisplay Cape Eagle design materials <https://elinux.org/Special:Badtitle/NS500:MiniDisplay_Cape>`_
+To make things simple, I downloaded the `CircuitCo MiniDisplay Cape Eagle design materials <https://elinux.org/MiniDisplay_Cape>`_
and uploaded them to CircuitHub.
After the design is uploaded, you'll need to review the parts to verify that CircuitHub has or
diff --git a/books/beaglebone-cookbook/10parts/parts.rst b/books/beaglebone-cookbook/10parts/parts.rst
index a952cf1d..3820de81 100644
--- a/books/beaglebone-cookbook/10parts/parts.rst
+++ b/books/beaglebone-cookbook/10parts/parts.rst
@@ -52,8 +52,6 @@ with jumper wires, and <<parts_breadboard>> shows where you can get breadboards.
+-------------+--------------------------------------------------------------------------------------------+
| Digikey | http://www.digikey.com/product-detail/en/TW-E012-000/438-1049-ND/643115 |
+-------------+--------------------------------------------------------------------------------------------+
- | RadioShack | http://www.radioshack.com/solderless-breadboard-jumper-wire-kit/2760173.html#.VG5i1PnF8fA |
- +-------------+--------------------------------------------------------------------------------------------+
| SparkFun | https://www.sparkfun.com/products/124 |
+-------------+--------------------------------------------------------------------------------------------+
@@ -73,7 +71,7 @@ with jumper wires, and <<parts_breadboard>> shows where you can get breadboards.
+-------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| SparkFun | https://www.sparkfun.com/search/results?term=breadboard |
+-------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | CircuitCo | http://elinux.org/CircuitCo:BeagleBone_Breadboard |
+ | CircuitCo | https://elinux.org/BeagleBoneBreadboard (no longer manufactured, but design available) |
+-------------+---------------------------------------------------------------------------------------------------------------------------------------------+
If you want something more permanent, try `Adafruit's Perma-Proto Breadboard <https://www.adafruit.com/product/1609>`_, laid out like a breadboard.
diff --git a/books/beaglebone-cookbook/code b/books/beaglebone-cookbook/code
index 269209bc..e103135d 160000
--- a/books/beaglebone-cookbook/code
+++ b/books/beaglebone-cookbook/code
@@ -1 +1 @@
-Subproject commit 269209bc64423a06e8caf11b91c7468805b287b2
+Subproject commit e103135d4cd1387e0bfa37b468e3137b9a34e60f
diff --git a/books/pru-cookbook/06io/io.rst b/books/pru-cookbook/06io/io.rst
index ad4fdd59..b01cf603 100644
--- a/books/pru-cookbook/06io/io.rst
+++ b/books/pru-cookbook/06io/io.rst
@@ -189,7 +189,7 @@ If you are using an oscilloscope, look closely and you'll see the following.
PWM with jitter
-The PRU is still as solid as before in it's timing, but now it's going through
+The PRU is still as solid as before in its timing, but now it's going through
the OCP interface. This interface is shared with other parts of the system,
therefore the sometimes the PRU must wait for the other parts to finish.
When this happens the pulse width is a bit longer than usual thus adding
diff --git a/books/pru-cookbook/08ai/ai.rst b/books/pru-cookbook/08ai/ai.rst
index 9e207847..fdf9655e 100644
--- a/books/pru-cookbook/08ai/ai.rst
+++ b/books/pru-cookbook/08ai/ai.rst
@@ -288,7 +288,7 @@ I'm running the 4.14 version. Now look in ``/opt/source`` for your kernel.
*dtb-4.14-ti* pyctrl
dtb-4.19-ti py-uio
-``am5729-beagleboneai.dts`` is the file we need to edit. Search for ``P9_31``. You'l see:
+``am5729-beagleboneai.dts`` is the file we need to edit. Search for ``P9_31``. You'll see:
.. code-block:: shell-session
:linenos:
diff --git a/books/pru-cookbook/projects.rst b/books/pru-cookbook/projects.rst
index 60a2482b..3fbc73fc 100644
--- a/books/pru-cookbook/projects.rst
+++ b/books/pru-cookbook/projects.rst
@@ -45,8 +45,8 @@ documentation visit the PRU-ICSS wiki.
**Type:** Project Tutorial Code Library
**References:**
- * http://beagleboard.org/CapeContest/entries/BeagleBone+DMX+Cape/
- * http://blog.boxysean.com/2012/08/12/first-steps-with-the-beaglebone-pru/
+ * https://beagleboard.org/CapeContest/entries/BeagleBone+DMX+Cape/
+ * https://web.archive.org/web/20130921033304/blog.boxysean.com/2012/08/12/first-steps-with-the-beaglebone-pru/
* https://github.com/boxysean/beaglebone-DMX
.. dropdown:: **Interacto**
@@ -60,8 +60,8 @@ documentation visit the PRU-ICSS wiki.
**Type:** Project 1 Project 2 Code Library
**References:**
- * http://beagleboard.org/CapeContest/entries/Interacto/
- * http://www.hitchhikeree.org/beaglebone_capes/interacto/
+ * https://beagleboard.org/CapeContest/entries/Interacto/
+ * https://web.archive.org/web/20130507141634/http://www.hitchhikeree.org:80/beaglebone_capes/interacto/
* https://github.com/cclark2/interacto_bbone_cape
.. dropdown:: **Replicape: 3D Printer**
@@ -100,7 +100,10 @@ documentation visit the PRU-ICSS wiki.
**References:**
* http://beagleboard.org/CapeContest/entries/Geiger+Cape/
* http://elinux.org/BeagleBone/GeigerCapePrototype
- * https://github.com/mranostay/beaglebone-telemetry-presentation
+
+.. note::
+
+ #TODO#: the git repo was taken down
.. dropdown:: **Servo Controller Foosball Table**
:open:
@@ -143,10 +146,13 @@ documentation visit the PRU-ICSS wiki.
**References:**
* http://www.youtube.com/watch?v=dEes9k7-DYY
- * https://github.com/cagdasc/Chubby1_v1
* http://www.youtube.com/watch?v=JXyewd98e9Q
* http://www.ti.com/lit/wp/spry235/spry235.pdf
+.. note::
+
+ #TODO#: The Chubby1_v1 repo on github.com for user cagdasc was taken down.
+
.. dropdown:: **Software UART**
:open:
diff --git a/intro/contribution/git-usage.rst b/intro/contribution/git-usage.rst
index 0607ed22..10062fb0 100644
--- a/intro/contribution/git-usage.rst
+++ b/intro/contribution/git-usage.rst
@@ -581,7 +581,7 @@ There are a lot of different nice guides to using Git on the web:
- `Understanding Git
Conceptually <https://www.sbf5.com/~cduan/technical/git/>`_
- `git ready: git tips <http://gitready.com/>`_
-- <http://http://cheat.errtheblog.com/s/git>
+- https://web.archive.org/web/20121115132047/http://cheat.errtheblog.com/s/git
- https://docs.scipy.org/doc/numpy-1.15.1/dev/gitwash/development_workflow.html Numpy is also
evaluating git
- https://github.github.com/training-kit/downloads/github-git-cheat-sheet
diff --git a/intro/support/getting-started.rst b/intro/support/getting-started.rst
index 7428e3dc..dd2c78de 100644
--- a/intro/support/getting-started.rst
+++ b/intro/support/getting-started.rst
@@ -191,7 +191,7 @@ an older operating system or need additional drivers for serial access to older
1. Windows Driver Certification warning may pop up two or three times. Click "Ignore", "Install" or "Run".
2. To check if you're running 32 or 64-bit Windows see `this <https://support.microsoft.com/en-us/topic/determine-whether-your-computer-is-running-a-32-bit-version-or-64-bit-version-of-the-windows-operating-system-1b03ca69-ac5e-4b04-827b-c0c47145944b>`_.
- 3. On systems without the latest service release, you may get an error (0xc000007b). In that case, please install the following and retry: https://www.microsoft.com/en-us/download/confirmation.aspx?id=13523
+ 3. On systems without the latest service release, you may get an error (0xc000007b). In that case, please perform the following and retry: https://answers.microsoft.com/en-us/windows/forum/all/windows-10-error-code-0xc000007b/02b74e7d-ce19-4ba4-90f0-e16e8d911866
4. You may need to reboot Windows.
5. These drivers have been tested to work up to Windows 10
diff --git a/projects/simppru/examples/read_counter.rst b/projects/simppru/examples/read_counter.rst
index 94411118..8177a350 100644
--- a/projects/simppru/examples/read_counter.rst
+++ b/projects/simppru/examples/read_counter.rst
@@ -18,7 +18,7 @@ Code
Explanation
------------
-Since, PRU's hardware counter works at 200 MHz, it counts upto 2 x 108
+Since, PRU's hardware counter works at 200 MHz, it counts up to 2 x 108
cycles in 1 second. So, this can be reliably used to count time without
using ``delay``, as we can find exactly how much time 1 cycle takes.
--
GitLab