diff --git a/boards/beagley/ai/demos/beagley-ai-using-gpio.rst b/boards/beagley/ai/demos/beagley-ai-using-gpio.rst
index 9050d1ac8ff577d4765fee6ff018d72055cde0e2..a672467d4f07527ce2c220a8ae30c501986185a6 100644
--- a/boards/beagley/ai/demos/beagley-ai-using-gpio.rst
+++ b/boards/beagley/ai/demos/beagley-ai-using-gpio.rst
@@ -61,46 +61,56 @@ Before using any pin with HAT pin number we need to configure it using command b
sudo beagle-pin-mux --pin hat-08 --mode gpio
+.. figure:: ../images/gpio/led-pin8.*
+ :align: center
+ :alt: LED connected to HAT pin8
+
+ LED connected to HAT pin8
+
At it's most basic, we can set a GPIO using the **gpioset** command.
-To set HAT **Pin 8** to **ON**:
+- To set HAT **Pin 8** to **ON**:
.. code:: console
gpioset hat-08-gpio 0=1
-.. image:: ../images/gpio/on.png
- :width: 50 %
+.. figure:: ../images/gpio/on.png
:align: center
+ :alt: GPIO ON state
+
+ GPIO ON state
-To set HAT **Pin 8** to **OFF**:
+- To set HAT **Pin 8** to **OFF**:
.. code:: console
gpioset hat-08-gpio 0=0
-.. image:: ../images/gpio/off.png
- :width: 50 %
+.. figure:: ../images/gpio/off.png
:align: center
+ :alt: GPIO OFF state
+
+ GPIO OFF state
Blink an LED
**************
-Let's write a script called **blinky.sh** that contains the following:
+Let's create a script called **blinky.sh**,
-Create the file,
+- Create the file,
.. code:: console
touch blinky.sh
-Open the file using ``nano`` editor,
+- Open the file using ``nano`` editor,
.. code:: console
nano blinky.sh
-Copy paste the code below to ``blinky.sh`` file,
+- Copy paste the code below to ``blinky.sh`` file,
.. code:: bash
@@ -114,17 +124,21 @@ Copy paste the code below to ``blinky.sh`` file,
sleep 1
done
-Now execute it by typing:
+- Close the editor by pressing ``Ctrl + O`` followed by ``Enter`` to save the file and then press to ``Ctrl + X`` exit
+
+- Now execute the ``blinky.sh`` script by typing:
.. code:: console
bash blinky.sh
.. image:: ../images/gpio/blinky.gif
- :width: 50 %
:align: center
+ :alt: LED blinking
+
+ LED blinking
-You can exit the ``blinky.sh`` progrm by pressing ``CTRL + C`` on your keyboard.
+- You can exit the ``blinky.sh`` progrm by pressing ``CTRL + C`` on your keyboard.
Understanding the code
======================
@@ -155,32 +169,53 @@ Understanding the code
<4> Wait 1 Second
-GPIO Read
-**********
+Read a Button
+**************
-Reading GPIOs can be done using the ``gpioget`` command
+A push button simply completes an electric circuit when pressed. Depending on wiring, it can drive a signal either "Low" (GND) or "High" (3.3V).
-.. code:: console
+We will connect our Button between HAT Pin 12 (GPIO18) and Ground (GND).
- gpioget hat-08-gpio 0
-
-Results in **1** if the Input is held **HIGH** or **0** if the Input is held **LOW**
+.. figure:: ../images/gpio/switch-pin12.*
+ :align: center
+ :alt: Button connected to HAT pin12
-Read a Button
-**************
+ Button connected to HAT pin12
+
+- Configure pin12 as ``gpio`` using command below,
-A push button simply completes an electric circuit when pressed. Depending on wiring, it can drive a signal either "Low" (GND) or "High" (3.3V)
+.. code:: console
-We will connect our Button between HAT Pin 16 (GPIO23) and Ground (GND).
+ sudo beagle-pin-mux --pin hat-12 --mode gpio-pu
The cool part is since we have an internal pull-up resistor, we don't need an external one!
The pull resistor guarantees that the Pin stays in a known (HIGH) state unless the button is pressed,
in which case it will go LOW.
-.. todo:: Add fritzing diagram here
+- Reading GPIOs can be done using the ``gpioget`` command
+
+.. code:: console
+
+ gpioget hat-12-gpio-pu 0
+
+Results in ``1`` if the Input is held ``HIGH`` or ``0`` if the Input is held ``LOW``
+
+Let's create a script called ``button.sh`` to continuously read an input pin connected
+to a button and print out when it's pressed!
+
+- Create the file,
+
+.. code:: console
+
+ touch button.sh
-Let's write a script called **button.sh** to continuously read an input pin connected
-to a button and print out when it's pressed! :
+- Open the file using ``nano`` editor,
+
+.. code:: console
+
+ nano button.sh
+
+- Copy paste the code below to ``button.sh`` file,
.. code:: bash
@@ -188,18 +223,48 @@ to a button and print out when it's pressed! :
while :
do
- if (( $(gpioget hat-12-gpio 0) == 0))
+ if (( $(gpioget hat-12-gpio-pu 0) == 0))
then
echo "Button Pressed!"
fi
done
+- Close the editor by pressing ``Ctrl + O`` followed by ``Enter`` to save the file and then press to ``Ctrl + X`` exit
+
+- Now execute the ``button.sh`` script by typing:
+
+.. code:: console
+
+ bash button.sh
+
+- You can exit the ``button.sh`` by pressing ``Ctrl + C`` on your keyboard.
+
Combining the Two
**********************
+.. figure:: ../images/gpio/switch-pin12-led-pin8.*
+ :align: center
+ :alt: Button connected to HAT pin12 & LED connected to HAT pin8
+
+ Button connected to HAT pin12 & LED connected to HAT pin8
+
Now, logically, let's make an LED match the state of the button.
-Let's modify our script and call it **blinkyButton.sh**:
+Let's create a script called **blinkyButton.sh**:
+
+- Create the file,
+
+.. code:: console
+
+ touch blinkyButton.sh
+
+- Open the file using ``nano`` editor,
+
+.. code:: console
+
+ nano blinkyButton.sh
+
+- Copy paste the code below to ``blinkyButton.sh`` file,
.. code:: bash
@@ -207,7 +272,7 @@ Let's modify our script and call it **blinkyButton.sh**:
while :
do
- if (( $(gpioget hat-12-gpio 0) == 0))
+ if (( $(gpioget hat-12-gpio-pu 0) == 0))
then
gpioset hat-08-gpio 0=1
else
@@ -215,20 +280,24 @@ Let's modify our script and call it **blinkyButton.sh**:
fi
done
-This means when we see HAT Pin 12 go LOW, we know the button is pressed, so we set HAT Pin 8 (our LED) to ON, otherwise, we turn it OFF.
+- Close the editor by pressing ``Ctrl + O`` followed by ``Enter`` to save the file and then press to ``Ctrl + X`` exit
-Now execute it by typing:
+- Now execute the ``blinkyButton.sh`` script by typing:
.. code:: console
- bash blinkyButton.sh.sh
+ bash blinkyButton.sh
+
+This means when we see HAT Pin 12 go LOW, we know the button is pressed,
+so we set HAT Pin 8 (our LED) to ON, otherwise, we turn it OFF.
-.. image:: ../images/gpio/BlinkyButton.gif
- :width: 50 %
+.. figure:: ../images/gpio/BlinkyButton.gif
:align: center
+ :alt: LED is ON when button is pressed
-You can exit by pressing **Ctrl + c** on your keyboard.
+ LED is ON when button is pressed
+- You can exit the ``blinkyButton.sh`` program by pressing ``Ctrl + C`` on your keyboard.
Understanding Internal Pull Resistors
*******************************************
@@ -270,7 +339,7 @@ This article from SparkFun Electronics is a good basic primer - `Link <https://l
Troubleshooting
*******************
-* **My script won't run!**
+- **My script won't run!**
Make sure you gave the script execute permissions first and that you're executing it with a **./** before
@@ -290,17 +359,19 @@ To run it:
Bonus - Turn all GPIOs ON/OFF
*******************************
-.. image:: ../images/gpio/allonoff.gif
- :width: 50 %
+.. figure:: ../images/gpio/allonoff.gif
:align: center
+ :alt: All HAT GPIO toggle
+
+ All HAT GPIO toggle
-Copy and paste this with the button on the right to turn **all pins ON**.
+- Copy and paste this with the button on the right to turn **all pins ON**.
.. code:: bash
gpioset hat-03-gpio 0=1 ;\ gpioset hat-05-gpio 0=1 ;\ gpioset hat-08-gpio 0=1 ;\ gpioset hat-10-gpio 0=1 ;\ gpioset hat-11-gpio 0=1 ;\ gpioset hat-12-gpio 0=1 ;\ gpioset hat-13-gpio 0=1 ;\ gpioset hat-15-gpio 0=1 ;\ gpioset hat-16-gpio 0=1 ;\ gpioset hat-18-gpio 0=1 ;\ gpioset hat-19-gpio 0=1 ;\ gpioset hat-21-gpio 0=1 ;\ gpioset hat-22-gpio 0=1 ;\ gpioset hat-23-gpio 0=1 ;\ gpioset hat-24-gpio 0=1 ;\ gpioset hat-26-gpio 0=1 ;\ gpioset hat-29-gpio 0=1 ;\ gpioset hat-31-gpio 0=1 ;\ gpioset hat-32-gpio 0=1 ;\ gpioset hat-33-gpio 0=1 ;\ gpioset hat-35-gpio 0=1 ;\ gpioset hat-36-gpio 0=1 ;\ gpioset hat-37-gpio 0=1 ;\ gpioset hat-40-gpio 0=1
-Similarly, copy and paste this to turn **all pins OFF**.
+- Similarly, copy and paste this to turn **all pins OFF**.
.. code:: bash
diff --git a/boards/beagley/ai/demos/beagley-ai-using-pwm.rst b/boards/beagley/ai/demos/beagley-ai-using-pwm.rst
index b0d23f3a917acc41c84c9b154781c1bfd6f041e7..0411d2f19a9367a768613c187f55cd8208710634 100644
--- a/boards/beagley/ai/demos/beagley-ai-using-pwm.rst
+++ b/boards/beagley/ai/demos/beagley-ai-using-pwm.rst
@@ -68,15 +68,21 @@ In the editor copy paste the script content below,
echo $i
sleep 0.0005
done
+- Close the editor by pressing ``Ctrl + O`` followed by ``Enter`` to save the file and then press to ``Ctrl + X`` exit
-Now execute it by typing:
+- Now execute the ``fade.sh`` script by typing:
.. code:: console
bash fade.sh
-.. image:: ../images/gpio/pwm.gif
+.. figure:: ../images/gpio/pwm.gif
:align: center
+ :alt: LED PWM fade demo
+
+ LED PWM fade demo
+
+- You can exit the ``fade.sh`` program by pressing ``Ctrl + C`` on your keyboard.
.. todo:: Add section about driving Servo Motors at 50KHz
diff --git a/boards/beagley/ai/images/gpio/led-pin8.png b/boards/beagley/ai/images/gpio/led-pin8.png
new file mode 100644
index 0000000000000000000000000000000000000000..fd4d125ab811cf348d9a2f7eac09d04777c4ee8a
Binary files /dev/null and b/boards/beagley/ai/images/gpio/led-pin8.png differ
diff --git a/boards/beagley/ai/images/gpio/switch-pin12-led-pin8.png b/boards/beagley/ai/images/gpio/switch-pin12-led-pin8.png
new file mode 100644
index 0000000000000000000000000000000000000000..a2565b0f74e7e30b6015ce2f579a8f85cba63fe6
Binary files /dev/null and b/boards/beagley/ai/images/gpio/switch-pin12-led-pin8.png differ
diff --git a/boards/beagley/ai/images/gpio/switch-pin12.png b/boards/beagley/ai/images/gpio/switch-pin12.png
new file mode 100644
index 0000000000000000000000000000000000000000..a5e71e2fc4b32213b654aaad462a0185c52c1e31
Binary files /dev/null and b/boards/beagley/ai/images/gpio/switch-pin12.png differ