Merge branch 'main' of git.beagleboard.org:docs/docs.beagleboard.io

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:

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.
 
 

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

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

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:
 

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

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`

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`
 

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.

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                                  |
    +----------------------------------------------------+---------------------------------------------------------+

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.
+Demos and Tutorials
+*******************
\ No newline at end of file
+
+* :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`

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
 *************

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
-***
-

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    |
     +---------+------------------------------------------------------------+----------------------+-------+
 

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

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``.

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

boards/beagleplay/demos-and-tutorials/using-qwiic.rst

@@ -3,4 +3,6 @@
 Using QWIIC
 ###########
 
-See :ref:`qwiic_stemma_grove_addons`
+See :ref:`qwiic_stemma_grove_addons`.
\ No newline at end of file
+
+A link to the appropriate I2C controller can be found at ``/dev/play/qwiic/i2c``.

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