Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
index.rst 11.5 KiB
Newer Older
..
    BeagleBoard projects documentation main file

.. _bbdocs-home:

BeagleBoard Documentation
############################

Jason Kridner's avatar
Jason Kridner committed
Welcome to the `BeagleBoard project documentation <https://git.beagleboard.org/docs/docs.beagleboard.io>`__.

Official documentation releases are provided at https://docs.beagle.cc (cached with local proxies) and
https://docs.beagleboard.org (non-cached, without proxies).

Jason Kridner's avatar
Jason Kridner committed
.. note:: 
   The BeagleBoard.org Foundation is a US-based 501(c)3 non-profit organization providing open hardware
Jason Kridner's avatar
Jason Kridner committed
   computing solutions for a community of makers, educators and professionals that enable
Jason Kridner's avatar
Jason Kridner committed
   rapid prototyping without barriers to creating real-world embedded systems. The BeagleBoard.org Foundation
   supports the BeagleBoard community through efforts like developing this documentation.
Jason Kridner's avatar
Jason Kridner committed

Introduction
************

Jason Kridner's avatar
Jason Kridner committed
Get started engaging the BeagleBoard.org developer community by reading our :ref:`introduction` page.
Jason Kridner's avatar
Jason Kridner committed

Jason Kridner's avatar
Jason Kridner committed
* Read about how to get started and get help on our :ref:`support` page.
* Learn how to contribute to the project on our :ref:`contribution` page.

.. toctree::
Jason Kridner's avatar
Jason Kridner committed
   :maxdepth: 2
   :hidden:
   :caption: Introduction

   /intro/support/index
Jason Kridner's avatar
Jason Kridner committed
   /intro/beagle101/index
Jason Kridner's avatar
Jason Kridner committed
   /intro/contribution/index


Boards
******

This is where you will find the System Reference Manuals (SRMs) for all of the boards.
Jason Kridner's avatar
Jason Kridner committed

Jason Kridner's avatar
Jason Kridner committed
All Beagles are `open-hardware <https://www.oshwa.org/definition/>`__ with documentation on the
design, including the
`materials <https://git.beagleboard.org/explore/projects/topics/boards>`__ to modify the designs
from source using appropriate design tools.

* Check out our latest board at: :ref:`beagleplay-home`
Jason Kridner's avatar
Jason Kridner committed
* Check out our most popular board at: :ref:`beagleboneblack-home`
* Check out our highest performance board at: :ref:`bbai64-home`
Jason Kridner's avatar
Jason Kridner committed
* Find all of our on: :ref:`boards`
.. grid:: 1 1 2 3
Deepak Khatri's avatar
Deepak Khatri committed
   :margin: 4 4 0 0
   :gutter: 4

   .. grid-item-card::
      :link: beagleplay-home
      :link-type: ref

      **BeaglePlay®**
      ^^^

Deepak Khatri's avatar
Deepak Khatri committed
      .. image:: boards/beagleplay/images/product-pictures/45front.*
         :align: center
      +++

      A 64-bit ARM computer designed to simplify physical world interactions
      to the connected world.


   .. grid-item-card::
Deepak Khatri's avatar
Deepak Khatri committed
      :link: bbai64-home
      :link-type: ref

      **BeagleBone® AI-64**
      ^^^

Deepak Khatri's avatar
Deepak Khatri committed
      .. image:: boards/images/beaglebone-ai-64-400x.*
         :align: center
      +++

      A complete 64-bit AI and Machine Learning System with the convenience
      and expandability of the BeagleBone® platform with the peripherals on
      board to get started right away learning and building applications.


   .. grid-item-card::
Deepak Khatri's avatar
Deepak Khatri committed
      :link: beagleboneblack-home
      :link-type: ref

      **BeagleBone® Black**
      ^^^

      .. image:: boards/images/beaglebone-black-400x400.png
         :align: center
      +++

      1GHz Single-Board Linux Computer based on ARM Cortex-A8 with PRU 
      microcontrollers and tons of features like Ethernet and HDMI – 
      credit card sized with over a decade of support, software and 
      materials behind it making it ready for any application.

   .. grid-item-card::
      :link: beagleconnect_freedom_home
      :link-type: ref

      **BeagleConnect™ Freedom**
      ^^^

      .. image:: boards/beagleconnect/freedom/media/product-pictures/front1.*
         :align: center
      +++

      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.
Deepak Khatri's avatar
Deepak Khatri committed

   .. grid-item-card:: 
      :link: beagleboneblack-home
      :link-type: ref

      **BeagleBone® Black Industrial**
      ^^^

      .. image:: boards/images/bb-industrial-400x356.png
         :align: center
      +++

      Answer the need for an industrial rated single board computer with extended 
      temperature range with the same functionality as the popular BeagleBone Black®

   .. grid-item-card:: 
      :link: beagleboneblack-home
      :link-type: ref

      **BeagleBone® Black Wireless**
      ^^^

      .. image:: boards/images/BeagleBoneBlackWireless-Angled-400x268.png
         :align: center
      +++

      With built-in 802.11 b/g/n 2.4GHz Wi-Fi and Bluetooth wireless networking capability, 
      the popular open source BeagleBone® Black computer goes anywhere. Take your IoT and 
      IIoT projects to the next level with a full Linux computer the size of a mint tin.

   .. grid-item-card:: 
      :link: beaglebone-ai-home
      :link-type: ref

      **BeagleBone® AI**
      ^^^

      .. image:: boards/images/beaglebone-ai-400x208.png
         :align: center
      +++

      Filling the gap between small SBCs and more powerful industrial computers, 
      BeagleBone® AI, based on the AM5729, makes it easy to explore how artificial 
      intelligence can be used in every day life. Powerful compute performance and software support.

   .. grid-item-card:: 
      :link: pocketbeagle-home
      :link-type: ref

      **PocketBeagle®**
      ^^^

      .. image:: boards/images/pocketBeagle-hero-hand-400x222.png
         :align: center
      +++

      This ultra-tiny-yet-complete open-source USB-key-fob computer has the same processor 
      as the BeagleBone® Black at one third the size. Give small projects the Linux computer 
      they deserve. Hundreds of example projects to help you get started.

   .. grid-item-card:: 
      :link: beaglebone-blue-home
      :link-type: ref

      BeagleBone® Blue
      ^^^

      .. image:: boards/images/beaglebone-blue-400x279.png
         :align: center
      +++

      An all-in-one Linux-based robotics computer with compatibility to BeagleBone® Black and 
      tons of integration including Wi-Fi, Bluetooth, IMU/barometer, power regulation, H-Bridges, 
      motor connectors and more. Robotics made streamlined, affordable and fun.

Capes
******

.. grid:: 1 1 2 3
Deepak Khatri's avatar
Deepak Khatri committed
   :margin: 4 4 0 0
   :gutter: 4

   .. grid-item-card::

      **BeagleBone® Servo Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBoneServoCapeA2_Top_NEW-400x332.png
         :align: center
      +++

      Control up to 16 servos for many remote control, robotics or automation projects

   .. grid-item-card::

      **BeagleBone® Fan Cape**
      ^^^

      .. image:: boards/capes/images/fan-cape-400x299.png
         :align: center
      +++

      Keeps BeagleBone® cool under heavy operating loads while still providing easy 
      access to the headers. Essential for BeagleBone® AI Projects

   .. grid-item-card::

      **BeagleBone® Robotics Cape**
      ^^^

      .. image:: boards/capes/images/BBB_RoboticsCape-400x368.png
         :align: center
      +++

      Loaded with features needed for mobile robotics supporting 
      movement, sensing, power management and communication

   .. grid-item-card::
Jason Kridner's avatar
Jason Kridner committed
      :link: bone-cape-relay
      :link-type: ref
Deepak Khatri's avatar
Deepak Khatri committed

      **BeagleBone® Relay Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBoneRelayCapeA2-400x274.png
         :align: center
      +++

      Control things like lights, pumps and more in any home 
      automation project quickly with 4 relay switches

   .. grid-item-card::

      **BeagleBone® Proto Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBoneProtoCapeA2-e1622405187534.png
         :align: center
      +++

      Provides a blank slate including a grid of plated through-holes for external 
      components and supportive buttons and LEDs

   .. grid-item-card::

      **BeagleBone® Power Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBonePowerCapeA2-400x285.png
         :align: center
      +++

      Provides a complete power interface with regulated 3.3V and 5V out as well as up to 30V input voltage

   .. grid-item-card::

      **BeagleBone® Load Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBoneLoadCapeA2-400x290.png
         :align: center
      +++

      Drive high-current loads like relays, motors, solenoids, and high current LEDs

   .. grid-item-card::

      **BeagleBone® Motor Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBoneMotorCapeA2-400x281.png
         :align: center
      +++

      Drive up to 4 DC motors with direction and PWM control


   .. grid-item-card::

      **BeagleBone® Comms Cape**
      ^^^

      .. image:: boards/capes/images/BeagleBoneCommsCapeA2-400x279.png
         :align: center
      +++

      Quickly develop industrial communication applications with an array of protocols including RS485 and CAN

   .. grid-item-card::

      **BeagleBone® GamePup Cape**
      ^^^

      .. image:: boards/capes/images/PocketBeagle_GamePup-400x410.png
         :align: center
      +++

      For making a handheld arcade emulator, your own games or otherwise taking your PocketBeagle 
      on the go, PocketBeagle® GamePup provides all the features you need in a slick shape for gaming

   .. grid-item-card::

      **BeagleBone® Grove Kit**
      ^^^

      .. image:: boards/capes/images/pb-grove-kit-400x267.png
         :align: center
      +++

      A complete kit for developing projects with PocketBeagle® and Grove modules. Great for 
      teaching embedded processing and Linux development. Comes complete with PocketBeagle® 
      as well as Grove Cape and 10 modules to get started.

   .. grid-item-card::

      **BeagleBone® TechLab Cape**
      ^^^

      .. image:: boards/capes/images/PocketBeagle_TechLab-400x212.png
         :align: center
      +++

      Designed with years of educational lessons-learned in mind, PocketBeagle® TechLab 
      Cape delivers easy introduction to programming, Linux and even hacking the kernel 
      itself. Supported by teaching materials from the Linux Foundation and eALE.

Jason Kridner's avatar
Jason Kridner committed
.. toctree::
   :maxdepth: 1
Jason Kridner's avatar
Jason Kridner committed
   :hidden:
Jason Kridner's avatar
Jason Kridner committed
   :caption: Boards
Deepak Khatri's avatar
Deepak Khatri committed
   
   /boards/beagleplay/index
Jason Kridner's avatar
Jason Kridner committed
   /boards/beaglebone/ai-64/index
Deepak Khatri's avatar
Deepak Khatri committed
   /boards/beaglebone/ai/index
Jason Kridner's avatar
Jason Kridner committed
   /boards/beaglebone/black/index
   /boards/beaglebone/blue/index
   /boards/beaglebone/index
   /boards/capes/index
   /boards/pocketbeagle/original/index
   /boards/beagleconnect/freedom/index
   /boards/beagleboard/index
   /boards/terms-and-conditions
Jason Kridner's avatar
Jason Kridner committed


Projects
********

Jason Kridner's avatar
Jason Kridner committed
A number of software projects, like :ref:`simppru_home` exist to help Beagle
developers. Some developers choose to host documentation for their :ref:`projects-home` .
.. toctree::
   :maxdepth: 1
Jason Kridner's avatar
Jason Kridner committed
   :hidden:
Deepak Khatri's avatar
Deepak Khatri committed
   :caption: Projects
Jason Kridner's avatar
Jason Kridner committed
   /projects/simppru/index
   /projects/bb-config/index
Jason Kridner's avatar
Jason Kridner committed
   /boards/beagleconnect/index
Jason Kridner's avatar
Jason Kridner committed

Books
*****

Jason Kridner's avatar
Jason Kridner committed
This project hosts a collection of open-source :ref:`books-home` books written to help Beagle developers.
Jason Kridner's avatar
Jason Kridner committed

Jason Kridner's avatar
Jason Kridner committed
* Find a great introduction to BeagleBone at: :ref:`bone-cook-book-home`
* Learn one of the most amazing Beagle features at: :ref:`pru-cookbook-home`
Jason Kridner's avatar
Jason Kridner committed
   :hidden:
Jason Kridner's avatar
Jason Kridner committed
   /books/beaglebone-cookbook/index
   /books/pru-cookbook/index

Accessories
************

This is a list of curated hardware accessories tested thouroghly with BeagleBone hardware. 
The list is growing with support of volunteers like you. Checkout :ref:`accessories-home` 
page for more information.

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Accessories

   /accessories/index
Indices and tables
Jason Kridner's avatar
Jason Kridner committed
********************

* :ref:`glossary`
* :ref:`genindex`

This work is licensed under a `Creative Commons Attribution-ShareAlike 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`_. 

Attribute original work to BeagleBoard.org Foundation.

.. image:: https://licensebuttons.net/l/by-sa/4.0/88x31.png
    :width: 88px
    :height: 31px
    :target: http://creativecommons.org/licenses/by-sa/4.0/