From 76d9f578fe7d8cb9d534d6118e40b972e9981b00 Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Thu, 15 Sep 2022 01:50:11 -0400
Subject: [PATCH] beagleconnect: rst cleanups
---
boards/beagleconnect/freedom/index.rst | 8 ++++---
boards/beagleconnect/freedom/zephyr.rst | 28 +++++++++++++++----------
2 files changed, 22 insertions(+), 14 deletions(-)
diff --git a/boards/beagleconnect/freedom/index.rst b/boards/beagleconnect/freedom/index.rst
index 48115ae3..eff3a119 100644
--- a/boards/beagleconnect/freedom/index.rst
+++ b/boards/beagleconnect/freedom/index.rst
@@ -1,3 +1,5 @@
+.. _beagleconnect_freedom_home:
+
BeagleConnect Freedom
######################
@@ -29,12 +31,12 @@ devices within the first year after the initial release.
BeagleConnectâ„¢ Freedom
**********************
-BeagleConnectâ„¢ Freedom is based on the `TI CC1352 <https://www.ti.com/product/CC1352P7>`_
+BeagleConnectâ„¢ Freedom is based on a `TI Arm Cortex-M4 wireless-enabled microcontroller <https://www.ti.com/product/CC1352P7>`_
and is the first available BeagleConnectâ„¢ solution. It implements:
* BeagleConnectâ„¢ gateway device function for Sub-GHz 802.15.4 long-range
wireless
-* BeagleConnectâ„¢ node device function for Bluetooth Low-Energe (BLE) and
+* BeagleConnectâ„¢ node device function for Bluetooth Low-Energy (BLE) and
Sub-GHz 802.15.4 long range wireless
* USB-based serial console and firmware updates
* 2x `mikroBUS sockets <https://www.mikroe.com/mikrobus>`_ with BeagleConnectâ„¢
@@ -125,7 +127,7 @@ Long-range, low-power wireless
==============================
BeagleConnectâ„¢ Freedom wireless hardware is built around a
-`TI CC1352 <http://www.ti.com/product/CC1352P7>`_ multiprotocol and multi-band
+`TI CC1352P7 <http://www.ti.com/product/CC1352P7>`_ multiprotocol and multi-band
Sub-1 GHz and 2.4-GHz wireless microcontroller (MCU). CC1352P7 includes a 48-MHz
Arm® Cortex®-M4F processor, 704KB Flash, 256KB ROM, 8KB Cache SRAM, 144KB of
ultra-low leakage SRAM, and `Over-the-Air <https://en.wikipedia.org/wiki/Over-the-air_programming>`_
diff --git a/boards/beagleconnect/freedom/zephyr.rst b/boards/beagleconnect/freedom/zephyr.rst
index f08d7e4a..cce85a1a 100644
--- a/boards/beagleconnect/freedom/zephyr.rst
+++ b/boards/beagleconnect/freedom/zephyr.rst
@@ -86,7 +86,6 @@ computer can be used to connect to your BeagleBone Green Gateway.
* To connect you can simply type :code:`$ ssh debian@192.168.7.2` and when
asked for password just type :code:`temppwd`
* Congratulations, You are now connected to the device!
-
#. Connect to the `WiFi <https://forum.beagleboard.org/t/debian-11-x-bullseye-monthly-snapshots/31280>`_
* Execute :code:`sudo nano /etc/wpa_supplicant/wpa_supplicant-wlan0.conf`
and provide the password :code:`temppwd` to edit the configuration file
@@ -94,7 +93,8 @@ computer can be used to connect to your BeagleBone Green Gateway.
* Now edit the file (shown below) under the :code:`network={...}`
section you can set you :code:`ssid` (WiFi name) and :code:`psk` (Wifi
Password).
- .. code-block::
+
+ .. code-block::
ctrl_interface=DIR=/run/wpa_supplicant GROUP=netdev
update_config=1
@@ -103,10 +103,12 @@ computer can be used to connect to your BeagleBone Green Gateway.
ssid="WiFi Name"
psk="WiFi Password"
}
+
* Now save the file with :code:`CTRL+O` and exit with :code:`CTRL+X`.
* Check if the connection is established by executing :code:`$ ping 8.8.8.8`
you should see something like shown below.
- .. code-block:: bash
+
+ .. code-block:: bash
debian@BeagleBone:~$ ping 8.8.8.8
PING 8.8.8.8 (8.8.8.8) 56(84) bytes of data.
@@ -115,16 +117,21 @@ computer can be used to connect to your BeagleBone Green Gateway.
64 bytes from 8.8.8.8: icmp_seq=3 ttl=118 time=6.13 ms
64 bytes from 8.8.8.8: icmp_seq=4 ttl=118 time=6.11 ms
...
+
* If everything goes well, you are ready to update your system and install
new applications for beagleconnect.
-Note: If you are facing some issue during boot then you can try debugging the
-boot session with a USB to serial interface cable such as those made by FTDI
-plugged into J10 with the black wire of the FTDI cable toward the Ethernet
-connector. Application like tio/minicom/putty can be used to make the connection
-establishment procedure easy.
+.. note:
-TODO: Simplify and elaborate on this section, add boot session debugging walkthrough
+ If you are facing some issue during boot then you can try debugging the
+ boot session with a USB to serial interface cable such as those made by FTDI
+ plugged into J10 with the black wire of the FTDI cable toward the Ethernet
+ connector. Application like tio/minicom/putty can be used to make the connection
+ establishment procedure easy.
+
+.. note:
+
+ #TODO#: Simplify and elaborate on this section, add boot session debugging walkthrough
Install Zephyr development tools on BeagleBone Green Gateway
============================================================
@@ -199,9 +206,8 @@ Now you can build various Zephyr applications
#. Build blinky example
.. code-block:: bash
- west build -d build/blinky zephyr/samples/basic/blinky
-
+ west build -d build/blinky zephyr/samples/basic/blinky
#. TODO
.. code-block:: bash
--
GitLab