Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit 27ba92e9 authored by Deepak Khatri's avatar Deepak Khatri :dog:
Browse files

Fix todo format

parent 0af47d5a
1 merge request!89Docs updates - chapter restructuring, images, and more
Showing
with 157 additions and 166 deletions
...@@ -370,7 +370,7 @@ USB-C Power ...@@ -370,7 +370,7 @@ USB-C Power
Below image shows how the USB-C power input is connected to the **TPS6590379**. Below image shows how the USB-C power input is connected to the **TPS6590379**.
.. TODO: (Schematic screenshot) .. todo:: (Schematic screenshot)
Power Button Power Button
============= =============
...@@ -501,7 +501,7 @@ The HDMI interface is aligned with the HDMI TMDS single stream standard ...@@ -501,7 +501,7 @@ The HDMI interface is aligned with the HDMI TMDS single stream standard
v1.4a (720p @60Hz to 1080p @24Hz) and the HDMI v1.3 (1080p @60Hz): 3 v1.4a (720p @60Hz to 1080p @24Hz) and the HDMI v1.3 (1080p @60Hz): 3
data channels, plus 1 clock channel is supported (differential). data channels, plus 1 clock channel is supported (differential).
TODO: Verify it isn’t better than this. Doesn’t seem right. .. todo:: Verify it isn’t better than this. Doesn’t seem right.
PRU-ICSS PRU-ICSS
********* *********
......
...@@ -921,7 +921,7 @@ for this second processor pin. ...@@ -921,7 +921,7 @@ for this second processor pin.
+-----------------+--------------------+--------------------+ +-----------------+--------------------+--------------------+
TODO: Notes regarding the resistors on muxed pins. .. todo:: Notes regarding the resistors on muxed pins.
Connector P9 Connector P9
============== ==============
...@@ -963,13 +963,13 @@ In the table are the following notations: ...@@ -963,13 +963,13 @@ In the table are the following notations:
**PWR_BUT** is a 5V level as pulled up internally by the TPS6590379. It **PWR_BUT** is a 5V level as pulled up internally by the TPS6590379. It
is activated by pulling the signal to GND. is activated by pulling the signal to GND.
TODO: (Actually, on BeagleBone AI, I believe PWR_BUT is pulled to 3.3V, .. todo:: (Actually, on BeagleBone AI, I believe PWR_BUT is pulled to 3.3V,
but activation is still done by pulling the signal to GND. Also, a quick but activation is still done by pulling the signal to GND. Also, a quick
grounding of PWR_BUT will trigger a system event where shutdown can grounding of PWR_BUT will trigger a system event where shutdown can
occur, but there is no hardware power-off function like on BeagleBone occur, but there is no hardware power-off function like on BeagleBone
Black via this signal. It does, however, act as a hardware power-on.) Black via this signal. It does, however, act as a hardware power-on.)
TODO: (On BeagleBone Black, SYS_RESET was a bi-directional signal, but .. todo:: (On BeagleBone Black, SYS_RESET was a bi-directional signal, but
it is only an output from BeagleBone AI to capes on BeagleBone AI.) it is only an output from BeagleBone AI to capes on BeagleBone AI.)
.. table:: P9.01-P9.05 .. table:: P9.01-P9.05
...@@ -1792,7 +1792,7 @@ TODO ...@@ -1792,7 +1792,7 @@ TODO
Expansion Connector Headers Expansion Connector Headers
****************************** ******************************
TODO: discuss header options for working with the expansion connectors per .. todo:: discuss header options for working with the expansion connectors per
https://git.beagleboard.org/beagleboard/beaglebone-black/-/wikis/System-Reference-Manual#section-7-1 https://git.beagleboard.org/beagleboard/beaglebone-black/-/wikis/System-Reference-Manual#section-7-1
Signal Usage Signal Usage
......
...@@ -113,9 +113,7 @@ BeagleConnect™ node device designs. ...@@ -113,9 +113,7 @@ BeagleConnect™ node device designs.
Greybus Greybus
------- -------
TODO .. todo:: Find a place for the following notes:
#TODO: Find a place for the following notes:
* The device interfaces get exposed to the host via Greybus BRIDGED_PHY * The device interfaces get exposed to the host via Greybus BRIDGED_PHY
protocol protocol
......
...@@ -37,13 +37,9 @@ Install the SDK on BeaglePlay ...@@ -37,13 +37,9 @@ Install the SDK on BeaglePlay
See :ref:`beagleplay-zephyr-development-setup`. See :ref:`beagleplay-zephyr-development-setup`.
.. important:: .. todo:: note the tested version of software for BeaglePlay
TODO: note the tested version of software for BeaglePlay
.. important:: .. todo:: describe how to know it is working
TODO: describe how to know it is working
Change default board Change default board
==================== ====================
......
...@@ -72,7 +72,7 @@ microcontroller firmware. The Linux environment provides opportunities for ...@@ -72,7 +72,7 @@ microcontroller firmware. The Linux environment provides opportunities for
high-level remote management using tools like Balena with applications deployed high-level remote management using tools like Balena with applications deployed
in Docker containers. in Docker containers.
#TODO: provide image illustrating remote management .. todo:: provide image illustrating remote management
The hardware and software are fully open source, providing for scalability and a lack of vendor lock-in. The hardware and software are fully open source, providing for scalability and a lack of vendor lock-in.
......
...@@ -1131,7 +1131,7 @@ Each temperature sensor has a unique serial number, so you can have several all ...@@ -1131,7 +1131,7 @@ Each temperature sensor has a unique serial number, so you can have several all
Playing and Recording Audio Playing and Recording Audio
============================ ============================
.. TODO .. todo::
Remove? Remove?
Problem Problem
......
...@@ -729,7 +729,7 @@ The instructions here are based on using **networkctl**. ...@@ -729,7 +729,7 @@ The instructions here are based on using **networkctl**.
Instructions for setting up your network. Instructions for setting up your network.
.. TODO .. todo::
is this up to date? is this up to date?
Several WiFi adapters work with the Bone. Check `WiFi Adapters <http://bit.ly/1EbEwUo>`_ for the latest list. Several WiFi adapters work with the Bone. Check `WiFi Adapters <http://bit.ly/1EbEwUo>`_ for the latest list.
...@@ -762,7 +762,7 @@ Then run *lsusb* to ensure that your Bone found the adapter: ...@@ -762,7 +762,7 @@ Then run *lsusb* to ensure that your Bone found the adapter:
being discovered when hot-plugged, which is why you should reboot. Newer kernels should address this issue. being discovered when hot-plugged, which is why you should reboot. Newer kernels should address this issue.
.. TODO .. todo::
update update
Next, run *networkctl* to find your adapter's name. Mine is Next, run *networkctl* to find your adapter's name. Mine is
...@@ -851,7 +851,7 @@ Change the *ssid* and *psk* entries for your network. Save your file, then run: ...@@ -851,7 +851,7 @@ Change the *ssid* and *psk* entries for your network. Save your file, then run:
Sharing the Host's Internet Connection over USB Sharing the Host's Internet Connection over USB
================================================= =================================================
.. TODO .. todo::
Test this Test this
Problem Problem
...@@ -937,7 +937,7 @@ what if you have a web server on your Bone that you want to access from the worl ...@@ -937,7 +937,7 @@ what if you have a web server on your Bone that you want to access from the worl
The solution is to use port forwarding from your host. The solution is to use port forwarding from your host.
Web servers typically listen to port *80*. First, look up the IP address of your host: Web servers typically listen to port *80*. First, look up the IP address of your host:
.. TODO .. todo::
switch to ip address switch to ip address
.. code-block:: bash .. code-block:: bash
...@@ -964,7 +964,7 @@ It's the number following *inet*, which in my case is *172.31.43.210*. ...@@ -964,7 +964,7 @@ It's the number following *inet*, which in my case is *172.31.43.210*.
Then run the following, using your host's IP address: Then run the following, using your host's IP address:
.. TODO .. todo::
check this iptables, convert to ufw check this iptables, convert to ufw
.. code-block:: bash .. code-block:: bash
...@@ -1195,7 +1195,7 @@ The second partition (*p2*) is the root of the file system. ...@@ -1195,7 +1195,7 @@ The second partition (*p2*) is the root of the file system.
The *ls* command shows what devices are available to mount. Because *mmcblk0* is already mounted, The *ls* command shows what devices are available to mount. Because *mmcblk0* is already mounted,
*/dev/mmcblk1p1* must be the other media that we need to mount. Run the following commands to mount it: */dev/mmcblk1p1* must be the other media that we need to mount. Run the following commands to mount it:
.. TODO .. todo::
update update
.. code-block:: bash .. code-block:: bash
......
...@@ -499,7 +499,7 @@ Run it: ...@@ -499,7 +499,7 @@ Run it:
bone$ ./analogInContinuous.py bone$ ./analogInContinuous.py
Hit ^C to stop Hit ^C to stop
.. TODO .. todo::
verify this works. fonts are taking too long to load verify this works. fonts are taking too long to load
:ref:`analog_sine_fig` is the output of a 1KHz sine wave. :ref:`analog_sine_fig` is the output of a 1KHz sine wave.
...@@ -591,7 +591,7 @@ A number of files get installed, including the ADC file. Now try rerunning. ...@@ -591,7 +591,7 @@ A number of files get installed, including the ADC file. Now try rerunning.
Here's the output of a 10KHz triangle wave. Here's the output of a 10KHz triangle wave.
.. TODO .. todo::
Is this true: (The plot is wrong, but eLinux won't let me fix it.) Is this true: (The plot is wrong, but eLinux won't let me fix it.)
.. _analog_tri_fig: .. _analog_tri_fig:
...@@ -662,7 +662,7 @@ See https://realpython.com/python-send-email/ for an example that sends an attac ...@@ -662,7 +662,7 @@ See https://realpython.com/python-send-email/ for an example that sends an attac
Sending an SMS Message Sending an SMS Message
======================= =======================
.. TODO .. todo::
My twilio account is suspended, using yoder@rose-hulman.edu. My twilio account is suspended, using yoder@rose-hulman.edu.
Problem Problem
...@@ -863,7 +863,7 @@ Around line 15 is the *id* number. Paste in the value returned above. ...@@ -863,7 +863,7 @@ Around line 15 is the *id* number. Paste in the value returned above.
:download:`twitter_delete_tweet.py <../code/06iot/twitter_delete_tweet.py>` :download:`twitter_delete_tweet.py <../code/06iot/twitter_delete_tweet.py>`
.. TODO .. todo::
Start Here. Update for python. Start Here. Update for python.
The code in :ref:`networking_pushbutton_code` sends a tweet whenever a button is pushed. The code in :ref:`networking_pushbutton_code` sends a tweet whenever a button is pushed.
......
...@@ -33,7 +33,7 @@ chapters you will see the details of how they work. ...@@ -33,7 +33,7 @@ chapters you will see the details of how they work.
Here we present: Here we present:
.. TODO Switch from LEDscape to FPP .. todo:: Switch from LEDscape to FPP
* `Robotics Control Library <https://beagleboard.org/librobotcontrol>`_ * `Robotics Control Library <https://beagleboard.org/librobotcontrol>`_
* `BeagleLogic <https://github.com/abhishek-kakkar/BeagleLogic/wiki>`_ * `BeagleLogic <https://github.com/abhishek-kakkar/BeagleLogic/wiki>`_
...@@ -108,8 +108,7 @@ via the PRU that can be used out of the box. ...@@ -108,8 +108,7 @@ via the PRU that can be used out of the box.
:ref:`details_configure_servos` :ref:`details_configure_servos`
to configure the pins for the Black and the Pocket. to configure the pins for the Black and the Pocket.
.. todo:: verify these commands
.. * TODO - verify these commands
Just run: Just run:
...@@ -339,7 +338,7 @@ It points to an older image (beaglelogic-stretch-2017-07-13-4gb.img.xz) but shou ...@@ -339,7 +338,7 @@ It points to an older image (beaglelogic-stretch-2017-07-13-4gb.img.xz) but shou
If you want to be running a newer image, there are instructions on the site for `installing BeagleLogic <https://beaglelogic.readthedocs.io/en/latest/install.html>`_, but I had to do the additional steps in :ref:`case_installing_beaglelogic`. If you want to be running a newer image, there are instructions on the site for `installing BeagleLogic <https://beaglelogic.readthedocs.io/en/latest/install.html>`_, but I had to do the additional steps in :ref:`case_installing_beaglelogic`.
.. TODO - Recheck .. todo:: - Recheck
.. _case_installing_beaglelogic: .. _case_installing_beaglelogic:
...@@ -429,167 +428,166 @@ BeagleLogic uses the two PRUs to sample at 100Msps. Getting a PRU running at 20 ...@@ -429,167 +428,166 @@ BeagleLogic uses the two PRUs to sample at 100Msps. Getting a PRU running at 20
explaining how the PRUs get this type of performance. explaining how the PRUs get this type of performance.
.. .. todo:: This is currently broken with the latest version of Falcon Christmas (no F8-B-20.json file)
TODO This is currently broken with the latest version of Falcon Christmas (no F8-B-20.json file)
NeoPixels -- 5050 RGB LEDs with Integrated Drivers (Falcon Christmas) NeoPixels -- 5050 RGB LEDs with Integrated Drivers (Falcon Christmas)
*********************************************************************** ***********************************************************************
Problem Problem
-------- --------
You have an `Adafruit NeoPixel LED string <http://www.adafruit.com/products/1138>`_, You have an `Adafruit NeoPixel LED string <http://www.adafruit.com/products/1138>`_,
`Adafruit NeoPixel LED matrix <http://www.adafruit.com/products/1487>`_ or `Adafruit NeoPixel LED matrix <http://www.adafruit.com/products/1487>`_ or
any other type of any other type of
`WS2812 LED <https://cdn-shop.adafruit.com/datasheets/WS2812.pdf>`_ `WS2812 LED <https://cdn-shop.adafruit.com/datasheets/WS2812.pdf>`_
and want to light it up. and want to light it up.
.. TODO Show how to drive ws2812's with FPP. .. todo:: Show how to drive ws2812's with FPP.
Solution Solution
--------- ---------
If you are driving just one string you can write your own code If you are driving just one string you can write your own code
(See :ref:`blocks_ws2812`) (See :ref:`blocks_ws2812`)
If you plan to drive multiple strings, then consider If you plan to drive multiple strings, then consider
Falcon Christmas (`FPP <https://falconchristmas.com/>`_). Falcon Christmas (`FPP <https://falconchristmas.com/>`_).
FPP can be used to drive both LEDs with an integrated FPP can be used to drive both LEDs with an integrated
driver (neopixels) or without an integrated driver. Here we'll show you how to driver (neopixels) or without an integrated driver. Here we'll show you how to
set up for the integrated drive and in the next section the no driver LEDs will be set up for the integrated drive and in the next section the no driver LEDs will be
show. show.
Hardware Hardware
---------- ----------
For this setup we'll wire a single string of NeoPixels to the Beagle. For this setup we'll wire a single string of NeoPixels to the Beagle.
I've attached the black wire on the string to ground on the Beagle I've attached the black wire on the string to ground on the Beagle
and the red wire to a 3.3V pin on the Beagle. and the red wire to a 3.3V pin on the Beagle.
The yellow data in line is attached to P1.31 (I'm using a PocketBeagle.). The yellow data in line is attached to P1.31 (I'm using a PocketBeagle.).
How did I know to attach to P1.31? The FalconChristmas git repo How did I know to attach to P1.31? The FalconChristmas git repo
(https://github.com/FalconChristmas/fpp) has files that tell which pins (https://github.com/FalconChristmas/fpp) has files that tell which pins
attach to which port. https://github.com/FalconChristmas/fpp/blob/master/capes/pb/strings/F8-B-20.json attach to which port. https://github.com/FalconChristmas/fpp/blob/master/capes/pb/strings/F8-B-20.json
has a list of 20 ports and where they are connected. Pin P1.31 appears on has a list of 20 ports and where they are connected. Pin P1.31 appears on
line 27. It's the 20th entry in the list. You could pick any of the others line 27. It's the 20th entry in the list. You could pick any of the others
if you'd rather. if you'd rather.
Software Setup Software Setup
--------------- ---------------
Assuming the PocketBeagle is attached via the USB cable, Assuming the PocketBeagle is attached via the USB cable,
on your host computer browse to <http://192.168.7.2/> and you will see on your host computer browse to <http://192.168.7.2/> and you will see
:ref:`case_fpp_program_control2`. :ref:`case_fpp_program_control2`.
.. _case_fpp_program_control2: .. _case_fpp_program_control2:
.. figure:: figures/fpp_program_control.png .. figure:: figures/fpp_program_control.png
:align: center :align: center
:alt: Falcon Play Program Control :alt: Falcon Play Program Control
Falcon Play Program Control Falcon Play Program Control
You can test the display by first setting up the Channel Outputs and then You can test the display by first setting up the Channel Outputs and then
going to *Display Testing*. :ref:`case_channel_outputs_menu2` shows where to going to *Display Testing*. :ref:`case_channel_outputs_menu2` shows where to
select Channel Outputs and :ref:`case_channel_outputs2` shows which settings to use. select Channel Outputs and :ref:`case_channel_outputs2` shows which settings to use.
.. _case_channel_outputs_menu2: .. _case_channel_outputs_menu2:
.. figure:: figures/fpp_channel_outputs_menu.png .. figure:: figures/fpp_channel_outputs_menu.png
:align: center :align: center
:alt: Selecting Channel Outputs :alt: Selecting Channel Outputs
Selecting Channel Outputs Selecting Channel Outputs
.. _case_channel_outputs2: .. _case_channel_outputs2:
.. figure:: figures/fpp_channel_outputs_strings.png .. figure:: figures/fpp_channel_outputs_strings.png
:align: center :align: center
:alt: Channel Outputs Settings :alt: Channel Outputs Settings
Channel Outputs Settings Channel Outputs Settings
Click on the *Pixel Strings* tab. Earlier we noted that *P1.31* is attached Click on the *Pixel Strings* tab. Earlier we noted that *P1.31* is attached
to port 20. Note that at the bottom of the screen, port 20 has a PIXEL COUNT to port 20. Note that at the bottom of the screen, port 20 has a PIXEL COUNT
of 24. We're telling FPP our string has 24 NeoPixels and they are attached of 24. We're telling FPP our string has 24 NeoPixels and they are attached
to port 2 which in *P1.31*. to port 2 which in *P1.31*.
Be sure to check the *Enable String Cape*. Be sure to check the *Enable String Cape*.
Next we need to test the display. Select **Display Testing** shown in Next we need to test the display. Select **Display Testing** shown in
:ref:`case_display_testing_menu2`. :ref:`case_display_testing_menu2`.
.. _case_display_testing_menu2: .. _case_display_testing_menu2:
.. figure:: figures/fpp_display_testing_menu2.png .. figure:: figures/fpp_display_testing_menu2.png
:align: center :align: center
:alt: Selecting Display Testing :alt: Selecting Display Testing
Selecting Display Testing Selecting Display Testing
Set the *End Channel* to *72*. (72 is 3*24) Set the *End Channel* to *72*. (72 is 3*24)
Click *Enable Test Mode* and your matrix should light up. Try the different Click *Enable Test Mode* and your matrix should light up. Try the different
testing patterns shown in :ref:`case_display_testing2`. testing patterns shown in :ref:`case_display_testing2`.
.. note:: .. note::
Clicking on the *-3* will subtract three from the End Channel, which should Clicking on the *-3* will subtract three from the End Channel, which should
then display three fewer LEDs which is one NeoPixel. The last of your NeoPixels then display three fewer LEDs which is one NeoPixel. The last of your NeoPixels
should go black. This is an easy way to make sure you have the correct pixel should go black. This is an easy way to make sure you have the correct pixel
count. count.
.. _case_display_testing2: .. _case_display_testing2:
.. figure:: figures/fpp_display_testing2.png .. figure:: figures/fpp_display_testing2.png
:align: center :align: center
:alt: Display Testing Options :alt: Display Testing Options
Display Testing Options Display Testing Options
You can control the LED string using the E1.31 protocol. You can control the LED string using the E1.31 protocol.
(https://www.doityourselfchristmas.com/wiki/index.php?title=E1.31_(Streaming-ACN)_Protocol) (https://www.doityourselfchristmas.com/wiki/index.php?title=E1.31_(Streaming-ACN)_Protocol)
First configure the input channels by going to Channel Inputs as shown in First configure the input channels by going to Channel Inputs as shown in
:ref:`case_channel_inputs`. :ref:`case_channel_inputs`.
.. _case_channel_inputs: .. _case_channel_inputs:
.. figure:: figures/fpp_channel_inputs.png .. figure:: figures/fpp_channel_inputs.png
:align: center :align: center
:alt: Going to Channel Inputs :alt: Going to Channel Inputs
Going to Channel Inputs Going to Channel Inputs
Tell it you have 72 LEDs and enable the input as shown in :ref:`case_set_inputs`. Tell it you have 72 LEDs and enable the input as shown in :ref:`case_set_inputs`.
.. _case_set_inputs: .. _case_set_inputs:
.. figure:: figures/fpp_inputs_setup2.png .. figure:: figures/fpp_inputs_setup2.png
:align: center :align: center
:alt: Setting Channel Inputs :alt: Setting Channel Inputs
Setting Channel Inputs Setting Channel Inputs
Finally go to the Status Page as shown in :ref:`case_status`. Finally go to the Status Page as shown in :ref:`case_status`.
.. _case_status: .. _case_status:
.. figure:: figures/fpp_status.png .. figure:: figures/fpp_status.png
:align: center :align: center
:alt: Watching Status :alt: Watching Status
Watching the status Watching the status
Now run a program on another computer that generated E1.31 packets. Now run a program on another computer that generated E1.31 packets.
:ref:`case_e1.31_example` is an example python program. :ref:`case_e1.31_example` is an example python program.
.. _case_e1.31_example: .. _case_e1.31_example:
.. literalinclude:: ../code/02start/e1.31-test.py .. literalinclude:: ../code/02start/e1.31-test.py
:caption: e1.31-test.py -Example of generating packets to control the NeoPixels :caption: e1.31-test.py -Example of generating packets to control the NeoPixels
:linenos: :linenos:
:download:`e1.31-test.py <../code/02start/e1.31-test.py>` :download:`e1.31-test.py <../code/02start/e1.31-test.py>`
.. TODO document the code .. todo:: document the code
.. _case_rgb_matrix: .. _case_rgb_matrix:
...@@ -753,7 +751,7 @@ Run xLights and you'll see :ref:`case_xlights_setup`. ...@@ -753,7 +751,7 @@ Run xLights and you'll see :ref:`case_xlights_setup`.
host$ chmod +x xLights-2021.18-x86_64.AppImage host$ chmod +x xLights-2021.18-x86_64.AppImage
host$ ./xLights-2021.18-x86_64.AppImage host$ ./xLights-2021.18-x86_64.AppImage
.. TODO update the figures. .. todo:: update the figures.
.. _case_xlights_setup: .. _case_xlights_setup:
...@@ -857,7 +855,7 @@ Click on the **Save** button above the table. ...@@ -857,7 +855,7 @@ Click on the **Save** button above the table.
Then go to the **Status/Control** menu and select **Status Page**. Then go to the **Status/Control** menu and select **Status Page**.
.. TODO update this .. todo:: update this
.. _case_mode_bridge: .. _case_mode_bridge:
......
...@@ -175,7 +175,7 @@ Solution ...@@ -175,7 +175,7 @@ Solution
On your host computer open a browser and go to On your host computer open a browser and go to
http://www.beagleboard.org/distros. http://www.beagleboard.org/distros.
.. TODO Update links .. todo:: Update links
This shows you two current choices of recent Debian images, This shows you two current choices of recent Debian images,
one for the BeagleBone AI one for the BeagleBone AI
...@@ -330,7 +330,7 @@ Solution ...@@ -330,7 +330,7 @@ Solution
The 'hello, world' of the embedded world is to flash an LED. :ref:`start_hello` The 'hello, world' of the embedded world is to flash an LED. :ref:`start_hello`
is some code that blinks the ``USR3`` LED ten times using the PRU. is some code that blinks the ``USR3`` LED ten times using the PRU.
.. TODO The *'s and _'s in the code are messing with the formatting. .. todo:: The *'s and _'s in the code are messing with the formatting.
.. _start_hello: .. _start_hello:
......
...@@ -38,11 +38,10 @@ It's all on a GitHub repository. ...@@ -38,11 +38,10 @@ It's all on a GitHub repository.
bone$ git clone https://git.beagleboard.org/beagleboard/pru-cookbook-code bone$ git clone https://git.beagleboard.org/beagleboard/pru-cookbook-code
bone$ cd pru-cookbook-code bone$ cd pru-cookbook-code
bone$ sudo ./install.sh bone$ sudo ./install.sh
.. note::
#TODO#: The version of code used needs to be noted in the documentation.
.. note:: .. todo:: The version of code used needs to be noted in the documentation.
#TODO#: Why is this documented in multiple places?
.. todo:: Why is this documented in multiple places?
.. _compiling_with_clpru_and_lnkpru: .. _compiling_with_clpru_and_lnkpru:
...@@ -344,7 +343,7 @@ Both files can be found in ``/opt/source/pru-cookbook-code/common``. ...@@ -344,7 +343,7 @@ Both files can be found in ``/opt/source/pru-cookbook-code/common``.
:download:`am335x_pru.cmd <../code/03details/am335x_pru.cmd>` :download:`am335x_pru.cmd <../code/03details/am335x_pru.cmd>`
.. TODO does this need updating? .. todo:: does this need updating?
The cmd file for the AI is about the same, with appropriate addresses for the AI. The cmd file for the AI is about the same, with appropriate addresses for the AI.
......
...@@ -110,7 +110,7 @@ Once ``prudebug`` is installed is rather easy to use. ...@@ -110,7 +110,7 @@ Once ``prudebug`` is installed is rather easy to use.
``prudebug`` has now been ported to the AI. ``prudebug`` has now been ported to the AI.
.. TODO Isn't working on Pocket at this time. .. todo:: Isn't working on Pocket at this time.
.. code-block:: bash .. code-block:: bash
...@@ -280,7 +280,7 @@ Problem ...@@ -280,7 +280,7 @@ Problem
I'd like to use something like ``printf()`` to debug my code. I'd like to use something like ``printf()`` to debug my code.
.. TODO Check these on the Black and Pocket without grove .. todo:: Check these on the Black and Pocket without grove
Solution Solution
--------- ---------
...@@ -389,7 +389,7 @@ For example ...@@ -389,7 +389,7 @@ For example
DRA7XX_CORE_IOPAD(0x3610, *PIN_INPUT* | MUX_MODE10) // C6: P8.33a: DRA7XX_CORE_IOPAD(0x3610, *PIN_INPUT* | MUX_MODE10) // C6: P8.33a:
.. * TODO - Add code for Blue. .. todo:: Add code for Blue.
.. literalinclude:: ../code/04debug/uart1.pru1_0.c .. literalinclude:: ../code/04debug/uart1.pru1_0.c
:caption: uart1.pru1_0.c :caption: uart1.pru1_0.c
......
...@@ -28,7 +28,7 @@ Problem ...@@ -28,7 +28,7 @@ Problem
I want to control where my variables are stored in memory. I want to control where my variables are stored in memory.
.. TODO Include a section on accessing DDR. .. todo:: Include a section on accessing DDR.
Solution Solution
--------- ---------
...@@ -480,7 +480,7 @@ Here's what's in ``resource_table_empty.h`` ...@@ -480,7 +480,7 @@ Here's what's in ``resource_table_empty.h``
Bit 0 is the LSB. Bit 0 is the LSB.
.. TODO fill in Blue .. todo:: fill in Blue
.. _blocks_mapping_bits: .. _blocks_mapping_bits:
...@@ -1581,7 +1581,7 @@ Run the code as usual. ...@@ -1581,7 +1581,7 @@ Run the code as usual.
bone$ echo -1 > /dev/rpmsg_pru30 bone$ echo -1 > /dev/rpmsg_pru30
.. TODO get this working on the 5.10 kernel .. todo:: get this working on the 5.10 kernel
``/dev/rpmsg_pru30`` is a device driver that lets the ARM talk to the PRU. ``/dev/rpmsg_pru30`` is a device driver that lets the ARM talk to the PRU.
The first ``echo`` says to set the 0^th^ LED to RGB value 0xff 0 127. (Note: you can The first ``echo`` says to set the 0^th^ LED to RGB value 0xff 0 127. (Note: you can
...@@ -1720,7 +1720,7 @@ That gives a good overview, but there are a few details missing. ...@@ -1720,7 +1720,7 @@ That gives a good overview, but there are a few details missing.
:ref:`blocks_rgb_python` is a functioning python program that gives a nice :ref:`blocks_rgb_python` is a functioning python program that gives a nice
high-level view of how to drive the display. high-level view of how to drive the display.
.. TODO Test this .. todo:: Test this
.. _blocks_rgb_python: .. _blocks_rgb_python:
......
...@@ -227,7 +227,7 @@ the relative humidity and after "4t:" is the temperature in Celsius. ...@@ -227,7 +227,7 @@ the relative humidity and after "4t:" is the temperature in Celsius.
Flash BeagleConnect™ Freedom node device with Greybus firmware Flash BeagleConnect™ Freedom node device with Greybus firmware
-------------------------------------------------------------- --------------------------------------------------------------
#TODO: How can we add a step in here to show the network is connected without needing gbridge to be fully functional? .. todo:: How can we add a step in here to show the network is connected without needing gbridge to be fully functional?
Do this from the BeagleBone® Green Gateway board that was previously used to Do this from the BeagleBone® Green Gateway board that was previously used to
program the BeagleConnect™ Freedom gateway device: program the BeagleConnect™ Freedom gateway device:
...@@ -348,17 +348,17 @@ program the BeagleConnect™ Freedom gateway device: ...@@ -348,17 +348,17 @@ program the BeagleConnect™ Freedom gateway device:
debian@beaglebone:~$ debian@beaglebone:~$
#TODO: update the below for the built-in sensors .. todo:: update the below for the built-in sensors
#TODO: can we also handle the case where these sensors are included and recommend them? Same firmware? .. todo:: can we also handle the case where these sensors are included and recommend them? Same firmware?
#TODO: the current demo is for the built-in sensors, not the Click boards mentioned below .. todo:: the current demo is for the built-in sensors, not the Click boards mentioned below
Currently only a limited number of add-on boards have been tested to work over Greybus, simple add-on boards without interrupt requirement are the ones that work currently. The example is for Air Quality 2 Click and Weather Click attached to the mikroBUS ports on the device side. Currently only a limited number of add-on boards have been tested to work over Greybus, simple add-on boards without interrupt requirement are the ones that work currently. The example is for Air Quality 2 Click and Weather Click attached to the mikroBUS ports on the device side.
/var/log/gbridge will have the gbridge log, and if the mikroBUS port has been instantiated successfully the kernel log will show the devices probe messages: /var/log/gbridge will have the gbridge log, and if the mikroBUS port has been instantiated successfully the kernel log will show the devices probe messages:
#TODO: this log needs to be updated .. todo:: this log needs to be updated
.. code-block:: .. code-block::
...@@ -377,7 +377,7 @@ Currently only a limited number of add-on boards have been tested to work over G ...@@ -377,7 +377,7 @@ Currently only a limited number of add-on boards have been tested to work over G
mikrobus mikrobus-0: registering device : ams-iaq-core mikrobus mikrobus-0: registering device : ams-iaq-core
#TODO: bring in the GPIO toggle and I2C explorations for greater understanding .. todo:: bring in the GPIO toggle and I2C explorations for greater understanding
Flashing via a Linux Host Flashing via a Linux Host
------------------------- -------------------------
...@@ -622,7 +622,7 @@ While the statically configured IPv6 address is useful, it isn't 100% necessary. ...@@ -622,7 +622,7 @@ While the statically configured IPv6 address is useful, it isn't 100% necessary.
Rebuilding from source Rebuilding from source
---------------------- ----------------------
#TODO: revisit everything below here .. todo:: revisit everything below here
Prerequisites Prerequisites
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
...@@ -743,7 +743,7 @@ For this demo, I used the 5.8.4 stable kernel. Also, I've applied the ...@@ -743,7 +743,7 @@ For this demo, I used the 5.8.4 stable kernel. Also, I've applied the
Note: The parent directory :code:`~` is simply used as a placeholder for testing. Note: The parent directory :code:`~` is simply used as a placeholder for testing.
Please use whatever parent directory you see fit. Please use whatever parent directory you see fit.
TODO: The patches for gb-netlink will eventually be applied here until pushed into mainline. .. todo:: The patches for gb-netlink will eventually be applied here until pushed into mainline.
.. code-block:: bash .. code-block:: bash
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment