Merge branch 'main' of git.beagleboard.org:docs/docs.beagleboard.io into j-main

.gitignore

@@ -10,7 +10,7 @@
 \#*\#
 cscope.*
 .dir
-
+*.diff
 /*.patch
 
 # The .cache directory will be used to cache toolchain capabilities if

.gitlab-ci.yml

@@ -10,8 +10,22 @@ cache:
 
 pages:
   script:
-  - apk add ttf-dejavu ttf-freefont
   - "./gitlab-build.sh"
   artifacts:
     paths:
     - public
+  except:
+    - tags
+
+docs:
+  tags:
+  - docs
+  script:
+  - "./gitlab-build.sh"
+  artifacts:
+    paths:
+    - public
+  only:
+    - tags
+  except:
+    - branches

accessories/adapters.rst

+.. _accessories-adapters:
+
+Adapters 
+#########
+
+HDMI Adapters
+***************
+
+microHDMI to VGA
+=================
+
+`Cable Matters Micro HDMI to VGA Adapter <https://www.amazon.com/Cable-Matters-Active-Female-Adapter/dp/B00879EZJI/ref=sr_1_2?ie=UTF8&qid=1381610066&sr=8-2&keywords=micro-hdmi+to+vga>`_
+
+
+HDMI to Composite/CVBS/RCA AV Video Converter
+===============================================
+
+- `Sounce HDMI to RCA,HDMI to AV <https://www.amazon.in/Sounce-Composite-Converter-Supports-DVD-Black/dp/B098DMMS3Z>`_
+
+HDMI-Female to Micro HDMI-Male Adapter
+=======================================
+
+- `Lapster Micro HDMI Male to HDMI Female <https://www.amazon.in/Lapster-Micro-Female-Converter-Adapter/dp/B08PP924DK>`_
\ No newline at end of file

accessories/cables.rst

+.. _accessories-cables:
+
+Cables
+#######
+
+USB Cables
+***********
+
+A microUSB cable will normally be supplied with the BeagleBone Black. For other beaglebone boards like PocketBeagle, BeagleBone AI, 
+BeagleBone AI-64 you'll have to procure your own USB cable.
+
+.. table:: USB ports on BeagleBone hardware
+
+    +----------------------------+--------------+
+    | Board                      | USB type     |
+    +============================+==============+
+    | BeagleBone Black           | miniUSB      |
+    +----------------------------+--------------+
+    | PocketBeagle               | microUSB     |
+    +----------------------------+--------------+
+    | BeagleBone AI              | USB-C        |
+    +----------------------------+--------------+
+    | BeagleBone AI-64           | USB-C        |
+    +----------------------------+--------------+
+    | BeagleBone Blue            | microUSB     |
+    +----------------------------+--------------+
+    | BeagleBone Black Wireless  | microUSB     |
+    +----------------------------+--------------+
+    | BeagleBone xM              | miniUSB      |
+    +----------------------------+--------------+
+    | BeagleBone X15             | microUSB     |
+    +----------------------------+--------------+
+
+Serial Debug Cables
+********************
+
+The default serial port settings for the board are:
+
+.. table:: UART settings
+
+    +--------------+--------------+
+    | Setting      | Value        |
+    +==============+==============+
+    | Baud         | 115,200      |
+    +--------------+--------------+
+    | Bits         | 8            |
+    +--------------+--------------+
+    | Parity       | N            |
+    +--------------+--------------+
+    | Stop Bits    | 1            |
+    +--------------+--------------+
+    | Handshake    | None         |
+    +--------------+--------------+
+
+Standard FTDI Cable
+====================
+
+The debug cable is a standard FTDI to TTL cable. Make sure you get the 3.3V version. 
+You can purchase this from several different sources including but not limited to:
+
+- `DigiKey <http://www.digikey.com/product-detail/en/TTL-232R-3V3/768-1015-ND/1836393>`_
+- `Newark <http://www.newark.com/jsp/search/productdetail.jsp?SKU=34M8872&CMP=KNC-GPLA&mckv=%7Cpcrid%7C19038771501%7Cplid%7C>`_
+- `Sparkfun <https://www.sparkfun.com/products/9717>`_
+- `FTDI <http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm>`_
+- `Adafruit <https://www.adafruit.com/products/70>`_
+
+.. image:: images/FTDI_Cable.jpg
+    :align: center
+    :alt: FTDI Cable
+
+Pin 1 on the cable is the black wire and connects to pin 1 on the board, the pin with the white dot next to it. 
+
+Adafruit 4 Pin Cable (PL2303)
+==============================
+
+One is from `Adafruit <http://www.adafruit.com/products/954>`_. This is a Prolific chipset based cable. 
+Some people have reported issues with the cable causing some issues with data corruption. You experience 
+may vary. You will need to install the Prolific drivers. Those can be downloaded from Adafruit.
+
+.. image:: images/RPI_Serial.png
+    :align: center
+    :alt: 4 pin serial cable
+    
+.. table:: Adafruit 4 pin serial cable connection to BeagleBone Black
+
+    +--------------+--------------+--------------+
+    | Board        | Wire         | Function     |
+    +==============+==============+==============+
+    | Pin 1        | Black        | Ground       |
+    +--------------+--------------+--------------+
+    | Pin 4        | Green        | Receive      |
+    +--------------+--------------+--------------+
+    | Pin 5        | White        | Transmit     |
+    +--------------+--------------+--------------+
+
+
+.. note:: 
+    The naming of the signals reflect those of the cable. 
+    The swapping of TX and RX takes place on the board.
+
+You will also find an extra RED wire on this cable. Just leave it unconnected.
+
+FTDI 3 Pin Cable
+=================
+
+You can purchase the another version direct from **FTDI This cable only has three wires for connection. 
+You can find the datasheet and a picture at** Cable
+
+.. table:: 3 pin FTDI cable connection to BeagleBone Black
+
+    +--------------+--------------+--------------+
+    | Board        | Wire         | Function     |
+    +==============+==============+==============+
+    | Pin 1        | Black        | Ground       |
+    +--------------+--------------+--------------+
+    | Pin 4        | Yellow       | Receive      |
+    +--------------+--------------+--------------+
+    | Pin 5        | Orange       | Transmit     |
+    +--------------+--------------+--------------+
+
+.. note:: 
+    The naming of the signals reflect those of the cable. 
+    The swapping of TX and RX takes place on the board. 
+
+Olimex 3 Pin Cable (PL2303)
+============================
+
+A third version is sold by `Olimex <https://www.olimex.com/Products/Components/Cables/USB-Serial-Cable/USB-Serial-Cable-F/>`_
+
+.. table:: 3 pin FTDI cable connection to BeagleBone Black
+
+    +--------------+--------------+--------------+
+    | Board        | Wire         | Function     |
+    +==============+==============+==============+
+    | Pin 1        | Black        | Ground       |
+    +--------------+--------------+--------------+
+    | Pin 4        | Green        | Receive      |
+    +--------------+--------------+--------------+
+    | Pin 5        | Red          | Transmit     |
+    +--------------+--------------+--------------+
+
+
+
+HDMI Cables
+************
+
+Working HDMI Cables
+====================
+
+The board uses a microHDMI cable. Sources include but are not limited to:
+
+- `Amazon <http://www.amazon.com/Amzer-Micro-HDMI-Speed-Cable/dp/B003OBZSHC>`_
+- `Staples <http://www.staples.com/Staples-HDMI-To-Micro-D-HDMI-Cable/product_926993>`_
+- `Mediabridge <http://www.mediabridgeproducts.com/store/pc/6FT-FLEX-Series-High-Speed-Micro-HDMI-to-HDMI-Cable-with-Ethernet-p246.htm>`_
+- `Monoprice <http://www.monoprice.com/products/product.asp?c_id=102&cp_id=10253&cs_id=1025301&p_id=7557&seq=1&format=2>`_ [#]_
+
+.. image:: images/MicroHDMI.jpg
+    :align: center
+    :alt: MicroHDMI to HDMI cable
+
+Bad HDMI Cables
+================
+
+`High Speed HDMI Cable with Ethernet ,Type D Micro M/M Cable <http://www.newegg.com/Product/Product.aspx?Item=N82E16882241049>`_: Didn't work, not grounded. 
+
+miniDP to HDMI 
+****************
+
+Working miniDP to HDMI
+=======================
+
+.. note::
+    BeagleBone-AI64 requires **ACTIVE** miniDP to HDMI cable or adaptor to work, 
+    your passive miniDP to HDMI setup will not work at all.
+
+- `IVANKY 4K Active Mini DisplayPort to HDMI Adapter <https://www.amazon.com/dp/B089GF8M87/>`_
+- `CableCreation Mini DP (Thunderbolt 2 Compatible) to HDMI <https://www.amazon.in/CD0257-Mini-DP-to-HDMI/dp/B01FM51O0W/>`_
+
+Bad MiniDP to HDMI
+===================
+
+- `UGREEN Mini DP Male to HDMI <https://www.amazon.in/Mini-Male-Female-Converter-Cable/dp/B01CL1P6TA/>`_
+- `AGARO Mini Displayport (Mini Dp) To Hdmi <https://www.amazon.in/AGARO-Meters-Laptop-Computers-Mobile/dp/B09GW1NMNZ/>`_
+- `AmazonBasics Mini Display Port to HDMI <https://www.amazon.in/AmazonBasics-Mini-DisplayPort-HDMI-Adapter/dp/B0134V3KIA/>`_
+
+
+.. [#] Reports are that this cable does not work with the `Adafruit Clear Top Case <http://www.adafruit.com/products/1555>`_
+

accessories/cameras.rst

+.. _accessories-cameras:
+
+Cameras
+#######
+
+USB Cameras
+************
+
++-----------------+---------------------+----------------------+
+| Camera          | BeagleBone Black    | BeagleBone AI-64     |
++=================+=====================+======================+
+| Logitech C270   |                     | Tested               |
++-----------------+---------------------+----------------------+
+| Logitech C920   |                     | Tested               |
++-----------------+---------------------+----------------------+
+| Logitech C922   |                     | Tested               |
++-----------------+---------------------+----------------------+
+
+
+CSI Cameras
+************
+
+.. note:: 
+    Using any CSI camera will require you to load an additional overlay.
+    
+BeagleBone AI-64
+=================
+
+.. tip::
+    Additionally a `15 Pin to 22 Pin camera flex cable <https://robu.in/product/raspberry-pi-zero-v1-3-camera-cable/>`_ 
+    will be required for the camera to be used on BeagleBone AI-64 if your camera module has a 15 pin connector.
+
+- `IMX219 from Arducam <https://robu.in/product/arducam-imx219-visible-light-fixed-focus-camera-module-for-raspberry-pi/>`_
+- `Raspberry Pi v2 (IMX219) <https://www.mouser.in/ProductDetail/SparkFun/DEV-14028?qs=FNcb6ahWXRycHsZ%2FjqmADw%3D%3D>`_
\ No newline at end of file

accessories/displays.rst

+.. _accessories-displays:
+
+Displays
+#########
+
+Monitors and Resolutions
+=========================
+
+Supported Monitors
+-------------------
+
+The following monitors and resolutions have been tested for operation with the BeagleBone Black. 
+Check here often as we will update the list as we confirm the operation. Let 
+`Support <https://git.beagleboard.org/docs/docs.beagleboard.io/-/issues>`_ know the 
+model and resolution at which it works and we will add it to the list. Only the highest 
+resolution is listed below.
+
+.. note::
+    All the monitors most likely will work with AI-64 also but, make sure that 
+    you are using active miniDP to HDMI converter becuase passive convertor will not work.
+
+Links are not provided as they change frequently. So, search on the model number to find a source for these.
+
+- Sony Model LMD-2450W 1280 x 1024 @60Hz
+- Hitachi Model LD9000T 1280 x 720 @60Hz
+- Samsung UN32EH500F 1280 x 1024 @60Hz
+- Samsung P2770HD Syncmaster 1280 x 1024 @60Hz
+- MAG GML 2226 2200M 1280 x 1024 @60Hz
+- ASUS VW266H 1280 x 1024 @60Hz
+- Asus VE278H 720 x 480 @60Hz
+- HP TSS-23x11 1280 x 1024 @60Hz
+- Acer S230HL 1280 x 1024 @60Hz
+- Acer S231HL 1280 x 720 @60Hz
+- ASUS VH238H 1280 x 720 @50Hz
+- Sharp Aquos TV Dell S244OL 1920 x 1080 @60HZ
+
+Unsupported Monitors
+---------------------
+
+LG 37LH30 - did not seem to work, the display didn't even recognize that anything was plugged in at all.
+
+Supported Televisions
+-----------------------
+
+The following TVs and resolutions have been tested for operation with the BeagleBone Black. Check here often as we will update the list as we confirm the operation.
+If you have a TV that works fine, let us know the model and resolution at which it works and we will add it to the list. Only the highest resolution is listed below.
+
+Links are not provided as they change frequently. So, search on the model number to find a source for these.
+
+Vizio E371VL 1280x720 @60Hz.
+Vizio E322VL 1920x1080 @24Hz.
+Panasonic TX-L19X10BW 1280x720 @60Hz.
+
+Unsupported Televisions
+------------------------
+
+.. tip::
+    If you don't have a monitor/TV you can use a Video Captiure Card like 
+    `this from PiBox <https://www.amazon.com/Capture-India-Aluminium-Streaming-Teaching/dp/B0973PR9HH/>`_ 
+    with `OBS <https://obsproject.com/>`_ or any camera application to see the video coming through.
\ No newline at end of file

accessories/index.rst

+.. _accessories-home:
+
+Accessories
+#############
+
+This section will include all the tested accessories for BeagleBoard.org hardware and kits.
+
+.. note::
+
+    This documentation is not complete and we are actively looking for volunteers to test 
+    and add new hardware accessories that they have already with them. General feedback and contribution 
+    is also appreciated. You can checkout these pages to contribuite to BeagleBoard.org docs project,\
+    
+    1. `Docs contribution guide <https://docs.beagleboard.io/latest/intro/contribution/index.html>`_
+    2. `Docs project issue tracker. <https://git.beagleboard.org/docs/docs.beagleboard.io/-/issues>`_
+
+.. danger::
+
+    Accessories section contains only 3rd party products that have been manually used by community members with BeagleBoard.org products. 
+    BeagleBoard.org should not be held liable for the functionality of BeagleBoard.org products in association with these 3rd party 
+    products in any way possible. This is just a place for people to report their experiences and not a statement of compatibility. 
+    BeagleBoard.org approve that these items have at least some aspect of testing by foundation members, though only specific 
+    versions and it is up to the manufacturers of those items to maintain compatibility.
+
+.. grid:: 1 1 2 3
+   :margin: 4 4 0 0
+   :gutter: 4
+
+   .. grid-item-card::
+      :link: accessories-power-supplies
+      :link-type: ref
+
+      **Power Supplies**
+      ^^^
+
+      .. image:: images/cards/powersupplies.jpg
+         :align: center
+      +++
+
+      Power source for all your BeagleBoard.org hardware.
+
+
+   .. grid-item-card::
+      :link: accessories-displays
+      :link-type: ref
+
+      **Displays**
+      ^^^
+
+      .. image:: images/cards/displays.jpg
+         :align: center
+      +++
+
+      Dedicated, portable, and TV monitors.
+
+   .. grid-item-card:: 
+      :link: accessories-peripherals
+      :link-type: ref
+
+      **Peripherals**
+      ^^^
+
+      .. image:: images/cards/peripherals.jpg
+         :align: center
+      +++
+
+      Keyboard, mice, and other peripherals.
+
+   .. grid-item-card:: 
+      :link: accessories-cables
+      :link-type: ref
+
+      **cables**
+      ^^^
+
+      .. image:: images/cards/cables.jpg
+         :align: center
+      +++
+
+      USB, debug, HDMI, and other cables.
+
+   .. grid-item-card:: 
+      :link: accessories-adapters
+      :link-type: ref
+
+      **Adapters**
+      ^^^
+
+      .. image:: images/cards/adapters.jpg
+         :align: center
+      +++
+
+      Display adapters
+
+   .. grid-item-card:: 
+      :link: accessories-cameras
+      :link-type: ref
+
+      **Cameras**
+      ^^^
+
+      .. image:: images/cards/cameras.jpg
+         :align: center
+      +++
+
+      USB and CSI cameras
+
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   /accessories/power-supplies
+   /accessories/displays
+   /accessories/peripherals
+   /accessories/cables
+   /accessories/adapters
+   /accessories/cameras

accessories/peripherals.rst

+.. _accessories-peripherals:
+
+Peripherals
+############
+
+.. note::
+    Most Keyboards, Mouse, and USB Hubs are plug-n-play devices and they are 
+    supported out of the box in linux. List below only shows what has been tested. 
+    You may have something different and it will work without any additional software requirement.
+
+Keyboard & Mouse Combo
+***********************
+
+With limited ports availability on BeagleBones it is recommended to use wireless 
+Keyboard & Mouse combos.
+
+- `Adafruit keyboard & Mouse w/batteries <https://www.mouser.in/ProductDetail/Adafruit/1738?qs=GURawfaeGuBoaqdx8E%2Fl7w%3D%3D>`_
+- `Portronics Key2-A Combo of Multimedia Wireless Keyboard & Mouse <https://www.amazon.in/Portronics-Combo-Multimedia-Wireless-Light-Weight/dp/B07X1KRPDZ/>`_
+
+Keyboards
+************
+
+**Make sure that you plug the keyboard into the USB Host connector before powering on the board.**
+
+- `BTC USB 6100C <http://www.amazon.com/BTC-6100C-Compact-MultiMedia-Keyboard/dp/B000VITZ98/>`_
+- `Inland USB 70010 <http://inlandproduct.com/usbwiredkeyboard.aspx>`_
+- `Gear Head Wireless KB3800TPW <http://www.amazon.com/Wireless-Touch-Touchpad-Keyboard-Smart/dp/B003GU1028/>`_
+- `Microsoft Wireless 800 <http://www.amazon.com/Microsoft-Wireless-Keyboard-800-2VJ-00001/dp/B004JO16KG/>`_
+- `Logitech MK320 Keyboard/Mouse Combo <http://www.amazon.com/Logitech-Wireless-Desktop-MK320-Keyboard/dp/B003VAGXZC/ref=sr_1_1?s=electronics&ie=UTF8&qid=1371841107&sr=1-1&keywords=mk320>`_
+- `Logitech MK710 Keyboard/Mouse Combo <http://www.amazon.com/Logitech-Wireless-Desktop-Keyboard-920-002416/dp/B0036E8V08/>`_
+- `Logitech MK260 Keyboard/Mouse Combo <http://www.amazon.com/Logitech-Wireless-Combo-Keyboard-920-002950/dp/B004KSQANO>`_
+- `Inland Keyboard and Mouse Combo <http://www.amazon.com/Inland-Wireless-2-4GHz-Optical-Keyboard/dp/B009V9IWCO/ref=sr_sp-btf_image_1_10?s=electronics&ie=UTF8&qid=1376403707&sr=1-10&keywords=inland+mouse+and+keyboard>`_
+- `Solidtek KB-5010BU Keyboard+Roller Ball <http://www.logicsupply.com/products/kb_5010bu>`_
+
+Mice
+******
+
+**Make sure that you plug the mice into the USB Host connector before powering on the board.**
+
+- `Microsoft Wireless 1000 <http://www.amazon.com/Microsoft-Wireless-Mobile-Mouse-1000/dp/B003STDQQU/ref=sr_1_1?s=electronics&ie=UTF8&qid=1371841170&sr=1-1&keywords=microsoft+wireless+1000>`_
+- `Logitech M705 <http://www.amazon.com/Logitech-Wireless-Marathon-Battery-910-001935/dp/B003TG75EG/>`_
+- `Logitech M600 <http://www.amazon.com/Logitech-Touch-Mouse-M600-910-002666/dp/B006MBP7T0/>`_
+- `Logitech M310 <http://www.logitech.com/en-us/product/wireless-mouse-m310>`_
+
+USB HUBS
+**********
+
+**Make sure that you plug the HUB into the USB Host connector before powering on the board.**
+
+- `Inland 4 Port <http://www.microcenter.com/product/360458/4-Port_USB_20_Hub>`_
+- `Manhattan 10-port HUB <http://www.microcenter.com/product/393316/10-Port_USB_20_Hi-Speed_Desktop_Hub>`_
+- `4-Port USB Cable HUB <http://www.microcenter.com/product/354122/4-Port_USB_20_Cable_Hub>`_
+- `D-LINK DUB-H7 <http://www.dlink.com/us/en/home-solutions/connect/usb/dub-h7-7-port-usb-2-0-hub>`_
+- `Trust HU-5770 7-Port Powered Hub <http://www.amazon.co.uk/TRUST-UK-HU-5770-PORT-POWERED/dp/B000HG5Q42>`_
+
+.. tip::
+    Make sure you are powering BeagleBone with decent power supply with 
+    enough current before attaching any additional Peripherals. 
+    See :ref:`accessories-power-supplies` for more information on power requirements.