Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit e290618a authored by Deepak Khatri's avatar Deepak Khatri :dog: Committed by Jason Kridner
Browse files

Optimize PDF output

parent 378fa831
Branches
Tags
1 merge request!40Merge BeaglePlay and latest BeagleConnect documentation
Showing
with 56 additions and 47 deletions
......@@ -31,6 +31,8 @@ BeagleBone AI-64 you'll have to procure your own USB cable.
| BeagleBone X15 | microUSB |
+----------------------------+--------------+
.. _serial-debug-cables:
Serial Debug Cables
********************
......
......@@ -36,7 +36,7 @@ Rev A1a
Alpha pilot-run units and initial production.
- `Added pull-down resistor on serial debug header RX
line <https://github.com/beagleboard/beaglebone-ai/issues/24>`__.
line <https://git.beagleboard.org/beagleboard/beaglebone-ai/-/issues/24>`__.
Alpha pilot-run eMMC flash image:
https://debian.beagleboard.org/images/bbai-pilot-20190408.img.xz
......@@ -49,23 +49,23 @@ Rev A2
Proposed changes.
- `Add footprint for pull-down resistor on serial debug header RX
line <https://github.com/beagleboard/beaglebone-ai/issues/24>`__.
- `HW: need pull-down on console uart RX line
<https://git.beagleboard.org/beagleboard/beaglebone-ai/-/issues/24>`__.
- `Move microSD card cage closer to microHDMI to fit cases
better <https://github.com/beagleboard/beaglebone-ai/issues/25>`__.
- `HW: position of microSD may impact existing case designs
<https://git.beagleboard.org/beagleboard/beaglebone-ai/-/issues/25>`__.
- `Connect AM5729 ball AB10 to P9.13 to provide a
GPIO <https://github.com/beagleboard/beaglebone-ai/issues/22>`__.
- `HW: P9.13 does not have a GPIO
<https://git.beagleboard.org/beagleboard/beaglebone-ai/-/issues/22>`__.
- `HDMI hot-plug detection
fixes <https://github.com/beagleboard/beaglebone-ai/issues/19>`__.
- `HW: HDMI hotplug detection not working
<https://git.beagleboard.org/beagleboard/beaglebone-ai/issues/19>`__.
- `Add additional CAN port to the expansion
headers <https://github.com/beagleboard/beaglebone-ai/issues/20>`__.
- `HW: add extra DCAN
<https://git.beagleboard.org/beagleboard/beaglebone-ai/issues/20>`__.
- `Fix JTAG connector to not require wire
mods <https://github.com/beagleboard/beaglebone-ai/issues/21>`__.
- `HW: wire mods required to enable JTAG
<https://git.beagleboard.org/beagleboard/beaglebone-ai/issues/21>`__.
- `Add I2C EEPROM for board
identifier <https://github.com/beagleboard/beaglebone-ai/issues/23>`__.
- `HW: Small I2C nvmem/eeprom for board identifier
<https://git.beagleboard.org/beagleboard/beaglebone-ai/issues/23>`__.
......@@ -27,7 +27,7 @@ You will need to purchase:
- USB C cable or USB C to USB A cable
- MicroSD Card (optional)
- `Serial cable <https://github.com/beagleboard/beaglebone-ai/wiki/Frequently-Asked-Questions#serial-cable>`_ (optional)
- `Serial cable <https://git.beagleboard.org/beagleboard/beaglebone-ai/-/wikis/Frequently-Asked-Questions#serial-cable>`_ (optional)
More information or to purchase a replacement heat sink or antenna, please go to these websites:
......@@ -43,7 +43,7 @@ the board except the 46-way header sockets and the Ethernet socket.
If you run all of the accelerators or have an older software image,
you’ll likely need fan. To find a fan, visit the link to `fans in the
FAQ <https://github.com/beagleboard/beaglebone-ai/wiki/Frequently-Asked-Questions#fans>`_.
FAQ <https://git.beagleboard.org/beagleboard/beaglebone-ai/-/wikis/Frequently-Asked-Questions#fans>`_.
.. caution::
......@@ -184,7 +184,7 @@ A 3 PIN serial debug cable can be helpful to debug when you need to view
the boot messages through a terminal program such as putty on your host
PC. This cable is not needed for most BeagleBone® AI boot up scenarios.
Cables: https://github.com/beagleboard/beaglebone-ai/wiki/Frequently-Asked-Questions#serial-cable
Cables: https://git.beagleboard.org/beagleboard/beaglebone-ai/-/wikis/Frequently-Asked-Questions#serial-cable
Locate the 3 PIN debug header on BeagleBone® AI, near the USB C connection.
......
......@@ -263,7 +263,7 @@ PRU-ICSS Resources and FAQ’s
Resources
- Great resources for PRU and BeagleBone® has been compiled here https://beagleboard.org/pru
- The PRU Cookbook provides examples and getting started information https://github.com/MarkAYoder/PRUCookbook
- The PRU Cookbook provides examples and getting started information :ref:`pru-cookbook-home`
- Detailed specification is available at http://processors.wiki.ti.com/index.php/PRU-ICSS
FAQ
......
......@@ -170,9 +170,8 @@ TODO
Expansion Connector Headers
******************************
TODO: discuss header options for working with the expansion connectors
per
https://github.com/beagleboard/beaglebone-black/wiki/System-Reference-Manual#84-expansion-connectors
TODO: discuss header options for working with the expansion connectors per
https://git.beagleboard.org/beagleboard/beaglebone-black/-/wikis/System-Reference-Manual#section-7-1
Signal Usage
****************
......
......@@ -12,4 +12,4 @@ Mechanical Information
- Gross Weight (including packaging): 110g
- 3D STEP model:
https://github.com/beagleboard/beaglebone-ai/tree/master/Mechanical
\ No newline at end of file
https://git.beagleboard.org/beagleboard/beaglebone-ai/-/tree/master/Mechanical
\ No newline at end of file
......@@ -15,7 +15,7 @@ REGULATORY, COMPLIANCE, AND EXPORT INFORMATION
- TARIC: 8473302000
- ECCN: 5A992.C
- CCATS:
`Z1613110/G180570 <https://github.com/beagleboard/beaglebone-ai/blob/master/regulatory/Validation_Z1613110.pdf>`__
`Z1613110/G180570 <https://git.beagleboard.org/beagleboard/beaglebone-ai/-/tree/master/regulatory/Validation_Z1613110.pdf>`__
- RoHS/REACH: TBD
- Volatility: TBD
......
......@@ -123,8 +123,8 @@ Rev C3
PCB revision C.
* Updated microSD card cage due to availability. See https://github.com/beagleboard/beaglebone-black/issues/6. Added series resistors and depopulated C5.
* Added reset option (GPIO1_8) for Ethernet PHY to avoid possible start-up issue. See https://github.com/beagleboard/beaglebone-black/issues/4.
* Updated microSD card cage due to availability. See https://git.beagleboard.org/beagleboard/beaglebone-black/-/issues/6. Added series resistors and depopulated C5.
* Added reset option (GPIO1_8) for Ethernet PHY to avoid possible start-up issue. See https://git.beagleboard.org/beagleboard/beaglebone-black/-/issues/4.
* Added series resistors to MMC1 lines and depopulated C24.
* Connected pin A6 of J5 on U13 (eMMC IC) to DGND.
* Changed USB1_VBUS series resistor to 0 ohm.
......
......@@ -279,4 +279,4 @@ Bluetooth devices
=====================
- `WowWee Groove Cube
Speaker <https://github.com/beagleboard/beaglebone-blue/wiki/One-Liner-Module-Tests#Grove_I2C_modules>`__
Speaker <https://git.beagleboard.org/beagleboard/beaglebone-blue/-/wikis/One-Liner-Module-Tests#grove-i2c-modules>`__
......@@ -101,7 +101,7 @@ I'm running an image off of a microSD card. How do I write it to the on-board eM
==========================================================================================
Refer to the "Flashing Firmware" page:
https://github.com/beagleboard/beaglebone-blue/wiki/Flashing-firmware
https://git.beagleboard.org/beagleboard/beaglebone-blue/-/wikis/Flashing-firmware
Meanwhile, as root, run the
/opt/scripts/tools/eMMC/bbb-eMMC-flasher-eewiki-ext4.sh script which
......@@ -136,7 +136,7 @@ One you’ve booted the latest image, you can update the bootloader on the
eMMC using
`/opt/scripts/tools/developers/update_bootloader.sh <https://github.com/RobertCNelson/boot-scripts/blob/master/tools/developers/update_bootloader.sh>`__.
Better yet, read the `above
FAQ <https://github.com/beagleboard/beaglebone-blue/wiki/Frequently-Asked-Questions-%28FAQ%29#Im_running_an_image_off_of_a_microSD_card_How_do_I_write_it_to_the_onboard_eMMC_flash>`__
FAQ <https://git.beagleboard.org/beagleboard/beaglebone-blue/-/wikis/Frequently-Asked-Questions-(FAQ)#Im_running_an_image_off_of_a_microSD_card_How_do_I_write_it_to_the_onboard_eMMC_flash>`__
on flashing firmware.
.. _ive_got_my_on_board_emmc_flash_configured_in_a_nice_way._how_do_i_copy_that_to_other_beaglebone_blue_boards:
......
......@@ -11,10 +11,10 @@ BeagleBone Blue Pinouts
:align: center
- Connector pinout
`details <https://github.com/beagleboard/beaglebone-blue/blob/master/BeagleBone_Blue_sch.pdf>`__
`details <https://git.beagleboard.org/beagleboard/beaglebone-blue/-/blob/master/BeagleBone_Blue_sch.pdf>`__
from schematic(s)
- `Pin
Table <https://github.com/beagleboard/beaglebone-blue/blob/master/BeagleBone_Blue_Pin_Table.csv>`__
Table <https://git.beagleboard.org/beagleboard/beaglebone-blue/-/blob/master/BeagleBone_Blue_Pin_Table.csv>`__
with some Blue : Black corelation.
UT1
......
......@@ -338,5 +338,5 @@ The board can be configured in several different ways. Future revisions
of this document may include additional configurations.
As other examples become documented, we'll update them on the Wiki for
PocketBeagle `github.com/beagleboard/pocketbeagle/wiki <https://github.com/beagleboard/pocketbeagle/wiki>`__
PocketBeagle `PocketBeagle WiKi <https://git.beagleboard.org/beagleboard/pocketbeagle/-/wikis/home>`__
See also the `on-line discussion. <https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/beagleboard/JtOGZb-FH2A/9GVu7I6kAQAJ>`__
......@@ -5,7 +5,7 @@ Detailed Hardware Design
The following sections contain schematic references for PocketBeagle.
Full schematics in both PDF and Eagle are available on the
`'PocketBeagle Wiki' <https://github.com/beagleboard/pocketbeagle>`__
`'PocketBeagle Wiki' <https://git.beagleboard.org/beagleboard/pocketbeagle>`__
.. _osd3358_sm_sip_design:
......
......@@ -289,7 +289,7 @@ Figure 46, with one Click Board facing each direction. When choosing
Click boards, make sure you are checking that they meet the 3.3V
requirements for PocketBeagle. A growing number of community members are
trying out various Click Boards and posting results on the
`'PocketBeagle Wiki mikroBus Click Boards page' <https://github.com/beagleboard/pocketbeagle/wiki/mikroBus%E2%84%A2-Click-Boards>`__.
`'PocketBeagle Wiki mikroBus Click Boards page' <https://git.beagleboard.org/beagleboard/pocketbeagle/-/wikis/mikroBus%E2%84%A2-Click-Boards>`__.
.. figure:: images/46fig-PB-Mikro.png
:align: center
......@@ -305,7 +305,7 @@ Setting up an additional USB Connection
You can add an additional USB connection to PocketBeagle easily by
connecting a microUSB breakout. By default in the current software, the
system should be configured to use this port as a host. Keep up to date
on this project on the `'PocketBeagle Wiki FAQ' <https://github.com/beagleboard/pocketbeagle/wiki/FAQ>`__.
on this project on the `'PocketBeagle Wiki FAQ' <https://git.beagleboard.org/beagleboard/pocketbeagle/-/wikis/FAQ>`__.
.. image:: images/PocketBeagle_microUSB_bb1.png
:align: center
\ No newline at end of file
......@@ -23,4 +23,4 @@ RoHS Compliant: Yes
Weight: 10g
Rough model can be found at
`github.com/beagleboard/pocketbeagle/tree/master/models <https://github.com/beagleboard/pocketbeagle/tree/master/models>`__
\ No newline at end of file
`PocketBeagle models <https://git.beagleboard.org/beagleboard/pocketbeagle/-/tree/master/models>`__
\ No newline at end of file
......@@ -14,17 +14,17 @@ Hardware Design
~~~~~~~~~~~~~~~~~~~~
Design documentation can be found on the wiki.
https://github.com/beagleboard/pocketbeagle Including:
https://git.beagleboard.org/beagleboard/pocketbeagle/ Including:
- Schematic in PDF
https://github.com/beagleboard/pocketbeagle/blob/master/PocketBeagle_sch.pdf
https://git.beagleboard.org/beagleboard/pocketbeagle/-/blob/master/PocketBeagle_sch.pdf
- Schematic and layout in EAGLE
https://github.com/beagleboard/pocketbeagle/tree/master/EAGLE
https://git.beagleboard.org/beagleboard/pocketbeagle/-/tree/master/EAGLE
- Schematic and layout in KiCAD
https://github.com/beagleboard/pocketbeagle/tree/master/KiCAD
https://git.beagleboard.org/beagleboard/pocketbeagle/-/tree/master/KiCAD
- Bill of Materials
https://github.com/beagleboard/pocketbeagle/blob/master/PocketBeagle_BOM.csv
- System Reference Manual https://github.com/beagleboard/pocketbeagle.
https://git.beagleboard.org/beagleboard/pocketbeagle/-/blob/master/PocketBeagle_BOM.csv
- :ref:`pocketbeagle-home` docs.
.. _software_updates:
......@@ -45,7 +45,7 @@ Export Information
- ECCN: EAR99
- CCATS: G173833
- Documentation:
`github.com/beagleboard/pocketbeagle/blob/master/regulatory/PocketBeagle_Export_Classification.pdf <https://github.com/beagleboard/pocketbeagle/blob/master/regulatory/PocketBeagle_Export_Classification.pdf>`__
`PocketBeagle_Export_Classification.pdf <https://git.beagleboard.org/beagleboard/pocketbeagle/-/blob/master/regulatory/PocketBeagle_Export_Classification.pdf>`__
.. _rma_support:
......@@ -65,7 +65,7 @@ Getting Help
If you need some up to date troubleshooting techniques, the Wiki is a
great place to start
`github.com/beagleboard/pocketbeagle/wiki <https://github.com/beagleboard/pocketbeagle/wiki>`__.
`PocketBeagle wiki <https://git.beagleboard.org/beagleboard/pocketbeagle/-/wikis/home>`__.
If you need professional support, check out
`beagleboard.org/resources <https://beagleboard.org/resources>`__.
......@@ -195,7 +195,7 @@ Solution
---------
You can modify ``rc_test_servos.c``. You'll find it on the bone online at
https://github.com/beagleboard/librobotcontrol/blob/master/examples/src/rc_test_servos.c.
https://git.beagleboard.org/beagleboard/librobotcontrol/-/blob/master/examples/src/rc_test_servos.c
Just past line 250 you'll find a ``while`` loop that has calls to ``rc_servo_send_pulse_normalized(ch,servo_pos)`` and
``rc_servo_send_pulse_us(ch, width_us)``. The first call sets the pulse width relative to the pulse period; the other
......
......@@ -260,7 +260,7 @@ Discission
-----------
Suppose you want to make ``P9_31`` a PRU output pin. First go to the
`am5729 System Reference Manual <https://github.com/beagleboard/beaglebone-ai/wiki/System-Reference-Manual#p8.10-p8.13>`_
`am5729 System Reference Manual <https://git.beagleboard.org/beagleboard/beaglebone-ai/-/wikis/System-Reference-Manual>`_
and look up ``P9_31``.
.. tip::
......
......@@ -3,6 +3,7 @@
apk add git
apk add rsync
apk add date
apk add pdfcpu
export VER_LATEST_MAJOR=1
export VER_LATEST_MINOR=0
......@@ -45,6 +46,7 @@ HERE
sphinx-build -b html . public/$VER_DIR/
sphinx-build -M latexpdf . public/$VER_DIR/
pdfcpu optimize public/$VER_DIR/latex/beagleboard-docs.pdf
mv public/$VER_DIR/latex/beagleboard-docs.pdf public/$VER_DIR/
rm -rf public/$VER_DIR/latex
......
......@@ -16,13 +16,19 @@ open-hardware development platform, you've found the right place!
For bleeding edge (development-stage) documentation:
* https://docs.beagleboard.io (Straight from `docs repo <https://git.beagleboard.org/docs/docs.beagleboard.io>`_)
* https://docs.beagleboard.io (straight from `docs repo <https://git.beagleboard.org/docs/docs.beagleboard.io>`_)
Please check out our :ref:`support` page to find out how to get started, resolve issues,
and engage with the developer community. Don't forget that this is an open-source project! Your contributions are welcome.
Learn about how to contribute to the BeagleBoard documentation project and any of the many open-source Beagle
projects ongoing on our :ref:`contribution` page.
.. warning::
Make sure you thoroughly read and agree with our :ref:`boards-terms-and-conditions` which covers
warnings, restrictions, disclaimers, and warranty for all of our boards. Use of either the boards or
the design materials constitutes agreement to the T&C including any modifications done to
the hardware or software solutions provided by beagleboard.org foundation.
.. toctree::
:maxdepth: 2
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment