diff --git a/boards/beagleconnect/freedom/ch1-introduction.rst b/boards/beagleconnect/freedom/01-introduction.rst similarity index 91% rename from boards/beagleconnect/freedom/ch1-introduction.rst rename to boards/beagleconnect/freedom/01-introduction.rst index 1b9c59301f8b661f5e59656c79d7d72678568f0d..7962214218715a2d5e3934b36c74c63b3b515c0b 100644 --- a/boards/beagleconnect/freedom/ch1-introduction.rst +++ b/boards/beagleconnect/freedom/01-introduction.rst @@ -9,26 +9,21 @@ What is BeagleConnect™ Freedom? 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-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™ protocol support. -.. image:: media/BeagleConnect-Freedom-C5-HandPhoto.jpg +.. image:: media/beagleconnect_freedom_annotated.webp :width: 600 :align: center :height: 400 - :alt: BeagleConnect-Freedom-C5-HandPhoto - -.. important:: - BeagleConnect™ Freedom enables wirelessly adding new device nodes and is targeted to cost initially - around US$20 with a roadmap to variants as low as US$1. + :alt: BeagleConnect Freedom Annotated What makes BeagleConnect™ new and different? -============================================== +********************************************** Plug & Play approach --------------------- +==================== BeagleConnect™ uses the collaboratively developed Linux kernel to contain the intelligence required to speak to these devices (sensors, actuators, and @@ -58,7 +53,7 @@ exist, no new specialized code needs to be created for the devices. under a `highly-regarded governance model <https://wiki.p2pfoundation.net/Linux_-_Governance>`_. Reliable software update mechanism ------------------------------------ +======================================= Because there isn't code specific to any given network-of-devices configuration , we can all leverage the same software code base. This means that when someone @@ -73,7 +68,7 @@ discovering and resolving bugs is high. Rapid prototyping without wiring ---------------------------------- +======================================= BeagleConnect™ utilizes the `mikroBUS standard <https://elinux.org/Mikrobus>`_. The mikroBUS standard interface is flexible enough for almost any typical @@ -87,7 +82,7 @@ available Click mikroBUS add-on boards will be supported as well as the hundreds of compliant boards developed every year. Long-range, low-power wireless -------------------------------- +======================================= BeagleConnect™ Freedom wireless hardware is built around a `TI CC1352P7 <http://www.ti.com/product/CC1352P7>`_ multiprotocol and multi-band @@ -97,7 +92,7 @@ ultra-low leakage SRAM, and `Over-the-Air <https://en.wikipedia.org/wiki/Over-th upgrades (OTA). Fully customizable design --------------------------- +======================================= BeagleConnect™ utilizes `open source hardware <https://www.oshwa.org/definition/>`_ and `open source software <https://en.wikipedia.org/wiki/Open-source_software>`_, diff --git a/boards/beagleconnect/freedom/02-quick-start.rst b/boards/beagleconnect/freedom/02-quick-start.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ac2ed60a62bd503899c576387ec79a7596c7759 --- /dev/null +++ b/boards/beagleconnect/freedom/02-quick-start.rst @@ -0,0 +1,12 @@ +.. _beagleconnect-freedom-quick-start: + +Quick Start Guide +#################### + + +.. toctree:: + :maxdepth: 1 + + demos-and-tutorials/using-zephyr + demos-and-tutorials/using-micropython + demos-and-tutorials/using-greybus diff --git a/boards/beagleconnect/freedom/03-design.rst b/boards/beagleconnect/freedom/03-design.rst new file mode 100644 index 0000000000000000000000000000000000000000..d513e1df2094fbc3a3f2f15245701b51fe1a1af2 --- /dev/null +++ b/boards/beagleconnect/freedom/03-design.rst @@ -0,0 +1,19 @@ +.. _beagleconnect-freedom-design: + +Design +###### + +.. _beagleconnect-freedom-detailed-overview: + +Detailed overview +================= + +.. _beagleconnect-freedom-detailed-hardware-design: + +Detailed hardware design +========================= + +.. _beagleconnect-freedom-mechanical: + +Mechanical +=========== diff --git a/boards/beagleconnect/freedom/04-expansion.rst b/boards/beagleconnect/freedom/04-expansion.rst new file mode 100644 index 0000000000000000000000000000000000000000..452bdc1504c74b6acab43235f24edce74ca4fcf2 --- /dev/null +++ b/boards/beagleconnect/freedom/04-expansion.rst @@ -0,0 +1,4 @@ +.. _beagleconnect-freedom-expansion: + +Connectors +########### diff --git a/boards/beagleconnect/freedom/ch2-change-history.rst b/boards/beagleconnect/freedom/05-support.rst similarity index 77% rename from boards/beagleconnect/freedom/ch2-change-history.rst rename to boards/beagleconnect/freedom/05-support.rst index 419058197214fd8f0ea4e1399ea759fd4c0c16c9..5b565987d4e5b50d2f62fff47ec330637f91d9e1 100644 --- a/boards/beagleconnect/freedom/ch2-change-history.rst +++ b/boards/beagleconnect/freedom/05-support.rst @@ -1,7 +1,12 @@ +.. _beagleconnect-freedom-support: + +Support +######## + .. _beagleconnect-freedom-change-history: Change History -############### +=============== .. note:: This section describes the change history of this document and board. @@ -17,3 +22,8 @@ Document Changes Board Changes ************** + +.. _beagleconnect-freedom-pictures: + +Pictures +========= diff --git a/boards/beagleconnect/freedom/ch10-pictures.rst b/boards/beagleconnect/freedom/ch10-pictures.rst deleted file mode 100644 index 216bb02cdf56b6207de69e46792055076caf3907..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch10-pictures.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-pictures: - -Pictures -######### \ No newline at end of file diff --git a/boards/beagleconnect/freedom/ch4-detailed-overview.rst b/boards/beagleconnect/freedom/ch4-detailed-overview.rst deleted file mode 100644 index b82b95d7ab57c5269b507aaef316d9e4b44b39ba..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch4-detailed-overview.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-detailed-overview: - -Detailed overview -################## \ No newline at end of file diff --git a/boards/beagleconnect/freedom/ch5-high-level-specifications.rst b/boards/beagleconnect/freedom/ch5-high-level-specifications.rst deleted file mode 100644 index c45f88504f795f9ef769f3ffeca27545d326729f..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch5-high-level-specifications.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-high-level-specifications: - -High-level specification -######################### \ No newline at end of file diff --git a/boards/beagleconnect/freedom/ch6-detailed-hardware-design.rst b/boards/beagleconnect/freedom/ch6-detailed-hardware-design.rst deleted file mode 100644 index 813bf4363b3cd4edaca0e4cd87047b3c4b1ea259..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch6-detailed-hardware-design.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-detailed-hardware-design: - -Detailed hardware design -######################### \ No newline at end of file diff --git a/boards/beagleconnect/freedom/ch7-connectors.rst b/boards/beagleconnect/freedom/ch7-connectors.rst deleted file mode 100644 index 1a49d0002c98d8b5ebef27c561abdc293467fb8f..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch7-connectors.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-connectors: - -Connectors -########### \ No newline at end of file diff --git a/boards/beagleconnect/freedom/ch8-support.rst b/boards/beagleconnect/freedom/ch8-support.rst deleted file mode 100644 index 627178df7d5e12d6eca884540cd0109667767193..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch8-support.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-support: - -Support -######## diff --git a/boards/beagleconnect/freedom/ch9-mechanical.rst b/boards/beagleconnect/freedom/ch9-mechanical.rst deleted file mode 100644 index 2813efa4b3d8f457fdf745bc26cd0978ffaa9eaa..0000000000000000000000000000000000000000 --- a/boards/beagleconnect/freedom/ch9-mechanical.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _beagleconnect-freedom-mechanical: - -Mechanical -########### \ No newline at end of file diff --git a/boards/beagleconnect/freedom/demos-and-tutorials/using-greybus.rst b/boards/beagleconnect/freedom/demos-and-tutorials/using-greybus.rst new file mode 100644 index 0000000000000000000000000000000000000000..ba84e04c86a9f2e9e9168023127a8b0695a3665e --- /dev/null +++ b/boards/beagleconnect/freedom/demos-and-tutorials/using-greybus.rst @@ -0,0 +1,133 @@ +.. _beagleconnect-freedom-using-greybus: + +Using BeagleConnect Greybus +########################### + +This section describes the usage model we are developing. To use the current +code in development, please refer to the [development] section. + +BeagleConnect wireless user experience +*************************************** + +Enable a Linux host with BeagleConnect +======================================= +.. image:: media/ProvStep1.jpg + :width: 600 + :align: center + :height: 400 + :alt: ProvStep1 + +Log into a host system running Linux that is BeagleConnect™ enabled. Enable a +Linux host with BeagleConnect™ by plugging a **BeagleConnect™ gateway device** +into its USB port. You’ll also want to have a **BeagleConnect™ node device** +with a sensor, actuator or indicator device connected. + +.. note:: + BeagleConnect™ Freedom can act as either a BeagleConnect™ gateway device + or a BeagleConnect™ node device. + +.. important:: + The Linux host will need to run the BeagleConnect™ management + software, most of which is incorporated into the Linux kernel. Support will be + provided for BeagleBoard and BeagleBone boards, x86 hosts, and Raspberry Pi. + +#TODO#: Clean up images + +Connect host and device +======================= + +.. image:: media/ProvStep2.jpg + :width: 600 + :align: center + :height: 400 + :alt: ProvStep2 + +Initiate a connection between the host and devices by pressing the discovery +button(s). + +Device data shows up as files +============================= + +.. image:: media/ProvStep3.jpg + :width: 600 + :align: center + :height: 400 + :alt: ProvStep3 + +New streams of self-describing data show up on the host system using native +device drivers. + +High-level applications, like Node-RED, can directly read/write these +high-level data streams (including data-type information) to Internet-based +`MQTT <https://mqtt.org/>`_ brokers, live dashboards, or other logical +operations without requiring any sensor-specific coding. Business logic can be +applied using simple if-this-then-that style operations or be made as complex +as desired using virtually any programming language or environment. + +Components +********** + +BeagleConnect™ enabled host Linux computer, possibly single-board computer +(SBC), with BeagleConnect™ management software and BeagleConnect™ gateway +function. BeagleConnect™ gateway function can be provided by a BeagleConnect™ +compatible interface or by connecting a BeagleConnect™ **gateway** device over USB. + +.. note:: + If the Linux host has BLE, the BeagleConnect™ **gateway** is optional for short + distances + +BeagleConnect™ Freedom Board, case, and wireless MCU with Zephyr based firmware +for acting as either a BeagleConnect™ gateway device or BeagleConnect™ node +device. + +* In BeagleConnect™ **gateway** device mode: Provides long-range, low-power + wireless communications, Connects with the host via USB and an associated + Linux kernel driver, and is powered by the USB connector. +* In BeagleConnect™ **node** device mode: Powered by a battery or USB connector + Provides 2 mikroBUS connectors for connecting any of hundreds of `Click Board <https://bbb.io/click>`_ + mikroBUS add-on devices Provides new Linux host controllers for SPI, I2C, + UART, PWM, ADC, and GPIO with interrupts via Greybus + +BeagleConnect **gateway** device +================================== + +Provides a BeagleConnect™ compatible interface to a host. This could be a +built-in interface device or one connected over USB. BeagleConnect™ Freedom can +provide this function. + +BeagleConnect **node** device +============================== + +Utilizes a BeagleConnect™ compatible interface and TODO + +BeagleConnect compatible interface +================================== + +Immediate plans are to support Bluetooth Low Energy (BLE), 2.4GHz IEEE 802.15.4, and Sub-GHz IEEE 802.15.4 wireless interfaces. A built-in BLE interface is +suitable for this at short range, whereas IEEE 802.15.4 is typically +significantly better at long ranges. Other wired interfaces, such as CAN and +RS-485, are being considered for future BeagleConnect™ gateway device and +BeagleConnect™ node device designs. + +Greybus +------- + +TODO + +#TODO: Find a place for the following notes: + +* The device interfaces get exposed to the host via Greybus BRIDGED_PHY + protocol +* The I2C bus is probed for a an identifier EEPROM and appropriate device + drivers are loaded on the host +* Unsupported Click Boards connected are exposed via userspace drivers on the + host for development + +What’s different? +***************** + +So, in summary, what is so different with this approach? + +* No microcontroller code development is required by users +* Userspace drivers make rapid prototyping really easy +* Kernel drivers makes the support code collaborative parts of the Linux kernel, rather than cut-and-paste diff --git a/boards/beagleconnect/freedom/demos-and-tutorials/using-micropyhon.rst b/boards/beagleconnect/freedom/demos-and-tutorials/using-micropyhon.rst new file mode 100644 index 0000000000000000000000000000000000000000..f0a37f8fc28d2fdce565c0baefda7d30399b631a --- /dev/null +++ b/boards/beagleconnect/freedom/demos-and-tutorials/using-micropyhon.rst @@ -0,0 +1,8 @@ +.. _beagleconnect-freedom-using-micropython: + +Using Micropython +################# + +.. important:: + + Currently under development diff --git a/boards/beagleconnect/freedom/ch3-quick-start.rst b/boards/beagleconnect/freedom/demos-and-tutorials/using-zephyr.rst similarity index 62% rename from boards/beagleconnect/freedom/ch3-quick-start.rst rename to boards/beagleconnect/freedom/demos-and-tutorials/using-zephyr.rst index 936ce4201fcc6e6dc0a7b7b17cecc2a8afd8391d..18fc7c17eb84e1f088319a1b312e95ef8b8f59d1 100644 --- a/boards/beagleconnect/freedom/ch3-quick-start.rst +++ b/boards/beagleconnect/freedom/demos-and-tutorials/using-zephyr.rst @@ -1,147 +1,7 @@ -.. _beagleconnect-freedom-quick-start: +.. _beagleconnect-freedom-using-zephyr: -Quick Start Guide -#################### - -This section describes the usage model we are developing. To use the current -code in development, please refer to the [development] section. - - -BeagleConnect wireless user experience -*************************************** - -Enable a Linux host with BeagleConnect -======================================= -.. image:: media/ProvStep1.jpg - :width: 600 - :align: center - :height: 400 - :alt: ProvStep1 - -Log into a host system running Linux that is BeagleConnect™ enabled. Enable a -Linux host with BeagleConnect™ by plugging a **BeagleConnect™ gateway device** -into its USB port. You’ll also want to have a **BeagleConnect™ node device** -with a sensor, actuator or indicator device connected. - -.. note:: - BeagleConnect™ Freedom can act as either a BeagleConnect™ gateway device - or a BeagleConnect™ node device. - -.. important:: - The Linux host will need to run the BeagleConnect™ management - software, most of which is incorporated into the Linux kernel. Support will be - provided for BeagleBoard and BeagleBone boards, x86 hosts, and Raspberry Pi. - -#TODO#: Clean up images - -Connect host and device -======================= - -.. image:: media/ProvStep2.jpg - :width: 600 - :align: center - :height: 400 - :alt: ProvStep2 - -Initiate a connection between the host and devices by pressing the discovery -button(s). - -Device data shows up as files -============================= - -.. image:: media/ProvStep3.jpg - :width: 600 - :align: center - :height: 400 - :alt: ProvStep3 - -New streams of self-describing data show up on the host system using native -device drivers. - -High-level applications, like Node-RED, can directly read/write these -high-level data streams (including data-type information) to Internet-based -`MQTT <https://mqtt.org/>`_ brokers, live dashboards, or other logical -operations without requiring any sensor-specific coding. Business logic can be -applied using simple if-this-then-that style operations or be made as complex -as desired using virtually any programming language or environment. - -Components -********** - -BeagleConnect™ enabled host Linux computer, possibly single-board computer -(SBC), with BeagleConnect™ management software and BeagleConnect™ gateway -function. BeagleConnect™ gateway function can be provided by a BeagleConnect™ -compatible interface or by connecting a BeagleConnect™ **gateway** device over USB. - -.. note:: - If the Linux host has BLE, the BeagleConnect™ **gateway** is optional for short - distances - -BeagleConnect™ Freedom Board, case, and wireless MCU with Zephyr based firmware -for acting as either a BeagleConnect™ gateway device or BeagleConnect™ node -device. - -* In BeagleConnect™ **gateway** device mode: Provides long-range, low-power - wireless communications, Connects with the host via USB and an associated - Linux kernel driver, and is powered by the USB connector. -* In BeagleConnect™ **node** device mode: Powered by a battery or USB connector - Provides 2 mikroBUS connectors for connecting any of hundreds of `Click Board <https://bbb.io/click>`_ - mikroBUS add-on devices Provides new Linux host controllers for SPI, I2C, - UART, PWM, ADC, and GPIO with interrupts via Greybus - -BeagleConnect **gateway** device -================================== - -Provides a BeagleConnect™ compatible interface to a host. This could be a -built-in interface device or one connected over USB. BeagleConnect™ Freedom can -provide this function. - -BeagleConnect **node** device -============================== - -Utilizes a BeagleConnect™ compatible interface and TODO - -BeagleConnect compatible interface -================================== - -Immediate plans are to support Bluetooth Low Energy (BLE), 2.4GHz IEEE 802.15.4 -, and Sub-GHz IEEE 802.15.4 wireless interfaces. A built-in BLE interface is -suitable for this at short range, whereas IEEE 802.15.4 is typically -significantly better at long ranges. Other wired interfaces, such as CAN and -RS-485, are being considered for future BeagleConnect™ gateway device and -BeagleConnect™ node device designs. - -Greybus -------- - -TODO - -#TODO: Find a place for the following notes: - -* The device interfaces get exposed to the host via Greybus BRIDGED_PHY - protocol -* The I2C bus is probed for a an identifier EEPROM and appropriate device - drivers are loaded on the host -* Unsupported Click Boards connected are exposed via userspace drivers on the - host for development - -What’s different? -***************** - -So, in summary, what is so different with this approach? - -* No microcontroller code development is required by users -* Userspace drivers make rapid prototyping really easy -* Kernel drivers makes the support code collaborative parts of the Linux kernel - , rather than cut-and-paste - -.. _beagleconnect-zephyr: - -BeagleConnect Freedom & Zephyr -****************************** - -Develop for BeagleConnect Freedom with Zephyr -********************************************** +Using Zephyr +############ Developing directly in Zephyr will not be ultimately required for end-users who won't touch the firmware running on BeagleConnect™ Freedom and will instead diff --git a/boards/beagleconnect/freedom/index.rst b/boards/beagleconnect/freedom/index.rst index d3c6c43ff2b92846dc6ca743caba63dd21e5c892..e01dd688e406b7e3696469fd54f18f2a2a528f1e 100644 --- a/boards/beagleconnect/freedom/index.rst +++ b/boards/beagleconnect/freedom/index.rst @@ -42,101 +42,58 @@ over-the-air upgrades (OTA) capability. This MCU provides flexible support for m Introduction to BeagleConnect™ Freedom. - .. grid-item-card:: - :link: beagleconnect-freedom-change-history - :link-type: ref - - **2. Change History** - ^^^ - - .. image:: media/chapter-thumbnails/change-history.jpg - :align: center - :alt: BeagleConnect™ Freedom Chapter2 thumbnail - - +++ - - Hardware, Software, and Documentation change history. - .. grid-item-card:: :link: beagleconnect-freedom-quick-start :link-type: ref - **3. Quick start** + **2. Quick start** ^^^ .. image:: media/chapter-thumbnails/quick-start.jpg :align: center - :alt: BeagleConnect™ Freedom Chapter3 thumbnail + :alt: BeagleConnect™ Freedom Chapter2 thumbnail +++ - Getting started guide. + Getting started guide and tutorials. .. grid-item-card:: - :link: beagleconnect-freedom-detailed-overview + :link: beagleconnect-freedom-design :link-type: ref - **4. Detailed overview** + **3. Design & Specifications** ^^^ .. image:: media/chapter-thumbnails/detailed-overview.jpg :align: center - :alt: BeagleConnect™ Freedom Chapter4 thumbnail - - +++ - - Detailed overview. - - .. grid-item-card:: - :link: beagleconnect-freedom-high-level-specifications - :link-type: ref - - **5. High level specification** - ^^^ - - .. image:: media/chapter-thumbnails/specifications.jpg - :align: center - :alt: BeagleConnect™ Freedom Chapter5 thumbnail - - +++ - - High level specifications. - - .. grid-item-card:: - :link: beagleconnect-freedom-detailed-hardware-design - :link-type: ref - - **6. Detailed hardware design** - ^^^ - - .. image:: media/chapter-thumbnails/hardware-design.jpg - :align: center - :alt: BeagleConnect™ Freedom Chapter6 thumbnail + :alt: BeagleConnect™ Freedom Chapter3 thumbnail +++ - Detailed hardware design. + Hardware and mechanical design and specifications of the BeagleConnect Freedom + board and enclosure for those who want to know their board inside and out. .. grid-item-card:: - :link: beagleconnect-freedom-connectors + :link: beagleconnect-freedom-expansion :link-type: ref - **7. Connectors** + **4. Expansion** ^^^ .. image:: media/chapter-thumbnails/connectors.jpg :align: center - :alt: BeagleConnect™ Freedom Chapter7 thumbnail + :alt: BeagleConnect™ Freedom Chapter4 thumbnail +++ - Connectors pinout diagrams and more. + Connector pinout diagrams with expansion details so that you can + easily debug your connections and create custom expansion hardware. .. grid-item-card:: :link: beagleconnect-freedom-support :link-type: ref - **8. Support** + **5. Support** ^^^ .. image:: media/chapter-thumbnails/support-documents.jpg @@ -145,50 +102,15 @@ over-the-air upgrades (OTA) capability. This MCU provides flexible support for m +++ - User support document for easy development. - - .. grid-item-card:: - :link: beagleconnect-freedom-mechanical - :link-type: ref - - **9. Mechanical** - ^^^ - - .. image:: media/chapter-thumbnails/mechanical-specifications.jpg - :align: center - :alt: BeagleConnect™ Freedom Chapter9 thumbnail - - +++ - - Mechanical dimensions. - - .. grid-item-card:: - :link: beagleconnect-freedom-pictures - :link-type: ref - - **10. Pictures** - ^^^ - - .. image:: media/chapter-thumbnails/pictures.jpg - :align: center - :alt: BeagleConnect™ Freedom Chapter10 thumbnail - - +++ - - BeagleConnect™ Freedom board pictures. + Additional supporting information, images, documents, change history and + hardware & software repositories including issue trackers. .. toctree:: :maxdepth: 1 :hidden: - /boards/beagleconnect/freedom/ch1-introduction.rst - /boards/beagleconnect/freedom/ch2-change-history.rst - /boards/beagleconnect/freedom/ch3-quick-start.rst - /boards/beagleconnect/freedom/ch4-detailed-overview.rst - /boards/beagleconnect/freedom/ch5-high-level-specifications.rst - /boards/beagleconnect/freedom/ch6-detailed-hardware-design.rst - /boards/beagleconnect/freedom/ch7-connectors.rst - /boards/beagleconnect/freedom/ch8-support.rst - /boards/beagleconnect/freedom/ch9-mechanical.rst - /boards/beagleconnect/freedom/ch10-pictures.rst - + 01-introduction + 02-quick-start + 03-design + 04-expansion + 05-support diff --git a/boards/beagleconnect/freedom/media/beagleconnect_freedom.png b/boards/beagleconnect/freedom/media/beagleconnect_freedom.png new file mode 100644 index 0000000000000000000000000000000000000000..12f4db4c28c1f554479a9b130af44fa5a8d20a82 Binary files /dev/null and b/boards/beagleconnect/freedom/media/beagleconnect_freedom.png differ diff --git a/boards/beagleconnect/freedom/media/beagleconnect_freedom_annotated.png b/boards/beagleconnect/freedom/media/beagleconnect_freedom_annotated.png new file mode 100644 index 0000000000000000000000000000000000000000..1be87eb22d028ae33b5f17147e34a222cb42471d Binary files /dev/null and b/boards/beagleconnect/freedom/media/beagleconnect_freedom_annotated.png differ diff --git a/boards/beagleconnect/freedom/media/beagleconnect_freedom_annotated.webp b/boards/beagleconnect/freedom/media/beagleconnect_freedom_annotated.webp new file mode 100644 index 0000000000000000000000000000000000000000..de75da5d05aa92a859ef29b291ea3c19b9a9c2a2 Binary files /dev/null and b/boards/beagleconnect/freedom/media/beagleconnect_freedom_annotated.webp differ diff --git a/boards/beagleconnect/freedom/media/beagleconnect_freedom_back_annotated.png b/boards/beagleconnect/freedom/media/beagleconnect_freedom_back_annotated.png new file mode 100644 index 0000000000000000000000000000000000000000..1c68d1fa3f84049c5264586a819c8691cc8ebcb6 Binary files /dev/null and b/boards/beagleconnect/freedom/media/beagleconnect_freedom_back_annotated.png differ diff --git a/boards/beagleconnect/freedom/media/beagleconnect_freedom_front_annotated.png b/boards/beagleconnect/freedom/media/beagleconnect_freedom_front_annotated.png new file mode 100644 index 0000000000000000000000000000000000000000..ad357d9d2e1275b0aa10976f3f0dc69b34a234bf Binary files /dev/null and b/boards/beagleconnect/freedom/media/beagleconnect_freedom_front_annotated.png differ diff --git a/boards/beagleplay/02-quick-start.rst b/boards/beagleplay/02-quick-start.rst index b8fc2ead8f9f051f61b81489fdb277c323664ea9..c99e8a122ddd47b91583644b2178aee967c34aef 100644 --- a/boards/beagleplay/02-quick-start.rst +++ b/boards/beagleplay/02-quick-start.rst @@ -56,7 +56,17 @@ to browse documents and start programming your BeaglePlay! BeaglePlay VSCode IDE (192.168.7.2:3000) -.. tip:: - Next few chapters are all about the beagleplay hardware design, specifications, connectors, pinouts, and expansion. - If you just want to start experimenting with the board without focusing on the technical details, there are various - demos and tutorials available for you to try out in :ref:`beagleplay-demos-and-tutorials` chapter. \ No newline at end of file +Demos and Tutorials +******************* + +.. toctree:: + :maxdepth: 1 + + demos-and-tutorials/using-serial-console + demos-and-tutorials/connect-wifi + demos-and-tutorials/using-grove + demos-and-tutorials/using-mikrobus + demos-and-tutorials/using-qwiic + demos-and-tutorials/using-oldi + demos-and-tutorials/using-csi + demos-and-tutorials/zephyr-cc1352-development diff --git a/boards/beagleplay/03-design-and-specifications.rst b/boards/beagleplay/03-design.rst similarity index 98% rename from boards/beagleplay/03-design-and-specifications.rst rename to boards/beagleplay/03-design.rst index d9fa4b79aba7157d56ff3ceb243321526b5a8a7b..8b71ae24d0a0dc7b63ba3a7579cb20ec66216fd4 100644 --- a/boards/beagleplay/03-design-and-specifications.rst +++ b/boards/beagleplay/03-design.rst @@ -1,4 +1,4 @@ -.. _beagleplay-design-and-specifications: +.. _beagleplay-design: Design and specifications ######################### @@ -14,8 +14,8 @@ specifications in a short and crisp form as well. :download:`BeaglePlay schematic diagram PDF <https://git.beagleboard.org/beagleplay/beagleplay/-/blob/main/BeaglePlay_SCH_PDF.pdf>` -BeaglePlay block diagram -************************* +Block diagram +************* The block diagram below shows all the parts that makes up your BeaglePlay board. BeaglePlay as mentioned in previous chapters is based on AM6254 SoC which is shown in the middle. @@ -353,10 +353,10 @@ CC1352 JTAG & TagConnect .. _beagleplay-mechanical-specifications: Mechanical Specifications -########################## +************************** Dimensions & weight -******************* +=================== .. table:: Dimensions & weight diff --git a/boards/beagleplay/04-connectors-and-pinouts.rst b/boards/beagleplay/04-connectors-and-pinouts.rst deleted file mode 100644 index f322d5fa70912086b45803b794982ce9fb600cce..0000000000000000000000000000000000000000 --- a/boards/beagleplay/04-connectors-and-pinouts.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. _beagleplay-connectors-and-pinouts: - -Connectors & Pinouts -##################### - -mikroBUS -********* - -Grove -****** - -microSD -******** - -QWIIC -****** - - -.. _beagleplay-expansion: - -Expansion -########## - -MIKROE click boards -******************* - -Grove modules -************** - -QWIIC modules -************** - -SDCards -******* - -CSI2 cameras -************* - -OLDI displays -************** - -USB devices -************ \ No newline at end of file diff --git a/boards/beagleplay/04-expansion.rst b/boards/beagleplay/04-expansion.rst new file mode 100644 index 0000000000000000000000000000000000000000..10a995fb38d9bf2077b481b5e7239cd6cdc62502 --- /dev/null +++ b/boards/beagleplay/04-expansion.rst @@ -0,0 +1,26 @@ +.. _beagleplay-expansion: + +Expansion +######### + +mikroBUS +********* + +Grove +****** + +microSD +******** + +QWIIC +****** + +CSI +*** + +OLDI +**** + +USB +*** + diff --git a/boards/beagleplay/05-demos-and-tutorials.rst b/boards/beagleplay/05-demos-and-tutorials.rst deleted file mode 100644 index 84799ed88a7a5c21902b01b7c54a7893ea2bd71b..0000000000000000000000000000000000000000 --- a/boards/beagleplay/05-demos-and-tutorials.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. _beagleplay-demos-and-tutorials: - -Demos and Tutorials -#################### - -.. raw:: latex - - \begin{comment} - -.. dropdown:: **Demos & Tutorials** - :margin: 4 4 2 2 - :open: - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-connect-wifi - :link-type: ref - - **01. Connect WiFi** - ^^^ - - Connect to wifi using wpa_gui & wpa_cli tools. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-serial-console - :link-type: ref - - **02. Using serial console** - ^^^ - - Use USB-UART adaptor to access boot console. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-mikrobus - :link-type: ref - - **03. Using mikroBUS** - ^^^ - - Use mikroBUS interface for expansion. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-qwiic - :link-type: ref - - **04. Using qwiic interface** - ^^^ - - Use qwiic I2C interface to connect 1000s of qwiic enabled boards. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-grove - :link-type: ref - - **05. Using grove modules** - ^^^ - - Learn to use grove modules. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-csi - :link-type: ref - - **06. Using CSI interface** - ^^^ - - Connect and use cameras via CSI interface. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-oldi - :link-type: ref - - **07. Using oldi** - ^^^ - - Learn to use oldi display interface. - - .. card:: - :margin: 4 4 2 2 - :link: beagleplay-zephyr-development - :link-type: ref - - **08. Zephyr Development** - ^^^ - - Setup zephyr development environment. - -.. raw:: latex - - \end{comment} - -.. toctree:: - :maxdepth: 1 - :hidden: - - demos-and-tutorials/connect-wifi - demos-and-tutorials/using-serial-console - demos-and-tutorials/using-mikrobus - demos-and-tutorials/using-qwiic - demos-and-tutorials/using-grove - demos-and-tutorials/using-csi - demos-and-tutorials/using-oldi - demos-and-tutorials/zephyr-cc1352-development \ No newline at end of file diff --git a/boards/beagleplay/06-support-documents.rst b/boards/beagleplay/05-support.rst similarity index 95% rename from boards/beagleplay/06-support-documents.rst rename to boards/beagleplay/05-support.rst index 833f4ddfceffa8397e5f9a602df65cbf208ffcae..230e195368f4ab9edbbf8f63e9a621a17ed3bf10 100644 --- a/boards/beagleplay/06-support-documents.rst +++ b/boards/beagleplay/05-support.rst @@ -1,4 +1,4 @@ -.. _beagleplay-support-documents: +.. _beagleplay-support: Support documents ################## @@ -14,13 +14,13 @@ Software docs ************** For BeaglePlay specific software projects you can checkout all the -`BeaglePlay project repositories group <https://git.beagleboard.org/beagleplay/beagleplay>`_. +`BeaglePlay project repositories group <https://git.beagleboard.org/beagleplay>`_. Additional support ******************* For any additional support you can submit your queries on our forum, -https://forum.beagleboard.org/ +https://forum.beagleboard.org/tag/play .. _beagleplay-change-history: diff --git a/boards/beagleplay/images/45front.webp b/boards/beagleplay/images/45front.webp new file mode 100644 index 0000000000000000000000000000000000000000..f39e33d119d09001e30f55449c08182465aa034a Binary files /dev/null and b/boards/beagleplay/images/45front.webp differ diff --git a/boards/beagleplay/index.rst b/boards/beagleplay/index.rst index 3a4eb812c3b770c204a3dcd16cca75d0b1e07844..bba13ecadc1fb821c645fa8bb46fb972947330bc 100644 --- a/boards/beagleplay/index.rst +++ b/boards/beagleplay/index.rst @@ -31,7 +31,7 @@ BeaglePlay :link: beagleplay-introduction :link-type: ref - **01. Introduction** + **1. Introduction** ^^^ .. image:: images/chapter-thumbnails/01-introduction.jpg @@ -47,7 +47,7 @@ BeaglePlay :link: beagleplay-quick-start :link-type: ref - **02. Quick start** + **2. Quick start** ^^^ .. image:: images/chapter-thumbnails/02-quick-start.jpg @@ -60,10 +60,10 @@ BeaglePlay in no time. .. grid-item-card:: - :link: beagleplay-design-and-specifications + :link: beagleplay-design :link-type: ref - **03. Design & Specifications** + **3. Design & Specifications** ^^^ .. image:: images/chapter-thumbnails/03-design-and-specifications.jpg @@ -72,14 +72,14 @@ BeaglePlay +++ - Hardware and Mechanical design and specifications of the BeaglePlay board - for those who want to know their board inside out. + Hardware and mechanical design and specifications of the BeaglePlay board + for those who want to know their board inside and out. .. grid-item-card:: - :link: beagleplay-connectors-pinouts-extensions + :link: beagleplay-connectors-expansion :link-type: ref - **04. Connectors and pinouts** + **4. Expansion** ^^^ .. image:: images/chapter-thumbnails/04-connectors-and-pinouts.jpg @@ -88,30 +88,14 @@ BeaglePlay +++ - Connectors and pinout diagrams with expansion details so that you can - easily debug your connections and crate custom expansion hardware. + Connector pinout diagrams with expansion details so that you can + easily debug your connections and create custom expansion hardware. .. grid-item-card:: - :link: beagleplay-demos-and-tutorials + :link: beagleplay-support :link-type: ref - **05. Demos and tutorials** - ^^^ - - .. image:: images/chapter-thumbnails/05-demos-and-tutorials.jpg - :align: center - :alt: BeaglePlay Chapter07 thumbnail - - +++ - - Demos and tutorials for easy testing capabilities of the available - hardware elements of the board. - - .. grid-item-card:: - :link: beagleplay-support-documents - :link-type: ref - - **06. Support documents** + **5. Support** ^^^ .. image:: images/chapter-thumbnails/06-support-documents.jpg @@ -120,8 +104,8 @@ BeaglePlay +++ - User support documents with hardware & software repositories and - information what might be missing in the docs. + Additional supporting information, images, documents, change history and + hardware & software repositories including issue trackers. .. raw:: latex @@ -133,7 +117,6 @@ BeaglePlay 01-introduction 02-quick-start - 03-design-and-specifications.rst - 04-connectors-and-pinouts - 05-demos-and-tutorials - 06-support-documents + 03-design + 04-expansion + 05-support diff --git a/boards/images/45-front.png b/boards/images/45-front.png new file mode 100644 index 0000000000000000000000000000000000000000..69d0029bc2b8429a7bba62debfc1dea378a21ba3 Binary files /dev/null and b/boards/images/45-front.png differ