Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit 8cc8e655 authored by Jason Kridner's avatar Jason Kridner Committed by Deepak Khatri
Browse files

support clean-up

parent 7b599a4a
No related merge requests found
Hide whitespace changes
Inline Side-by-side
index-tex.rst
+ 0
− 1
View file @ 8cc8e655
......@@ -11,6 +11,5 @@ BeagleBoard Docs
.. toctree::
support/index.rst
support/getting-started.rst
beaglebone-black/index.rst
beaglebone-ai-64/index.rst
\ No newline at end of file
index.rst
+ 0
− 2
View file @ 8cc8e655
......@@ -11,10 +11,8 @@ Sections
.. toctree::
:maxdepth: 1
:caption: Support
support/index.rst
support/getting-started.rst
.. toctree::
:maxdepth: 1
......
support/getting-started.rst
+ 63
− 97
View file @ 8cc8e655
.. _beagleboard-getting-started:
Getting Started
##################
==================
Beagles are tiny computers ideal for learning and prototyping with electronics.
Beagles are tiny computers ideal for learning and prototyping with electronics.
Read the step-by-step getting started tutorial below to begin developing with your Beagle in minutes.
Update board with latest software
------------------------------------
This step may or may not be necessary, depending on how old a software image you already have,
This step may or may not be necessary, depending on how old a software image you already have,
but executing this, the longest, step will ensure the rest will go as smooth as possible.
Download the latest software image
********************************************
Download the lastest Debian image from `beagleboard.org/latest-images <https://beagleboard.org/latest-images>`_.
The "IoT" images provide more free disk space if you don't need to use a graphical user interface (GUI).
Download the lastest Debian image from `beagleboard.org/latest-images <https://beagleboard.org/latest-images>`_.
The "IoT" images provide more free disk space if you don't need to use a graphical user interface (GUI).
.. NOTE::
Due to sizing necessities, this download may take 30 minutes or more.
.. NOTE::
Due to sizing necessities, this download may take 30 minutes or more.
The Debian distribution is provied for the boards. The file you download will have an .img.xz extension.
The Debian distribution is provied for the boards. The file you download will have an .img.xz extension.
This is a compressed sector-by-sector image of the SD card.
|image0|
......@@ -40,7 +40,7 @@ Use your computer's SD slot or a USB adapter to connect the SD card to your comp
Write the image to your SD card
*****************************************
Use Etcher to write the image to your SD card. Etcher will transparently decompress the
Use Etcher to write the image to your SD card. Etcher will transparently decompress the
image on-the-fly before writing it to the SD card.
|image3|
......@@ -51,42 +51,41 @@ Eject the newly programmed SD card.
Boot your board off of the SD card
********************************************
Insert SD card into your (powered-down) board, hold down the USER/BOOT button (if using Black)
and apply power, either by the USB cable or 5V adapter.
Insert SD card into your (powered-down) board, hold down the USER/BOOT button
and apply power, either by the USB cable or 5V adapter.
If using an original BeagleBone or PocketBeagle, you are done.
If using an original BeagleBone or PocketBeagle, you are done.
If using BeagleBone Black, BeagleBone Blue, BeagleBone AI or other board with on-board eMMC
flash and you desire to write the image to your on-board eMMC, you'll need to follow the
instructions at http://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC.
When the flashing is complete, all 4 USRx LEDs will be steady on or off. The latest Debian
flasher images automatically power down the board upon completion. This can take up to 45 minutes.
If using BeagleBone Black, BeagleBone Blue, BeagleBone AI, BeagleBone AI-64 or other board with on-board eMMC
flash and you desire to write the image to your on-board eMMC, you'll need to follow the
instructions at http://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC.
When the flashing is complete, all 4 USRx LEDs will be steady on or off. The latest Debian
flasher images automatically power down the board upon completion. This can take up to 45 minutes.
Power-down your board, remove the SD card and apply power again to finish.
Start your Beagle
------------------
If any step fails, it is recommended to update to the
`latest software image <https://gitbook.beagleboard.org/support/getting-started>`_
If any step fails, it is recommended to update to the
`latest software image <https://beagleboard.org/latest-images>`_
using the instructions above.
Power and boot
----------------
Most Beagles include a USB cable, providing a convenient way to provide both power to your
Beagle and connectivity to your computer. If you provide your own, ensure it is of good quality.
Most Beagles can be powered via a USB cable, providing a convenient way to provide both power to your
Beagle and connectivity to your computer. Be sure the cable is of good quality and your source can provide enough power.
Alternatively, your Beagle may have a barrel jack. The voltage should be 5V except for
BeagleBoard-X15 and BeagleBone Blue which use 12V.
Alternatively, your Beagle may have a barrel jack.
.. Note::
BeagleBoard-X15 must always be powered by a 12V adapter with a barrel jack.
Use only a 5V center positive adapter for all Beagles except BeagleBone Blue and BeagleBoard-X15 (12V).
If you are using your Beagle with an `SD (microSD) card <https://en.wikipedia.org/wiki/Secure_Digital>`_, make sure it is inserted ahead of providing power.
If you are using your Beagle with an `SD (microSD) card <https://en.wikipedia.org/wiki/Secure_Digital>`_, make sure it is inserted ahead of providing power.
Most Beagles include programmed on-board flash and therefore do not require an SD card to be inserted.
You'll see the power (PWR or ON) LED lit steadily. Within a minute or so, you should see the other LEDs
blinking in their default configurations. Consult the Quick Start Guide (QSG) or System Reference
You'll see the power (PWR or ON) LED lit steadily. Within a minute or so, you should see the other LEDs
blinking in their default configurations. Consult the Quick Start Guide (QSG) or System Reference
Manual (SRM) for your board to locate these LEDs.
- USR0 is typically configured at boot to blink in a heartbeat pattern.
......@@ -98,79 +97,69 @@ Manual (SRM) for your board to locate these LEDs.
Enable a network connection
----------------------------
If connected via USB, a network adapter should show up on your computer.
Your Beagle should be running a DHCP server that will provide your computer
with an IP address of either 192.168.7.1 or 192.168.6.1, depending on the
type of USB network adapter supported by your computer's operating system.
If connected via USB, a network adapter should show up on your computer.
Your Beagle should be running a DHCP server that will provide your computer
with an IP address of either 192.168.7.1 or 192.168.6.1, depending on the
type of USB network adapter supported by your computer's operating system.
Your Beagle will reserve 192.168.7.2 or 192.168.6.2 for itself.
If your Beagle includes WiFi, an access point called "BeagleBone-XXXX" where "XXXX"
varies between boards. The access point password defaults to "BeagleBone".
Your Beagle should be running a DHCP server that will provide your computer
If your Beagle includes WiFi, an access point called "BeagleBone-XXXX" where "XXXX"
varies between boards. The access point password defaults to "BeagleBone".
Your Beagle should be running a DHCP server that will provide your computer
with an IP address in the 192.168.8.x range and reserve 192.168.8.1 for itself.
If your Beagle is connected to your local area network (LAN) via either Ethernet or WiFi,
it will utilize `mDNS <https://en.wikipedia.org/wiki/Multicast_DNS>`_ to broadcast itself
to your computer. If your computer supports mDNS, you should see your Beagle as beaglebone.local.
Non-BeagleBone boards will utilize alternate names. Multiple BeagleBone boards on the same
If your Beagle is connected to your local area network (LAN) via either Ethernet or WiFi,
it will utilize `mDNS <https://en.wikipedia.org/wiki/Multicast_DNS>`_ to broadcast itself
to your computer. If your computer supports mDNS, you should see your Beagle as beaglebone.local.
Non-BeagleBone boards will utilize alternate names. Multiple BeagleBone boards on the same
network will add a suffix such as beaglebone-2.local.
The below table summarizes the typical addresses and should dynamically update to indicate an active connection.
Browse to your Beagle
----------------------
.. Note::
You must "load unsafe scripts" or load `this page <http://beagleboard.org/getting-started>`_
without HTTPS security for the automatic detection to work.
A web server with an IDE should be running on your Beagle. Point your browser to it to begin development.
.. NOTE::
Use either `Firefox <https://www.mozilla.org/firefox>`_ or `Chrome <https://www.google.com/chrome>`_
(Internet Explorer will NOT work), browse to the web server running on your board. It will load a presentation
showing you the capabilities of the board. Use the arrow keys on your keyboard to navigate the presentation.
The below table summarizes the typical addresses.
.. list-table::
:header-rows: 1
* - List table
* - Link
- Connection type
- Operating System(s)
- Status
* - 192.168.7.2
* - http://192.168.7.2
- USB
- Windows
- Inactive
* - 192.168.6.2
* - http://192.168.6.2
- USB
- Mac OS X, Linux
- Inactive
* - 192.168.8.1
* - http://192.168.8.1
- WiFi
- all
- Inactive
* - beaglebone.local
* - http://beaglebone.local
- all
- mDNS enabled
- Inactive
* - beaglebone-2.local
* - http://beaglebone-2.local
- all
- mDNS enabled
- Inactive
Browse to your beagle
----------------------
Use either `Firefox <http://www.mozilla.org/firefox>`_ or `Chrome <https://www.google.com/chrome>`_
(Internet Explorer will NOT work), browse to the web server running on your board. It will load a presentation
showing you the capabilities of the board. Use the arrow keys on your keyboard to navigate the presentation.
Click here to launch: https://192.168.7.2 Older software images require you to EJECT the BEAGLE_BONE
drive to start the network. With the latest software image, that step is no longer required.
Troubleshooting
------------------
Do not use Internet Explorer.
Virtual machines are not recommended when using the direct USB connection.
Virtual machines are not recommended when using the direct USB connection.
It is recommended you use only network connections to your board if you are using a virtual machine.
When using 'ssh' with the provided image, the username is 'debian' and the password is 'temppwd'.
With the latest images, it should no longer be necessary to install drivers for your operating
system to give you network-over-USB access to your Beagle. In case you are running an older image,
With the latest images, it should no longer be necessary to install drivers for your operating
system to give you network-over-USB access to your Beagle. In case you are running an older image,
an older operating system or need additional drivers for serial access to older boards, links to the old drivers are below.
.. list-table::
......@@ -184,7 +173,7 @@ an older operating system or need additional drivers for serial access to older
- If in doubt, try the 64-bit installer first.
* - Windows (32-bit)
- `32-bit installer <https://beagleboard.org/static/Drivers/Windows/BONE_DRV.exe>`_
-
-
* - Mac OS X
- `Network Serial <https://beagleboard.org/static/Drivers/MacOSX/FTDI/EnergiaFTDIDrivers2.2.18.pkg>`_
- Install both sets of drivers.
......@@ -208,35 +197,12 @@ an older operating system or need additional drivers for serial access to older
Visit https://beagleboard.org/support for additional debugging tips.
Other currently available software images
------------------------------------------
Some of the starting images below involve multiple steps to produce an SD card image or otherwise
change some of the steps above, so be sure to read all the instructions on their pages.
Choose the starting point you want, download or produce the SD card image and follow the steps above.
At the time of release, not all of these distributions support BeagleBone Black, but should soon.
- Texas Instruments releases: `Android <https://beagleboard.org/project/android/>`_, `Linux <https://beagleboard.org/project/amsdk/>`_, `StarterWare (no OS) <https://beagleboard.org/project/starterware/>`_
- Linux: `Debian <https://beagleboard.org/project/Debian/>`_, `Angstrom Distribution <https://beagleboard.org/project/angstrom>`_, `Ubuntu <https://beagleboard.org/project/ubuntu/>`_, `ArchLinux <https://beagleboard.org/project/AM/>`_, `Gentoo <https://beagleboard.org/project/Gentoo/>`_, `Sabayon <https://beagleboard.org/project/sabayon/>`_, `Buildroot <https://beagleboard.org/project/buildroot/>`_, `Erlang <https://beagleboard.org/project/Nerves/>`_, `Fedora <https://beagleboard.org/project/fedora/>`_
- Other: `QNX <https://beagleboard.org/project/QNX+Neutrino+on+OMAP/>`_, `FreeBSD <https://beagleboard.org/project/freebsd/>`_
- `Project page<https://beagleboard.org/project>`_
Hardware documentation
--------------------------
Time to read that manual and check out the design materials: `BeagleBoard <https://github.com/beagleboard/beagleboard>`_,
`BeagleBoard-xM <https://github.com/beagleboard/beagleboard-xm>`_,
`BeagleBoard-x15 <https://github.com/beagleboard/beagleboard-x15>`_,
`BeagleBone <https://github.com/beagleboard/beaglebone>`_,
`BeagleBone Black <https://github.com/beagleboard/beaglebone-black>`_,
`BeagleBone Black Wireless <https://github.com/beagleboard/beaglebone-black-wireless>`_,
`BeagleBone Blue <https://github.com/beagleboard/beaglebone-blue>`_,
`PocketBeagle <https://github.com/beagleboard/pocketbeagle>`_,
`BeagleBone AI <https://github.com/beagleboard/beaglebone-ai>`_,
`BeagleBone AI-64 <https://github.com/beagleboard/beaglebone-ai-64>`_
Be sure to check check the latest hardware documentation for your board at https://docs.beagleboard.org.
Other links to design materials for various releases can be found at https://beagleboard.org/hardware/design
Other links to design materials for various releases can be found at https://git.beagleboard.org/beagleboard.
Books
-----
......@@ -249,13 +215,13 @@ Perfect for high-school seniors or freshman univerisity level text, consider usi
`BeagleBone Cookbook <https://bbb.io/cookbook>`_
A lighter treatment suitable for a bit broader audience without the backgrounders on programming and
A lighter treatment suitable for a bit broader audience without the backgrounders on programming and
electronics, consider "BeagleBone Cookbook"
`Exploring BeaglebBone <https://bbb.io/ebb>`_ and `Embedded Linux Primer <https://bbb.io/elp>`_
`Exploring BeagleBone <https://bbb.io/ebb>`_ and `Embedded Linux Primer <https://bbb.io/elp>`_
To take things to the next level of detail, consider "Exploring BeagleBone" which can be considered
the missing software manual and utilize "Embedded Linux Primer" as a companion textbook to provide
To take things to the next level of detail, consider "Exploring BeagleBone" which can be considered
the missing software manual and utilize "Embedded Linux Primer" as a companion textbook to provide
a strong base on embedded Linux suitable for working with any hardware that will run Linux.
.. |image0| image:: images/download-latestimage.png
......
support/index.rst
+ 7
− 80
View file @ 8cc8e655
.. _support:
Support
=======
#########
.. note:: #TODO# all the links need updating and content moved into this repo.
Getting started
---------------
The starting experience for all Beagles has been made to be as
consistent as is possible. For any of the Beagle Linux-based open
hardware computers, visit our `getting started
guide <getting-started>`__.
Getting support
---------------
BeagleBoard.org products and `open
hardware <https://www.oshwa.org/definition/>`__ designs are supported
via the on-line community resources. We are very confident in our
community’s ability to provide useful answers in a timely manner. If you
don’t get a productive response within 24 hours, please escalate issues
to Jason Kridner (contact info available on the `About
Page <https://beagleboard.org/about>`__). In case it is needed, Jason
will help escalate issues to suppliers, manufacturers or others. Be sure
to provide a link to your questions on the `community
forums <https://forum.beagleboard.org>`__ as answers will be provided
there.
Diagnostic tools
----------------
Best to be prepared with good diagnostic information to aide with
support.
- `Example run of ‘version.sh’ script needed for support
requests <https://groups.google.com/d/msg/beagleboard/4oo4oL20BEs/MVwxfR-XCAAJ>`__
- `Beagle Tester source <https://github.com/jadonk/beagle-tester>`__
- `Beagle Tester image
releases <https://github.com/beagleboard/buildroot/releases>`__
Community resources
-------------------
Please execute the board diagnostics, review the hardware documentation,
and consult the mailing list and IRC channel for support.
BeagleBoard.org is a “community” project with free support only given to
those who are willing to discussing their issues openly for the benefit
of the entire community.
- `Frequently Asked Questions <https://beagleboard.org/support/faq>`__
- `Mailing List <https://forum.beagleboard.org>`__
- `Live Chat <https://beagleboard.org/chat>`__
Consulting and other resources
------------------------------
Need timely response or contract resources because you are building a
product?
- `Resources <https://beagleboard.org/resources>`__
Repairs
-------
Repairs and replacements only provided on unmodified boards purchased
via an authorized distributor within the first 90 days. All repaired
board will have their flash reset to factory contents. For repairs and
replacements, please contact ‘support’ at BeagleBoard.org using the RMA
form:
- `RMA request <https://beagleboard.org//support/rma>`__
Understanding Your Beagle
-------------------------
- `BeagleBone Introduction <https://beagleboard.org/Support/bone101>`__
- `Hardware <https://beagleboard.org/Support/Hardware+Support>`__
- `Software <https://beagleboard.org/Support/Software+Support>`__
- `BoneScript JavaScript
library <https://beagleboard.org/Support/bonescript>`__
- `Books <https://beagleboard.org/books>`__
.. toctree::
:maxdepth: 1
- `Exploring BeagleBone <https://beagleboard.org/ebb>`__
- `BeagleBone Cookbook <https://beagleboard.org/cookbook>`__
- `Bad to the Bone <https://beagleboard.org/bad-to-the-bone>`__
overview.rst
getting-started.rst
support/overview.rst 0 → 100644
+ 80
− 0
View file @ 8cc8e655
Overview
=========
Getting started
---------------
The starting experience for all Beagles has been made to be as
consistent as is possible. For any of the Beagle Linux-based open
hardware computers, visit our `getting started guide <getting-started>`__.
Getting support
---------------
BeagleBoard.org products and `open
hardware <https://www.oshwa.org/definition/>`__ designs are supported
via the on-line community resources. We are very confident in our
community’s ability to provide useful answers in a timely manner. If you
don’t get a productive response within 24 hours, please escalate issues
to Jason Kridner (contact info available on the `About
Page <https://beagleboard.org/about>`__). In case it is needed, Jason
will help escalate issues to suppliers, manufacturers or others. Be sure
to provide a link to your questions on the `community
forums <https://forum.beagleboard.org>`__ as answers will be provided
there.
Diagnostic tools
----------------
Best to be prepared with good diagnostic information to aide with
support.
- Output of ‘beagle-version’ script needed for support requests
- `Beagle Tester source <https://git.beagleboard.org/jkridner/beagle-tester>`__
Community resources
-------------------
Please execute the board diagnostics, review the hardware documentation,
and consult the mailing list and IRC channel for support.
BeagleBoard.org is a “community” project with free support only given to
those who are willing to discussing their issues openly for the benefit
of the entire community.
- `Frequently Asked Questions <https://forum.beagleboard.org/c/faq>`__
- `Mailing List <https://forum.beagleboard.org>`__
- `Live Chat <https://beagleboard.org/chat>`__
Consulting and other resources
------------------------------
Need timely response or contract resources because you are building a
product?
- `Resources <https://beagleboard.org/resources>`__
Repairs
-------
Repairs and replacements only provided on unmodified boards purchased
via an authorized distributor within the first 90 days. All repaired
board will have their flash reset to factory contents. For repairs and
replacements, please contact ‘support’ at BeagleBoard.org using the RMA
form:
- `RMA request <https://beagleboard.org//support/rma>`__
Understanding Your Beagle
-------------------------
- `BeagleBone Introduction <https://beagleboard.org/Support/bone101>`__
- `Hardware <https://beagleboard.org/Support/Hardware+Support>`__
- `Software <https://beagleboard.org/Support/Software+Support>`__
- `BoneScript JavaScript
library <https://beagleboard.org/Support/bonescript>`__
- `Books <https://beagleboard.org/books>`__
- `Exploring BeagleBone <https://beagleboard.org/ebb>`__
- `BeagleBone Cookbook <https://beagleboard.org/cookbook>`__
- `Bad to the Bone <https://beagleboard.org/bad-to-the-bone>`__
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

Open hardware computers for makers, educators and professionals