Merge branch 'main' into 'main'

Several clean-ups

See merge request docs/docs.beagleboard.io!25

_static/css/custom.css

@@ -64,4 +64,8 @@
  * fixing larger font size for paragraphs in the kconfig tables */
  .wy-table-responsive td p {
     font-size: 100%;
-}
+}
\ No newline at end of file
+
+span.strike {
+    text-decoration: line-through;
+}

_templates/layout.html

@@ -7,9 +7,9 @@
     </div>
   {% else %}
     <div class="wy-alert wy-alert-danger">
-     This is the latest (main) BeagleBoard documentation. 
-     If you are looking for the previous releases, use the 
-     drop-down menu on the left and select the desired version.
+     This is the latest (main) BeagleBoard documentation.
+     If you are looking for stable releases, use the
+     drop-down menu on the bottom-left and select the desired version.
     </div>
   {% endif %}
   {{ super() }}

boards/beagleboard/index.rst

+.. _beagleboard-boards-home:
+
 BeagleBoard (all)
 ###################
 

boards/beaglebone/index.rst

-.. _beaglebone-blue-home::
+.. _beaglebone-all-home:
 
 BeagleBone (all)
 ###################
@@ -22,8 +22,8 @@ included both here and in the downloadable beagleboard-docs.pdf linked on the bo
 of your screen.
 
 * `BeagleBone (original) <https://git.beagleboard.org/beagleboard/beaglebone/-/blob/master/BeagleBone_SRM_A6_0_1.pdf>`__
-* `BeagleBone Black </boards/beaglebone/black/index.html>`__
-* `BeagleBone Blue </boards/beaglebone/blue/index.html>`__
-* `BeagleBone AI-64 </boards/beaglebone/ai-64/index.html>`__
-* `BeagleBone AI </boards/beaglebone/ai/index.html>`__
+* :ref:`beagleboneblack-home`
+* :ref:`beaglebone-blue-home`
+* :ref:`bbai64-home`
+* :ref:`beaglebone-ai-home`
 

boards/beagleconnect/freedom/index.rst

@@ -29,7 +29,7 @@ devices within the first year after the initial release.
 BeagleConnect™ Freedom
 **********************
 
-BeagleConnect™ Freedom is based on the `TI CC1352 <https://www.ti.com/product/CC1352R>`_ 
+BeagleConnect™ Freedom is based on the `TI CC1352 <https://www.ti.com/product/CC1352P7>`_ 
 and is the first available BeagleConnect™ solution. It implements:
 
 * BeagleConnect™ gateway device function for Sub-GHz 802.15.4 long-range 
@@ -125,9 +125,9 @@ Long-range, low-power wireless
 ==============================
 
 BeagleConnect™ Freedom wireless hardware is built around a 
-`TI CC1352 <http://www.ti.com/product/CC1352R>`_ multiprotocol and multi-band 
-Sub-1 GHz and 2.4-GHz wireless microcontroller (MCU). CC1352R includes a 48-MHz
-Arm® Cortex®-M4F processor, 352KB Flash, 256KB ROM, 8KB Cache SRAM, 80KB of 
+`TI CC1352 <http://www.ti.com/product/CC1352P7>`_ multiprotocol and multi-band 
+Sub-1 GHz and 2.4-GHz wireless microcontroller (MCU). CC1352P7 includes a 48-MHz
+Arm® Cortex®-M4F processor, 704KB Flash, 256KB ROM, 8KB Cache SRAM, 144KB of 
 ultra-low leakage SRAM, and `Over-the-Air <https://en.wikipedia.org/wiki/Over-the-air_programming>`_ 
 upgrades (OTA).
 
@@ -160,12 +160,12 @@ Each BeagleBoard.org BeagleConnect™ solution will be:
 Getting Started
 ***************
 
-* `Typical usage with a Linux host </boards/beagleconnect/freedom/usage.html>`__
-* `Programming with Zephyr </boards/beagleconnect/freedom/zephyr.html>`__
+* :ref:`Typical BeagleConnect Freedom usage with a Linux host <beagleconnect-usage>`
+* :ref:`Programming BeagleConnect Freedom with Zephyr <beagleconnect-zephyr>`
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
-   usage.rst
-   zephyr.rst
+   /boards/beagleconnect/freedom/usage.rst
+   /boards/beagleconnect/freedom/zephyr.rst

boards/beagleconnect/freedom/usage.rst

-.. _beagleconnect-Usage:
+.. _beagleconnect-usage:
 
 BeagleConnect Freedom Usage
 ###########################

boards/beagleconnect/freedom/zephyr.rst

-.. _beagleconnect-connectivity:
+.. _beagleconnect-zephyr:
 
 BeagleConnect Freedom & Zephyr
 ###############################

boards/beagleconnect/index.rst

@@ -38,6 +38,12 @@ BeagleConnect™ technology solves:
 * The need to produce high-volume custom hardware cost-optimized for your 
   requirements.
 
+.. toctree::
+   :maxdepth: 2
+
+   /boards/beagleconnect/technology/index.rst
+   /boards/beagleconnect/technology/story.rst
+
 BeagleConnect Experience
 *************************
 
@@ -88,18 +94,6 @@ For home automaters, integration into WebThings…
    :alt: BeagleConnect
 
 
-BeagleConnect Technology
-************************
-
-Learn about the technology behind BeagleConnect.
-
-.. toctree::
-   :maxdepth: 2
-
-   /boards/beagleconnect/technology/index.rst
-   /boards/beagleconnect/technology/story.rst
-
-
 BeagleConnect Boards
 ********************
 

boards/beagleconnect/technology/index.rst

+.. role:: strike
+   :class: strike
+
 .. _beagleconnect-overview:
 
 BeagleConnect Technology
@@ -15,12 +18,8 @@ architecture.
    :height: 400
    :alt: BeagleConnect
 
-BeagleConnect™ Greybus Stack
-****************************
-
-Work in progress
-================
-
+BeagleConnect™ is built using `Greybus <https://kernel-recipes.org/en/2015/talks/an-introduction-to-greybus/>`__
+code in the Linux kernel originally designed for mobile phones.
 To understand a bit more about how the BeagleConnect™ Greybus stack is being
 built, this section helps describe the development currently in progress and
 the principles of operation.
@@ -65,16 +64,18 @@ Software architecture
 TODO items
 ----------
 
-* Linux kernel driver
+* :strike:`Linux kernel driver` (wpanusb and bcfserial still need to be upstreamed)
 
 * Provisioning
 
-* Firmware for host CC13x
+* :strike:`Firmware for host CC13x`
+
+* :strike:`Firmware for device CC13x`
 
-* Firmware for device CC13x
+* Unify firmware for host/device CC13x
 
-* Click Board drivers and device tree formatted metadata for 100 or so Click 
-  Boards
+* :strike:`Click Board drivers and device tree formatted metadata for 100 or so Click 
+  Boards`
 
 * Click Board plug-ins for node-red for the same 100 or so Click Boards
 
@@ -110,7 +111,7 @@ User experience concerns
   provisioning is completed
 
 BeagleConnect™ Greybus demo using BeagleConnect™ Freedom
-========================================================
+########################################################
 BeagleConnect™ Freedom runs a subGHz IEEE 802.15.4 network. This BeagleConnect™
 Greybus demo shows how to interact with GPIO, I2C and mikroBUS add-on boards 
 remotely connected over a BeagleConnect™ Freedom.

boards/beagleconnect/technology/story.rst

-.. _beagleconnect-home:
+.. _beagleconnect-story:
 
 BeagleConnect™ Story
 *********************

boards/capes/index.rst

+.. _capes:
+
 Capes
 #####
 
 .. note::
    This page is under development.
 
-Capes are add-on boards for BeagleBone or PocketBeagle families of boards.
+Capes are add-on boards for BeagleBone or PocketBeagle families of boards.  Using a Cape add-on board, you can easily add
+sensors, communication peripherals, and more.
+
+Please visit `BeagleBoard.org - Cape <https://beagleboard.org/capes>`_ for the list of currently available Cape add-on boards.
+
+In the BeagleBone board family, there are many variants, such as :ref:`beagleboneblack-home`, :ref:`beaglebone-ai-home`,
+:ref:`bbai64-home` and compatibles such as `SeeedStudio BeagleBone Green <https://beagleboard.org/green>`_,
+`SeeedStudio BeagleBone Green Wireless <https://beagleboard.org/green-wireless>`_, `SeeedStudio BeagleBone Green Gateway
+<https://wiki.seeedstudio.com/BeagleBone-Green-Gateway/>`_ and more.
+
+The :ref:`beaglebone-cape-interface-spec` enables a common set of device tree overlays and software to be utilized
+on each of these different BeagleBone boards.
+
+Each hardware has different internal pin assignments 
+and the number of peripherals in the SoC, but the device tree overlay absorbs these differences.
+
+The user of the Cape add-on boards are essentially able to use it 
+across the corresponding Boards without changing any code at all.
 
-* Learn about our compatibility layer on: `BeagleBone Cape Interface Specification </boards/capes/cape-interface-spec.html>`__
+Find the instructions below on using each cape:
 
+* :ref:`bone-cape-relay`
 
 .. toctree::
    :maxdepth: 2
    :hidden:
 
    /boards/capes/cape-interface-spec
+   /boards/capes/relay
 

boards/capes/relay.rst

+.. _bone-cape-relay:
+
+BeagleBoard.org BeagleBone Relay Cape
+#####################################
+
+Relay Cape, as the name suggests, is a simple Cape with a relay on it.
+It contains four relays, each of which can be operated independently from the BeagleBone.
+
+.. image:: images/BeagleBoneRelayCapeA2-400x274.png
+   :align: center
+
+* `Order page <https://beagleboard.org/capes#relay>`_
+* `Schematic <https://git.beagleboard.org/beagleboard/capes/-/tree/master/beaglebone/Relay>`_
+
+.. note:: 
+    The following describes how to use the device tree overlay under development.
+    The description may not be suitable for those using older firmware.
+
+Installation
+************
+
+No special configuration is required. When you plug Cape into your BeagleBoard, 
+it is automatically recognized by the Cape Universal function.
+
+You can check to see if Relay Cape is recognized with the following command.
+
+.. code-block::
+
+    ls /proc/device-tree/chosen/overlay
+
+A list of currently loaded device tree overlays is displayed here. 
+If you see `BBORG_RELAY-00A2.kernel` in this list, it has been loaded correctly.
+
+If it is not loaded correctly, you can also load it directly 
+by adding the following to the U-Boot options 
+(which can be reflected by changing /boot/uEnv.txt).
+
+.. code-block::
+
+    uboot_overlay_addr0=BBORG_RELAY-00A2.dtbo
+
+
+Usage
+******
+
+.. code-block::
+
+    ls /sys/class/leds
+
+The directory "relay*" exists in the following directory.
+The LEDs can be controlled by modifying the files in this directory.
+
+.. code-block::
+
+    echo 1 > relay1/brightness
+
+This allows you to adjust the brightness; 
+entering 1 for brightness turns it ON, and entering 0 for OFF.
+
+The four relays can be changed individually 
+by changing the number after "relay.

boards/index.rst

+.. _boards:
+
 Boards
 ######
 
-`BeagleBone <beaglebone>`__ is a family of ARM-based, Linux-capable boards intended to be
+:ref:`BeagleBone <beaglebone-all-home>` is a family of ARM-based, Linux-capable boards intended to be
 bare-bones, with a balance of features to enable rapid prototyping and provide a solid
 reference for building end products.
 
-`PocketBeagle <pocketbeagle>`__ boards are ultra-tiny ARM-based, Linux-capable boards intended to be
+:ref:`pocketbeagle-home` boards are ultra-tiny ARM-based, Linux-capable boards intended to be
 very low cost, with minimal features suitable for beginners and attractive to professionals
 looking for a more minimal starting point.
 
-`BeagleBone and PocketBeagle Capes <capes>`__ are add-on boards for BeagleBone and PocketBeagle boards.
+BeagleBone and PocketBeagle :ref:`capes` are add-on boards for BeagleBone and PocketBeagle boards.
 
-`BeagleConnect <beagleconnect>`__ boards are ARM microcontroller-based, Zephyr-capable boards meant
+:ref:`beagleconnect-home` boards are ARM microcontroller-based, Zephyr-capable boards meant
 to act as ultra low cost smart peripherals to their Linux-capable counterparts, with connectivity
 options that enable almost endless sensing and actuation expansion.
 
-`BeagleBoard <beagleboard>`__ is a family of ARM-based, Linux-capable boards where this project
+:ref:`BeagleBoard <beagleboard-boards-home>` is a family of ARM-based, Linux-capable boards where this project
 started.
 
 .. toctree::

books/beaglebone-cookbook/02sensors/sensors.rst

@@ -648,7 +648,7 @@ Solution
 The TMP101 sensor is a common digital temperature 
 sensor that uses a standard |I2C|-based serial protocol.
 
-.. |I2C| replace:: I\ :sub:`2`\ C
+.. |I2C| replace:: I\ :sup:`2`\ C
 
 To make this recipe, you will need:
 

books/beaglebone-cookbook/03displays/displays.rst

@@ -315,7 +315,7 @@ The LED matrix is a 5 V device, but you can drive it from 3.3 V. Wire, as shown
 
 :ref:`sensors_i2c_temp` shows how to use *i2cdetect* to discover the address of an |I2C| device.
 
-.. |I2C| replace:: I\ :sub:`2`\ C
+.. |I2C| replace:: I\ :sup:`2`\ C
 
 Run the *i2cdetect -y -r 2* command to discover the address of the display on |I2C| bus 2, as shown in :ref:`displays_i2cdetect`.
 

books/index.rst

+.. _books-home:
+
 Books
 *****
 

books/pru-cookbook/01case/case.rst

@@ -35,7 +35,7 @@ Here we present:
 
 .. TODO Switch from LEDscape to FPP
 
-* `Robotics Control Library <http://strawsondesign.com/docs/roboticscape/>`_
+* `Robotics Control Library <https://beagleboard.org/librobotcontrol>`_
 * `BeagleLogic <https://github.com/abhishek-kakkar/BeagleLogic/wiki>`_
 * `NeoPixels -- 5050 RGB LEDs with Integrated Drivers (Falcon Christmas) <http://falconchristmas.com>`_
 * `RGB LED Matrix (Falcon Christmas) <http://falconchristmas.com>`_
@@ -77,7 +77,7 @@ in :ref:`case_blue`.
 
    Blue balancing
 
-The `Robotics Control Library <http://strawsondesign.com/docs/roboticscape/>`_ is a 
+The `Robotics Control Library <https://beagleboard.org/librobotcontrol>`_ is a 
 package that is already installed on the Beagle 
 that contains a C library and example/testing programs. It uses the PRU to extend the 
 real-time hardware of the Bone by adding eight addional servo channels and one 

books/pru-cookbook/05blocks/blocks.rst

@@ -7,14 +7,15 @@ Here are some examples that use the basic PRU building blocks.
 
 The following are resources used in this chapter.
 
-Resources
-~~~~~~~~~~
-
-* `PRU Optimizing C/C++ Compiler, v2.2, User's Guide <http://www.ti.com/lit/ug/spruhv7b/spruhv7b.pdf>`_
-* `AM572x Technical Reference Manual <http://www.ti.com/lit/pdf/spruhz6l>`_ (AI)
-* `AM335x Technical Reference Manual <http://www.ti.com/lit/pdf/spruh73>`_ (All others)
-* `Exploring BeagleBone by Derek Molloy <http://exploringbeaglebone.com/>`_
-* `WS2812 Data Sheet <https://cdn-shop.adafruit.com/datasheets/WS2812.pdf>`_
+.. note::
+
+   *Resources*
+
+   * `PRU Optimizing C/C++ Compiler, v2.2, User's Guide <http://www.ti.com/lit/ug/spruhv7b/spruhv7b.pdf>`_
+   * `AM572x Technical Reference Manual <http://www.ti.com/lit/pdf/spruhz6l>`_ (AI)
+   * `AM335x Technical Reference Manual <http://www.ti.com/lit/pdf/spruh73>`_ (All others)
+   * `Exploring BeagleBone by Derek Molloy <http://exploringbeaglebone.com/>`_
+   * `WS2812 Data Sheet <https://cdn-shop.adafruit.com/datasheets/WS2812.pdf>`_
 
 .. _memory_allocation:
 

books/pru-cookbook/06io/io.rst

@@ -8,14 +8,15 @@ through the ``pass:[__]R30`` register.  Below shows how more GPIO pins can be ac
 
 The following are resources used in this chapter.
 
-Resources
-~~~~~~~~~~
-
-* `P8 Header Table <https://github.com/derekmolloy/exploringBB/blob/master/chp06/docs/BeagleboneBlackP8HeaderTable.pdf>`_
-* `P9 Header Table <https://github.com/derekmolloy/exploringBB/blob/master/chp06/docs/BeagleboneBlackP9HeaderTable.pdf>`_
-* `AM572x Technical Reference Manual <http://www.ti.com/lit/pdf/spruhz6l>`_ (AI)
-* `AM335x Technical Reference Manual <http://www.ti.com/lit/pdf/spruh73>`_ (All others)
-* `PRU Assembly Language Tools <http://www.ti.com/lit/ug/spruhv6a/spruhv6a.pdf>`_
+.. note::
+
+   *Resources*
+
+   * `P8 Header Table <https://github.com/derekmolloy/exploringBB/blob/master/chp06/docs/BeagleboneBlackP8HeaderTable.pdf>`_
+   * `P9 Header Table <https://github.com/derekmolloy/exploringBB/blob/master/chp06/docs/BeagleboneBlackP9HeaderTable.pdf>`_
+   * `AM572x Technical Reference Manual <http://www.ti.com/lit/pdf/spruhz6l>`_ (AI)
+   * `AM335x Technical Reference Manual <http://www.ti.com/lit/pdf/spruh73>`_ (All others)
+   * `PRU Assembly Language Tools <http://www.ti.com/lit/ug/spruhv6a/spruhv6a.pdf>`_
 
 Editing /boot/uEnv.txt to Access the P8 Header on the Black
 ************************************************************