diff --git a/boards/beaglebone/ai-64/ch04.rst b/boards/beaglebone/ai-64/ch04.rst
index 2d864d18fe3c2cbdd57258a4d2b7eee781ce505b..9317d7c926f65f308f925480eb80477cf5759a57 100644
--- a/boards/beaglebone/ai-64/ch04.rst
+++ b/boards/beaglebone/ai-64/ch04.rst
@@ -97,9 +97,9 @@ much as possible. There are several significant differences between the three de
- AzureWave AW‑CM256SM
- `-`
-.. note ::
+.. todo::
- TODO: add cape compatibility details
+ add cape compatibility details
.. _beaglebone-ai-64-features-and-specificationd:
diff --git a/boards/beaglebone/ai-64/ch05.rst b/boards/beaglebone/ai-64/ch05.rst
index 4c7046f39d885f73c66b62d38d5415d7dab42e3b..128b61cf18cdf74f820295cf4eed988e635c0ebf 100644
--- a/boards/beaglebone/ai-64/ch05.rst
+++ b/boards/beaglebone/ai-64/ch05.rst
@@ -222,9 +222,9 @@ As mentioned earlier, there are two boot modes:
* **eMMC Boot:** This is the default boot mode and will allow for the fastest boot time and will enable the board to boot out of the box using the pre-flashed OS image without having to purchase an microSD card or an microSD card writer.
* **SD Boot:** This mode will boot from the microSD slot. This mode can be used to override what is on the eMMC device and can be used to program the eMMC when used in the manufacturing process or for field updates.
-.. note ::
+.. todo::
- TODO: This section needs more work and references to greater detail. Other boot modes are possible.
+ This section needs more work and references to greater detail. Other boot modes are possible.
Software to support USB and serial boot modes is not provided by beagleboard.org._Please contact TI for support of this feature.
diff --git a/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst b/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst
index 11f016b82b4adf468c752bd4d55347f226c4cd58..89313dcf14d1c7f97c1d8ad35cce5075a4f93853 100644
--- a/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst
+++ b/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst
@@ -79,7 +79,9 @@ shown below
:scale: 20
:align: center
- TODO: IMX219 CSI sensor connection with BeagleBone® AI-64 for Edge AI
+.. todo::
+
+ IMX219 CSI sensor connection with BeagleBone® AI-64 for Edge AI
Note that the headers have to be lifted up to connect the cameras
@@ -182,7 +184,9 @@ shown in the image below.
:scale: 25
:align: center
- TODO: BeagleBone® AI-64 wallpaper upon boot
+.. todo::
+
+ BeagleBone® AI-64 wallpaper upon boot
You can also view the boot log by connecting the UART cable to your PC and
use a serial port communications program.
@@ -245,4 +249,6 @@ https://code.visualstudio.com/docs/remote/ssh
:scale: 90
:align: center
- TODO: Microsoft Visual Studio Code for connecting to BeagleBone® AI-64 for Edge AI via SSH
+.. todo::
+
+ Microsoft Visual Studio Code for connecting to BeagleBone® AI-64 for Edge AI via SSH
diff --git a/boards/beaglebone/black/ch07.rst b/boards/beaglebone/black/ch07.rst
index ec1bfd3b394911fad58b8e1ecc8a4bace3e6ee0f..9835fc12d320a6b1755c246d6a38068f430a08ad 100644
--- a/boards/beaglebone/black/ch07.rst
+++ b/boards/beaglebone/black/ch07.rst
@@ -1160,6 +1160,10 @@ Each board has a debug serial interface that can be accessed by using a special
Serial Debug Header
+.. todo::
+
+ Make all figure references actual references
+
Two signals are provided, TX and RX on this connector. The levels on
these signals are 3.3V. In order to access these signals, a FTDI USB to
Serial cable is recommended as shown in *Figure 55* below.
@@ -1177,9 +1181,9 @@ 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 <https://ftdichip.com/wp-content/uploads/2020/07/DS_USB_RS232_CABLES.pdf>`_
-.. note:
+.. todo::
- #TODO#: move accessory links to a single common document for all boards.
+ 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
@@ -1187,6 +1191,10 @@ 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.
+.. todo::
+
+ We should include all support information in docs.beagleboard.org now and leave eLinux to others, freeing it as much as possible
+
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
diff --git a/boards/beaglebone/blue/accessories.rst b/boards/beaglebone/blue/accessories.rst
index 2d2b903ab81cd4af955a6e5dd5fe174096a80df7..0dfd7543a89702f900f84ce4d6e031e705a527f9 100644
--- a/boards/beaglebone/blue/accessories.rst
+++ b/boards/beaglebone/blue/accessories.rst
@@ -3,9 +3,9 @@
Accessories
###############
-.. note::
+.. todo::
- #TODO#: We are going to work on a unified accessories page for all the boards and it should replace this.
+ We are going to work on a unified accessories page for all the boards and it should replace this.
.. _chassis_and_kits:
diff --git a/boards/beagleconnect/freedom/01-introduction.rst b/boards/beagleconnect/freedom/01-introduction.rst
index de5fcc2c88c033c2f7562d522e69c68e757330ba..bed1d66fdff7dc6e420be5a8d97790e310f57862 100644
--- a/boards/beagleconnect/freedom/01-introduction.rst
+++ b/boards/beagleconnect/freedom/01-introduction.rst
@@ -17,7 +17,7 @@ and is the first available BeagleConnectâ„¢ solution. It features:
* Battery-charger circuit, and
* Buzzer, LEDs and buttons for user programming.
-.. figure:: media/BeagleConnectFreedom-Back-Annotated-wbg.webp
+.. figure:: media/BeagleConnectFreedom-Front-Annotated-wbg.webp
:width: 1247
:align: center
:alt: BeagleConnect Freedom front pinout diagram
diff --git a/boards/beagleconnect/freedom/02-quick-start.rst b/boards/beagleconnect/freedom/02-quick-start.rst
index 11d4d39971e5e1cf022c36ad93e5f408037f58ac..785e2d1fcdea7ffc517edba4643eed75f5dba384 100644
--- a/boards/beagleconnect/freedom/02-quick-start.rst
+++ b/boards/beagleconnect/freedom/02-quick-start.rst
@@ -3,6 +3,56 @@
Quick Start Guide
####################
+What's included in the box?
+****************************
-.. tip::
- Checkout :ref:`beagleconnect-freedom-demos` for more information.
+1. BeagleConnect Freedom board in enclosure
+2. Antenna
+3. USB cable
+4. Quick-start card
+
+.. todo::
+
+ Image with what's inside the box and a better description.
+
+
+Attaching antenna
+******************
+
+.. todo::
+
+ Describe how to screw on the antenna.
+
+
+Tethering to PC
+****************
+
+.. todo::
+
+ Describe how to get a serial connection.
+
+Wireless Connection
+********************
+
+.. todo::
+
+ Describe how to get an IEEE802.15.4g connection from BeaglePlay.
+
+
+Access Micropython
+*******************
+
+Boards come pre-flashed with Micropython. Read :ref:`beagleconnect-freedom-using-micropython` for
+more details.
+
+.. todo::
+
+ Describe how to get to a local console and websockets console.
+
+
+Demos and Tutorials
+*******************
+
+* :ref:`beagleconnect-freedom-using-greybus`
+* :ref:`beagleconnect-freedom-using-micropython`
+* :ref:`beagleconnect-freedom-using-zephyr`
diff --git a/boards/beagleconnect/index.rst b/boards/beagleconnect/index.rst
index 6af6ec347310aa24e038e7dec1100d0dc65407db..19b9b401423b1c0d5fa5e2222683adcb94b2c61a 100644
--- a/boards/beagleconnect/index.rst
+++ b/boards/beagleconnect/index.rst
@@ -30,12 +30,6 @@ as well as libraries for communicating over various networks, BeagleConnect
simply eliminates the need for these libraries by shifting the burden into the
most massive and collaborative software project of all time, the `Linux kernel <https://en.wikipedia.org/wiki/Linux_kernel>`_.
-.. image:: freedom/media/bcf-c5-boards.jpg
- :width: 600
- :align: center
- :height: 400
- :alt: BeagleConnect Freedom C5 Boards
-
These are the tools used to automate things in
`scientific data collection <https://en.wikipedia.org/wiki/Data_collection_system>`_,
`data science <https://en.wikipedia.org/wiki/Data_science>`_,
@@ -79,7 +73,9 @@ with the data streams from any of hundreds of sensor options, including
stored in simple `data files <https://en.wikipedia.org/wiki/Comma-separated_values>`
or processed and visualized.
-#TODO: provide images demonstrating Jupyter Notebook visualization
+.. todo::
+
+ provide images demonstrating Jupyter Notebook visualization
For embedded systems developers, data is easily extracted using the standard IIO
interface provided by the Linux kernel running on the gateway using any of
@@ -96,22 +92,18 @@ For DevOps…
For home automaters, integration into WebThings…
-#TODO: think a bit more about this section with some feedback from Cathy.
+.. todo::
+
+ think a bit more about this section with some feedback from Cathy.
-.. image:: freedom/media/image1.jpg
+.. image:: freedom/media/BeagleConnect-Freedom-Front.png
:width: 598
:align: center
- :height: 400
- :alt: BeagleConnect
+ :alt: BeagleConnect Freedom
-BeagleConnect Boards
+BeagleConnect boards
********************
-Get started using your BeagleConnect.
-
-.. toctree::
- :maxdepth: 2
-
- .. /boards/beagleconnect/freedom/index.rst
+* :ref:`beagleconnect_freedom_home`
diff --git a/boards/beagleconnect/technology/index.rst b/boards/beagleconnect/technology/index.rst
index 1dd7a8bd8257951092182fb7a34393ed3f71cf77..e31190410c9a483091aa93cadb7d41e24f573626 100644
--- a/boards/beagleconnect/technology/index.rst
+++ b/boards/beagleconnect/technology/index.rst
@@ -12,11 +12,11 @@ architecture.
.. note::
This documentation and the associated software are each a work-in-progress.
-.. image:: ../freedom/media/image1.jpg
+.. image:: ../freedom/media/BeagleConnect-Freedom-Front.png
:width: 598
:align: center
:height: 400
- :alt: BeagleConnect
+ :alt: BeagleConnect Freedom
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.
diff --git a/boards/beagleplay/01-introduction.rst b/boards/beagleplay/01-introduction.rst
index d6d80ecfd7d4c1c7cf92cc3ca8a36563f20a02c1..641c8c1ee45ca0afcc377893c0a87c6591c4efd5 100644
--- a/boards/beagleplay/01-introduction.rst
+++ b/boards/beagleplay/01-introduction.rst
@@ -35,7 +35,8 @@ include:
:widths: auto
+----------------------------------------------------+---------------------------------------------------------+
- | .. image:: images/45front.webp | .. image:: images/45back.webp |
+ | .. image:: images/front.webp | .. image:: images/back.webp |
+ | :width: 700 | :width: 700 |
| :align: center | :align: center |
| :alt: BeaglePlay | :alt: BeaglePlay |
+----------------------------------------------------+---------------------------------------------------------+
diff --git a/boards/beagleplay/02-quick-start.rst b/boards/beagleplay/02-quick-start.rst
index f5020a33d82c39932883a240175e5501dfc1b024..fb9ff6e5a12b2e3739d0d4cb5b73a937963768e4 100644
--- a/boards/beagleplay/02-quick-start.rst
+++ b/boards/beagleplay/02-quick-start.rst
@@ -30,6 +30,13 @@ Attaching antennas
.. important::
Add documentation on attaching antennas here.
+You can watch this video to see how to attach the attennas.
+
+.. image:: images/attach-antennas.webp
+ :alt: YouTube video of BeaglePlay antenna connection
+ :width: 1280
+ :target: https://youtu.be/8zeIVd-JRc0
+
Tethering to PC
****************
@@ -70,6 +77,16 @@ to browse documents and start programming your BeaglePlay!
BeaglePlay VSCode IDE (192.168.7.2:3000)
+.. _beagleplay-demos-and-tutorials:
-.. tip::
- Checkout :ref:`beagleplay-demos` for more information.
\ No newline at end of file
+Demos and Tutorials
+*******************
+
+* :ref:`beagleplay-serial-console`
+* :ref:`beagleplay-connect-wifi`
+* :ref:`beagleplay-qwiic`
+* :ref:`beagleplay-grove`
+* :ref:`beagleplay-mikrobus`
+* :ref:`beagleplay-oldi`
+* :ref:`beagleplay-csi`
+* :ref:`beagleplay-zephyr-development`
diff --git a/boards/beagleplay/03-design.rst b/boards/beagleplay/03-design.rst
index 19370382eb6e7da5d60b939d49b8d9d2ff00812a..bf7f38b234bcce302a092aefaf9c29d52c9969c7 100644
--- a/boards/beagleplay/03-design.rst
+++ b/boards/beagleplay/03-design.rst
@@ -12,7 +12,8 @@ specifications in a short and crisp form as well.
You can download BeaglePlay schematic to have clear view of
all the elements that makes up the BeaglePlay hardware.
- :download:`BeaglePlay schematic diagram PDF <https://git.beagleboard.org/beagleplay/beagleplay/-/blob/main/BeaglePlay_SCH_PDF.pdf>`
+ `BeaglePlay design repository <https://git.beagleboard.org/beagleplay/beagleplay>`__
+
Block diagram
*************
diff --git a/boards/beagleplay/04-expansion.rst b/boards/beagleplay/04-expansion.rst
index 10a995fb38d9bf2077b481b5e7239cd6cdc62502..a01848164ade1deb0c782239999d384302cfe64a 100644
--- a/boards/beagleplay/04-expansion.rst
+++ b/boards/beagleplay/04-expansion.rst
@@ -3,15 +3,16 @@
Expansion
#########
+.. note::
+
+ This chapter is a work in progress and will include information on building expansion hardware for BeaglePlay.
+
mikroBUS
*********
Grove
******
-microSD
-********
-
QWIIC
******
@@ -21,6 +22,3 @@ CSI
OLDI
****
-USB
-***
-
diff --git a/boards/beagleplay/06-support.rst b/boards/beagleplay/06-support.rst
index 557f2f33cbd6a242c0d0efff2aea75d0120481ad..fd667b3d9157051d58a44471b078f3d1f3a2327a 100644
--- a/boards/beagleplay/06-support.rst
+++ b/boards/beagleplay/06-support.rst
@@ -33,7 +33,7 @@ Hardware docs
For any hardware document like schematic diagram PDF,
EDA files, issue tracker, and more you can checkout the
-`BeaglePlay repository <https://git.beagleboard.org/beagleplay/beagleplay>`_.
+`BeaglePlay design repository <https://git.beagleboard.org/beagleplay/beagleplay>`_.
Software docs
==============
@@ -89,6 +89,6 @@ are noted below.
+---------+------------------------------------------------------------+----------------------+-------+
| Rev | Changes | Date | By |
+=========+============================================================+======================+=======+
- | TBD | Initial production version | 2023-03-08 | JK |
+ | A2 | Initial production version | 2023-03-08 | JK |
+---------+------------------------------------------------------------+----------------------+-------+
diff --git a/boards/beagleplay/demos-and-tutorials/connect-wifi.rst b/boards/beagleplay/demos-and-tutorials/connect-wifi.rst
index 9d044ced33233ec4f3d1763d8b4f0008c229b32e..086b82fbfd9b23a913449925687d0d61255e1d29 100644
--- a/boards/beagleplay/demos-and-tutorials/connect-wifi.rst
+++ b/boards/beagleplay/demos-and-tutorials/connect-wifi.rst
@@ -185,10 +185,10 @@ Swap out "mywifi" and "mypassword" with your network SSID and password, respecti
.. important::
The single quotes around the double quotes are needed to make sure the
- double quotes are given to `wpa_cli`. It expects to see them.
+ double quotes are given to ``wpa_cli``. It expects to see them.
.. note::
- For more information about `wpa_cli`, see https://w1.fi/wpa_supplicant/
+ For more information about ``wpa_cli``, see https://w1.fi/wpa_supplicant/
To make these changes persistent, you need to edit `/etc/wpa_supplicant/wpa_supplicant-wlan0.conf`. This is described
in :ref:`beagleplay-wifi-wpa-cli-xfce`_.
@@ -198,7 +198,7 @@ in :ref:`beagleplay-wifi-wpa-cli-xfce`_.
wpa_cli (XFCE)
**************
-Another way of connecting to a WiFi access point is to use ``wpa_cli`` tool.
+Another way of connecting to a WiFi access point is to edit the ``wpa_supplicant`` configuration file.
Step 1: Open up terminal
diff --git a/boards/beagleplay/demos-and-tutorials/using-grove.rst b/boards/beagleplay/demos-and-tutorials/using-grove.rst
index 282e8bad12dadd1ec2884c4e84e94e8af9285cf8..ca6858e6c88b2794a8847311815d24c8b961cd5e 100644
--- a/boards/beagleplay/demos-and-tutorials/using-grove.rst
+++ b/boards/beagleplay/demos-and-tutorials/using-grove.rst
@@ -3,4 +3,6 @@
Using Grove
###########
-See :ref:`qwiic_stemma_grove_addons`
+See :ref:`qwiic_stemma_grove_addons`.
+
+A link to the appropriate I2C controller can be found at ``/dev/play/grove/i2c``.
diff --git a/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst b/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst
index 9e4d51fa3e7bc2db14460925977db4e1626286a0..5d3e0506e9b4dedb11a265e6ef67049e45f00f5c 100644
--- a/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst
+++ b/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst
@@ -10,3 +10,13 @@ Steps:
3. Identify how driver exposes the data: IIO, net, etc.
4. Connect and power
5. Verify and utilize
+
+.. note::
+
+ We will be adding a link to the ``mikrobus-0`` device at ``/dev/play/mikrobus`` in the near
+ future, but you can find it for now at ``/sys/bus/mikrobus/devices/mikrobus-0``. If you
+ need to supply an ID (manifest), this is the directory where you will do it.
+
+ Manifesto: https://git.beagleboard.org/beagleconnect/manifesto
+
+ Patched Linux with out-of-tree Mikrobus driver: https://git.beagleboard.org/beagleboard/linux
diff --git a/boards/beagleplay/demos-and-tutorials/using-qwiic.rst b/boards/beagleplay/demos-and-tutorials/using-qwiic.rst
index d3f5629d436552ebc2ad4ad6708919680651bcc6..1d81dd758988769cad439e2a6b9ac827c80bb3e9 100644
--- a/boards/beagleplay/demos-and-tutorials/using-qwiic.rst
+++ b/boards/beagleplay/demos-and-tutorials/using-qwiic.rst
@@ -3,4 +3,6 @@
Using QWIIC
###########
-See :ref:`qwiic_stemma_grove_addons`
\ No newline at end of file
+See :ref:`qwiic_stemma_grove_addons`.
+
+A link to the appropriate I2C controller can be found at ``/dev/play/qwiic/i2c``.
diff --git a/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst b/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst
index 20d2b150cca34a17834947305e4541d3d8a14354..f65623c50d7c1f57fb93ae55c59192e0e170e9b4 100644
--- a/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst
+++ b/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst
@@ -36,9 +36,9 @@ Download and install the Debian Linux operating system image for BeaglePlay.
#. Power BeaglePlay via the USB-C connector.
-.. note::
+.. todo::
- *TODO* describe how to know it is working
+ describe how to know it is working
Log into BeaglePlay
*********************************
@@ -47,9 +47,9 @@ Please either plug in a keyboard, monitor and mouse or :code:`ssh` into the boar
somewhere else for instructions on this. You can also point your web browser to the board to log
into the Visual Studio Code IDE environment.
-.. note::
+.. todo::
- *TODO* A big part of what is missing here is to put your BeaglePlay on the Internet such
+ A big part of what is missing here is to put your BeaglePlay on the Internet such
that we can download things in later steps. That has been initially brushed over.
Flash existing IEEE 802.15.4 radio bridge (WPANUSB) firmware
@@ -357,8 +357,8 @@ Build applications for BeagleConnect Freedom
west build -d build/greybus modules/lib/greybus/samples/subsys/greybus/net -- -DOVERLAY_CONFIG=overlay-802154-subg.conf
-Flash applications to BeagleConnect Freedom from BeagleBone Green Gateway
-=========================================================================
+Flash applications to BeagleConnect Freedom
+===========================================
And then you can flash the BeagleConnect Freedom boards over USB
@@ -375,4 +375,6 @@ And then you can flash the BeagleConnect Freedom boards over USB
Debug applications over the serial terminal
===========================================
-#TODO#
+.. todo::
+
+ Describe how to handle the serial connection
diff --git a/boards/beagleplay/images/attach-antennas.webp b/boards/beagleplay/images/attach-antennas.webp
new file mode 100644
index 0000000000000000000000000000000000000000..b346698d0c3fffdf266f0e9b488f006895c08c87
Binary files /dev/null and b/boards/beagleplay/images/attach-antennas.webp differ
diff --git a/boards/capes/cape-interface-spec.rst b/boards/capes/cape-interface-spec.rst
index 8a3dea00cc23a56ccb4a7453864f61ac8088456e..58a3d601e521637ec33e2ac44bb0f41846850ef3 100644
--- a/boards/capes/cape-interface-spec.rst
+++ b/boards/capes/cape-interface-spec.rst
@@ -19,7 +19,7 @@ Background and overview
* See `elinux.org Cape Expansion Headers for BeagleBone page <https://elinux.org/Beagleboard:Cape_Expansion_Headers>`_
* See :ref:`BeagleBone Black System Reference Manual Connectors section <beagleboneblack-connectors>`
* See :ref:`BeagleBone AI System Reference Manual Connectors section <beaglebone-ai-connectors>`
- * See :ref:`BeagleBone AI-64 System Reference Manual Connectors section <TODO>`
+ * See :ref:`BeagleBone AI-64 System Reference Manual Connectors section <cape-board-support-1>`
.. note:: Below, when mentioning "Black", this is true for all AM3358-based BeagleBone boards. "AI" is AM5729-based. "AI-64" is TDA4VM-based.
@@ -51,19 +51,19 @@ More details can be found in :ref:`bone-methodology`.
Legend
- * |D|: Digital general purpose input and output (GPIO)
- * |I|: Inter-integrated circuit bus (|I2C|) ports
- * |S|: Serial peripheral interface (SPI) ports
- * |U|: Universal asynchronous reciever/transmitter (UART) serial ports
- * |C|: CAN
- * |A|: Analog inputs
- * |E|: PWM
- * |Q|: Capture/EQEP
- * |M|: MMC/SD/SDIO
- * |B|: I2S/audio serial ports
- * |L|: LCD
- * |P|: PRU
- * |Y|: ECAP
+ * |D| : Digital general purpose input and output (GPIO)
+ * |I| : Inter-integrated circuit bus (|I2C|) ports
+ * |S| : Serial peripheral interface (SPI) ports
+ * |U| : Universal asynchronous reciever/transmitter (UART) serial ports
+ * |C| : CAN
+ * |A| : Analog inputs
+ * |E| : PWM
+ * |Q| : Capture/EQEP
+ * |M| : MMC/SD/SDIO
+ * |B| : I2S/audio serial ports
+ * |L| : LCD
+ * |P| : PRU
+ * |Y| : ECAP
.. table:: Overall
@@ -501,7 +501,7 @@ SPI bone bus nodes allow creating compatible overlays for Black, AI and AI-64.
See https://stackoverflow.com/questions/53634892/linux-spidev-why-it-shouldnt-be-directly-in-devicetree for
more background. A custom overlay is required to overload the compatible string to load a non-spidev driver.
-.. note:: #TODO# figure out if BONE-SPI0_0 and BONE-SPI0_1 can be loaded at the same time
+.. todo:: figure out if BONE-SPI0_0 and BONE-SPI0_1 can be loaded at the same time
.. code-block:: c
:linenos:
@@ -666,8 +666,11 @@ CAN bone bus nodes allow creating compatible overlays for Black, AI and AI-64.
ADC
*******
-* TODO: We need a udev rule to make sure the ADC shows up at /dev/bone/adc! There's nothing for sure that IIO devices will show up in the same place.
-* TODO: I think we can also create symlinks for each channel based on which device is there, such that we can do /dev/bone/adc/Px_y
+.. todo:: We need a udev rule to make sure the ADC shows up at /dev/bone/adc! There's nothing for sure that IIO devices will show up in the same place.
+
+.. todo:: I think we can also create symlinks for each channel based on which device is there, such that we can do /dev/bone/adc/Px_y
+
+.. todo:: I believe a multiplexing IIO driver is the future solution
.. table:: ADC pins
@@ -940,7 +943,7 @@ On BeagleBone's without an eQEP on specific pins, consider using the PRU to perf
eCAP
-------
-#TODO: This doesn't include any abstraction yet.
+.. todo:: This doesn't include any abstraction yet.
.. table:: ECAP pins
@@ -1318,9 +1321,7 @@ The overlay situation for PRUs is a bit more complex than with other peripherals
GPIO
----------
-TODO<br>
-For each of the pins with a GPIO, there should be a symlink that comes from the names
-*
+.. todo:: For each of the pins with a GPIO, there should be a symlink that comes from the names
.. _bone-methodology:
@@ -1365,7 +1366,12 @@ TBD
Verification
----------------
-TODO: The steps used to verify all of these configurations is to be documented here. It will serve to document what has been tested, how to reproduce the configurations, and how to verify each major triannual release. All faults will be documented in the issue tracker.
+.. todo::
+
+ The steps used to verify all of these configurations is to be documented
+ here. It will serve to document what has been tested, how to reproduce the
+ configurations, and how to verify each major triannual release. All faults
+ will be documented in the issue tracker.
References
-------------
diff --git a/boards/index.rst b/boards/index.rst
index a95a395d2ec47c22ff2f7868e4c73388cb37f5bf..8ba8b432839d32ef37b4b04265b02ea265c3db59 100644
--- a/boards/index.rst
+++ b/boards/index.rst
@@ -34,18 +34,3 @@ started.
Use of either the boards or the design materials constitutes agreement to the T&C including any
modifications done to the hardware or software solutions provided by beagleboard.org foundation.
-.. toctree::
- :maxdepth: 1
- :hidden:
-
- /boards/beaglebone/index
- /boards/beaglebone/black/index
- /boards/beaglebone/blue/index
- /boards/beaglebone/ai/index
- /boards/beaglebone/ai-64/index
- /boards/pocketbeagle/original/index
- /boards/capes/index
- /boards/beagleconnect/index
- /boards/beagleboard/index
- /boards/beagleplay/index
-
diff --git a/books/pru-cookbook/01case/case.rst b/books/pru-cookbook/01case/case.rst
index 3094ffae3381f8f542c280afc645df0a99018a85..48563963970606936e0a326458f21385de8083a8 100644
--- a/books/pru-cookbook/01case/case.rst
+++ b/books/pru-cookbook/01case/case.rst
@@ -583,11 +583,11 @@ explaining how the PRUs get this type of performance.
.. _case_e1.31_example:
- .. literalinclude:: ../code/01start/e1.31-test.py
+ .. literalinclude:: ../code/02start/e1.31-test.py
:caption: e1.31-test.py -Example of generating packets to control the NeoPixels
:linenos:
- :download:`e1.31-test.py <../code/01start/e1.31-test.py>`
+ :download:`e1.31-test.py <../code/02start/e1.31-test.py>`
.. TODO document the code
@@ -996,11 +996,11 @@ Now, suppose you wanted to run the
`LED blink <https://simppru.readthedocs.io/en/latest/examples/led_blink/>`_
example which is reproduced here.
-.. literalinclude:: ../code/01start/blink.sim
+.. literalinclude:: ../code/01case/blink.sim
:caption: LED Blink (blink.sim)
:linenos:
-:download:`blink.sim <../code/01start/blink.sim>`
+:download:`blink.sim <../code/01case/blink.sim>`
Just run simppru
diff --git a/books/pru-cookbook/03details/details.rst b/books/pru-cookbook/03details/details.rst
index 82a71dfa9e3e0cabac245bce75c6b79f0135c703..78a3796346763c390bdf40256524aa893872ed41 100644
--- a/books/pru-cookbook/03details/details.rst
+++ b/books/pru-cookbook/03details/details.rst
@@ -213,11 +213,11 @@ The setup file also contains instructions to figure out which Beagle you are run
and then configure the pins accordingly.
-.. literalinclude:: ../code/06io/gpio_setup.sh
- :caption: gpio_setup.sh
+.. literalinclude:: ../code/06io/setup.sh
+ :caption: setup.sh
:linenos:
-:download:`gpio_setup.sh <../code/06io/gpio_setup.sh>`
+:download:`setup.sh <../code/06io/setup.sh>`
.. table::
@@ -333,11 +333,11 @@ The ``am57xx_pru.cmd`` does the same for the AI.
Both files can be found in ``/var/lib/cloud9/common``.
-.. literalinclude:: ../code/06io/am335x_pru.cmd
+.. literalinclude:: ../code/03details/am335x_pru.cmd
:caption: am335x_pru.cmd
:linenos:
-:download:`am335x_pru.cmd <../code/06io/am335x_pru.cmd>`
+:download:`am335x_pru.cmd <../code/03details/am335x_pru.cmd>`
.. TODO does this need updating?
@@ -462,11 +462,11 @@ everything is already configured for you.
If you are on the Black or Pocket you'll need to run the following script.
-.. literalinclude:: ../code/06io/servos_setup.sh
+.. literalinclude:: ../code/03details/servos_setup.sh
:caption: servos_setup.sh
:linenos:
-:download:`servos_setup.sh <../code/06io/servos_setup.sh>`
+:download:`servos_setup.sh <../code/03details/servos_setup.sh>`
Discussion
-----------
@@ -492,11 +492,11 @@ It depends on which Beagle you are running on. If you are on the AI or Blue,
everything is already configured for you.
If you are on the Black or Pocket you'll need to run the following script.
-.. literalinclude:: ../code/06io/encoder_setup.sh
+.. literalinclude:: ../code/03details/encoder_setup.sh
:caption: encoder_setup.sh
:linenos:
-:download:`encoder_setup.sh <../code/06io/encoder_setup.sh>`
+:download:`encoder_setup.sh <../code/03details/encoder_setup.sh>`
Discussion
-----------
diff --git a/conf.py b/conf.py
index 7a1c10cb32d0b5a742849f3d014ca0a8474da102..2f9cd97b1dbd625a2ed7ea616011fed85b4a6085 100644
--- a/conf.py
+++ b/conf.py
@@ -17,7 +17,7 @@ BBDOCS_BASE = Path(__file__).resolve().parents[0]
# -- Project information -----------------------------------------------------
project = 'BeagleBoard Docs'
-copyright = '2022, BeagleBoard.org Foundation'
+copyright = '2023, BeagleBoard.org Foundation'
author = 'BeagleBoard.org Foundation'
@@ -28,9 +28,31 @@ sys.path.append(os.path.abspath("./_ext"))
extensions = [
"callouts",
"sphinxcontrib.rsvgconverter",
- "sphinx_design"
+ "sphinx_design",
+ "sphinxcontrib.images",
+ "sphinx.ext.imgconverter",
+ "sphinx.ext.todo"
]
+todo_include_todos = True
+
+from sphinx.ext import imgconverter
+
+class WebPConverter(imgconverter.ImageConverter):
+ def apply(self, source, target):
+ import os
+ from PIL import Image
+
+ ext = os.path.splitext(source)[-1].lower()
+ if ext == '.webp':
+ with Image.open(source) as img:
+ img.save(target, format='PNG')
+ else:
+ super().apply(source, target)
+
+#if 'latex' in tags:
+imgconverter = WebPConverter
+
templates_path = ['_templates']
source_suffix = '.rst'
@@ -86,7 +108,7 @@ with open(BBDOCS_BASE / "VERSION") as f:
release = version
# Variables here holds default settings
-pages_url = "http://docs.beagleboard.io"
+pages_url = "https://docs.beagleboard.io"
pages_slug = "latest"
gitlab_user = "docs"
gitlab_version = "main"
diff --git a/gitlab-build.sh b/gitlab-build.sh
index 10502ddf9a4605cd277613545503e8111954eab5..59ff1cd51681573c96cd4d5f5f8a74cd0ae44f70 100755
--- a/gitlab-build.sh
+++ b/gitlab-build.sh
@@ -1,10 +1,4 @@
#!/bin/bash
-
-apk add git
-apk add rsync
-apk add date
-apk add pdfcpu
-
export VER_LATEST_MAJOR=1
export VER_LATEST_MINOR=0
export VER_LATEST_EXTRA=wip
diff --git a/index-tex.rst b/index-tex.rst
index b51bb2425fc4e476b144c5619364d73a25c20ac0..97154bfd54b4e343ee5eda802ab36b13c58dd00f 100644
--- a/index-tex.rst
+++ b/index-tex.rst
@@ -11,8 +11,20 @@ BeagleBoard Docs
.. toctree::
intro/index.rst
- boards/index.rst
- projects/index.rst
- books/index.rst
- accessories/index.rst
- boards/terms-and-conditions.rst
+ boards/beagleplay/index
+ boards/beaglebone/ai-64/index
+ boards/beaglebone/ai/index
+ boards/beaglebone/black/index
+ boards/beaglebone/blue/index
+ boards/beaglebone/index
+ boards/capes/index
+ boards/pocketbeagle/original/index
+ boards/beagleconnect/freedom/index
+ boards/capes/index
+ boards/pocketbeagle/original/index
+ boards/beagleconnect/freedom/index
+ boards/beagleboard/index
+ projects/index
+ books/index
+ accessories/index
+ boards/terms-and-conditions
diff --git a/index.rst b/index.rst
index db0e486fe3a0160018d7c74538bc5be7920601a4..1e706259fcd4d5c694ab79c0e26116d5ef988f74 100644
--- a/index.rst
+++ b/index.rst
@@ -355,7 +355,7 @@ Capes
/boards/pocketbeagle/original/index
/boards/beagleconnect/freedom/index
/boards/beagleboard/index
- /boards/terms-and-conditions.rst
+ /boards/terms-and-conditions
Projects
diff --git a/intro/contribution/index.rst b/intro/contribution/index.rst
index b1ac606d37fe3e3e2c96641cca3e588d863205e8..6f915c8c309cf6cb7d5857329c52ec79356b71f4 100644
--- a/intro/contribution/index.rst
+++ b/intro/contribution/index.rst
@@ -66,15 +66,28 @@ The most obvious way to contribute is using the `git.beagleboard.org Gitlab serv
bugs, suggest enhancements and providing merge requests, also called pull requests, the provide fixes to software, hardware
designs and documentation.
+This documentation has a number of ``todo`` items where help is needed that can be searched in the source.
+
+.. todolist::
+
Reporting bugs
===============
+.. todo::
+ Describe where and how to report issues on git.beagleboard.org
+
Suggesting enhancements
=======================
+.. todo::
+ Describe how to introduct ideas on forum.beagleboard.org and git.beagleboard.org
+
Submitting merge requests
=========================
+.. todo::
+ Describe how to introduct ideas on forum.beagleboard.org and git.beagleboard.org
+
Style and usage guidelines
**************************
diff --git a/intro/contribution/linux-upstream.rst b/intro/contribution/linux-upstream.rst
index 5768053c6ea815af6eeebfdb2a84a2b88497ead2..106d4bf6d7f842081c5f8e20701afd92d42f0f38 100644
--- a/intro/contribution/linux-upstream.rst
+++ b/intro/contribution/linux-upstream.rst
@@ -145,17 +145,17 @@ Device Drivers in Embedded Systems
I used the term "Drivers" in the above section, but what does it really mean?
-**Why "device" drivers?**
+.. todo::
-TODO
+ **Why "device" drivers?**
-**Why do we need drivers?**
+.. todo::
-TODO
+ **Why do we need drivers?**
-**What do drivers look like?**
+.. todo::
-TODO
+ **What do drivers look like?**
.. _linux-upstream-device-trees: