diff --git a/boards/beagleplay/demos-and-tutorials/using-nodered.rst b/boards/beagleplay/demos-and-tutorials/using-nodered.rst
index 5a96e2a4f44f1f4289c64ac9b6881bbfc9b74d17..9820c2c54c002c6741b02165a6f399df74ad78e9 100644
--- a/boards/beagleplay/demos-and-tutorials/using-nodered.rst
+++ b/boards/beagleplay/demos-and-tutorials/using-nodered.rst
@@ -13,41 +13,45 @@ Pre-requisites
**************
.. note::
-
- If you're using the official BeaglePlay debian image then you most likely can skip the
- :ref:`beagleplay-install-nodered` step.
+ If you're using the official BeaglePlay debian image then you most likely
+ can skip the :ref:`beagleplay-install-nodered` step.
.. _beagleplay-install-nodered:
Node-RED
********
+
Node-RED is pre-installed with the bb-node-red-installer package. (both xfce and cinnamon)
Manual steps to install Node-RED can be found in the `official guide
here <https://nodered.org/docs/getting-started/beaglebone>`_
MikroE
********
+
MikroE `Accel click <https://www.mikroe.com/accel-click>`_ is recommended, but many other boards
can work. More information about the mikroBUS interface can be found
`here <https://docs.beagleboard.org/boards/beagleplay/demos-and-tutorials/using-mikrobus.html>`_.
Let's get started!
-*************************
+********************
First, we want to make sure the mikroBUSâ„¢ add-on board is connected and functioning as expected.
To do this, we make use of the `iio_info command <https://man.archlinux.org/man/iio_info.1.en>`_.
Connecting mikroBUSâ„¢ add-on board
-================================
+==================================
-``iio_info`` is a utility for displaying information about local or remote IIO devices, in this case it's the `Accel click board <https://www.mikroe.com/accel-click>`_.
+``iio_info`` is a utility for displaying information about local or remote IIO devices, in
+this case it's the `Accel click board <https://www.mikroe.com/accel-click>`_.
.. figure:: ./iio_info_out.png
:width: 1040
:align: center
+ iio_info command output
+
Accessing Node-RED
-=====================
+====================
Once your BeaglePlay is booted up and connected to your computer, access it from your browser by typing
``192.168.7.2:1880`` in your address bar. Learn more about remote browser in :ref:`start-browse-to-beagle`.
@@ -80,6 +84,7 @@ with timestamps.
:width: 1040
:align: center
+ Node-RED debug logs
Adding a Gauge
==============
@@ -88,19 +93,25 @@ Adding a Gauge
:width: 1040
:align: center
+ Node-RED base flow
+
.. figure:: ./nodered-base-flow-output.png
:width: 400
:align: center
+ Node-RED base flow output
Adding a Graph and 3 Axis
=========================
.. todo::
- * Add flow diagram
- * Show the output
+
+ * Add flow diagram
+ * * Show the output
.. figure:: ./nodered-complete-gauges-flow.png
:width: 1040
:align: center
+ Node-RED complete gauges flow
+
diff --git a/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst b/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst
index 08c8bd56d9465df7678a00994625db92c9def192..5f0123a26aea4c7084baef7f287bd28971f575d3 100644
--- a/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst
+++ b/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst
@@ -14,11 +14,11 @@ to FPGA and ``sdcard.image`` to eMMC storage.
.. important::
- Additional hardware required:
+ Additional hardware required:
- 1. FlashPro5/6 programmer
- 2. `Tag connect TC2050-IDC-NL 10-Pin No-Legs Cable with Ribbon connector <https://www.tag-connect.com/product/tc2050-idc-nl-10-pin-no-legs-cable-with-ribbon-connector>`_
- 3. `TC2050-CLIP-3PACK Retaining CLIP board for TC2050-NL cables <https://www.tag-connect.com/product/tc2050-clip-3pack-retaining-clip>`_
+ 1. FlashPro5/6 programmer
+ 2. `Tag connect TC2050-IDC-NL 10-Pin No-Legs Cable with Ribbon connector <https://www.tag-connect.com/product/tc2050-idc-nl-10-pin-no-legs-cable-with-ribbon-connector>`_
+ 3. `TC2050-CLIP-3PACK Retaining CLIP board for TC2050-NL cables <https://www.tag-connect.com/product/tc2050-clip-3pack-retaining-clip>`_
Programming & Debug tools installation
***************************************
@@ -36,18 +36,18 @@ which we are going to use for this tutorial. Below are the steps to install the
.. code-block:: bash
- [lorforlinux@fedora Program_Debug_v2023.1_lin] $ ./launch_installer.sh
+ [lorforlinux@fedora Program_Debug_v2023.1_lin] $ ./launch_installer.sh
- No additional packages to install for installer usage
+ No additional packages to install for installer usage
- Requirement search complete.
+ Requirement search complete.
- See /tmp/check_req_installer608695.log for information.
+ See /tmp/check_req_installer608695.log for information.
- Launch of installer
- Preparing to install
- Extracting the JRE from the installer archive...
- Unpacking the JRE...
+ Launch of installer
+ Preparing to install
+ Extracting the JRE from the installer archive...
+ Unpacking the JRE...
.. note:: It's recommended to install under `home/user/microchip` for linux users.
@@ -75,14 +75,17 @@ Create new project
===================
.. important::
- Make sure you have your FlashPro5/6 connected before you create a new project.
+
+ Make sure you have your FlashPro5/6 connected before you create a new project.
Press ``CTRL+N`` to create a file and you will see a pop-up window like shown below,
-.. image:: ../images/FPExpress-new-project.png
- :width: 598
- :align: center
- :alt: FPExpress new project creation window
+.. figure:: ../images/FPExpress-new-project.png
+ :width: 598
+ :align: center
+ :alt: FPExpress new project creation window
+
+ FPExpress new project creation window
Follow the steps below as annotated in the image above:
@@ -93,9 +96,11 @@ Follow the steps below as annotated in the image above:
If your FlashPro5/6 is connected properly you'll see the window shown below:
.. figure:: ../images/FPExpress-flashing.png
- :width: 1240
- :align: center
- :alt: FPExpress new project flash window
+ :width: 1240
+ :align: center
+ :alt: FPExpress new project flash window
+
+ FPExpress new project flash window
Following the annotation in the image above:
@@ -113,19 +118,23 @@ Flashing eMMC
Connect to BeagleV-Fire UART debug port using a 3.3v USB to UART bridge.
.. figure:: ../images/debug/BeagleV-Fire-UART-Debug.*
- :width: 1240
- :align: center
- :alt: UART debug connection
+ :width: 1240
+ :align: center
+ :alt: UART debug connection
+
+ UART debug connection
-Now you can run ``tio <port>`` in a terminal window to access
+Now you can run ``tio <port> -b 115200`` in a terminal window to access
the UART debug port connection. Once you are connected properly you can
press the Reset button which will show you a progress bar like
in the
.. figure:: ../images/board-booting.png
- :width: 740
- :align: center
- :alt: BeagleV-Fire booting HSS with progress bar
+ :width: 740
+ :align: center
+ :alt: BeagleV-Fire booting HSS with progress bar
+
+ BeagleV-Fire booting HSS with progress bar
Once you see that progress bar on your screen you can start pressing any
button (0-9/a-z) which will stop the board from fully booting and you'll be
@@ -134,9 +143,11 @@ written by the Hart Software Services (HSS) using the ``usbdmsc`` command. The
HSS ``usbdmsc`` command exposes the eMMC as a USB mass storage device USB type C connector.
.. figure:: ../images/boot-message.png
- :width: 1240
- :align: center
- :alt: BeagleV-Fire boot messages with HSS prompt access
+ :width: 1240
+ :align: center
+ :alt: BeagleV-Fire boot messages with HSS prompt access
+
+ BeagleV-Fire boot messages with HSS prompt access
Once you see ``>>`` you can execute the commands below:
@@ -144,52 +155,82 @@ Once you see ``>>`` you can execute the commands below:
2. ``>> usbdmsc``
.. figure:: ../images/HSS-eMMC-mass-storage.png
- :width: 1240
- :align: center
- :alt: HSS commands to show eMMC as mass storage
+ :width: 1240
+ :align: center
+ :alt: HSS commands to show eMMC as mass storage
+
+ HSS commands to show eMMC as mass storage
After executing the commands above your BeagleV-Fire's eMMC will be
exposed as a mass storage device like shown in the image below:
.. figure:: ../images/mass-storage-eMMC.png
- :width: 740
- :align: center
- :alt: BeagleV-Fire eMMC as mass storage
+ :width: 740
+ :align: center
+ :alt: BeagleV-Fire eMMC as mass storage
-Once your board is exposed as a mass storage device you can use
-`Balena Etcher <https://etcher.balena.io/#download-etcher>`_ to
-flash the ``sdcard.img`` on your BeagleV-Fire's eMMC.
+ BeagleV-Fire eMMC as mass storage
-.. tab-set::
+Once your board is exposed as a mass storage device, you can proceed to flash the ``sdcard.img`` on
+your BeagleV-Fire's eMMC.
+
+This document outlines two methods to flash from your local machine to BeagleV Fire's eMMC.
- .. tab-item:: Select image
+1. First method is to use `Balena Etcher <https://etcher.balena.io/#download-etcher>`_ software.
+This software can be used to flash image in either Windows or Linux operating system.
+
+.. tab-set::
- 1. Select the ``sdcard.img`` file from your local drive storage.
- 2. Click on select target.
+ .. tab-item:: Select image
+
+ 1. Select the ``sdcard.img`` file from your local drive storage.
+ 2. Click on select target.
.. figure:: ../images/eMMC-flashing-1.png
- :width: 740
- :align: center
- :alt: Balena Etcher selecting image
+ :width: 740
+ :align: center
+ :alt: Balena Etcher selecting image
- .. tab-item:: Select Target
+ Balena Etcher selecting image
- 1. Select ``MCC PolarFireSoC_msd`` as target.
- 2. Click ``Select(1)`` to proceed.
+ .. tab-item:: Select Target
+
+ 1. Select ``MCC PolarFireSoC_msd`` as target.
+ 2. Click ``Select(1)`` to proceed.
.. figure:: ../images/eMMC-flashing-2.png
- :width: 740
- :align: center
- :alt: Balena Etcher selecting target
+ :width: 740
+ :align: center
+ :alt: Balena Etcher selecting target
+
+ Balena Etcher selecting target
- .. tab-item:: Flash image
+ .. tab-item:: Flash image
- 1. Click on ``Flash!`` to flash the ``sdcard.img`` on BeagleV-Fire eMMC storage.
+ 1. Click on ``Flash!`` to flash the ``sdcard.img`` on BeagleV-Fire eMMC storage.
.. figure:: ../images/eMMC-flashing-3.png
- :width: 740
- :align: center
- :alt: Balena Etcher flashing image
+ :width: 740
+ :align: center
+ :alt: Balena Etcher flashing image
+
+ Balena Etcher flashing image
+
+2. Second method is suitable for flashing the image using Linux machine via the command line.
+
+.. code:: console
+
+ sudo dd if=output/images/sdcard.img of=/dev/sdX bs=1M status=progress
+
+.. note::
+
+ You need to replace /dev/sdX with the actual device name of your eMMC.
+ Use tools like dmesg, lsblk, or GNOME Disks before and after exposing your
+ device as a USB to identify the correct device name.
+ Be very careful not to overwrite the wrong drive, as this action is irreversible.
+
+- Once the transfer is complete, type ``CTRL+C`` to disconnect your device
+- Finally boot the new Linux image by typing ``boot`` or reset your board
Congratulations! with that done you have fully updated BeagleV-Fire board
with up to date gateware image on it's PolarFire SoC's FPGA