Fetching contributors…
Cannot retrieve contributors at this time
503 lines (471 sloc) 31.7 KB
<!DOCTYPE html>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
<title>Getting started with Beagle</title>
<meta name="keywords" content="Beagle Board, BeagleBoard,, BeagleBone, BeagleBoard-xM, bealgeboard, open hardware, open source, Linux, computer" />
<link href="" rel="alternate" title="Beagle Board news feed" type="application/atom+xml" />
<link rel="icon" href="Docs/beagle.ico" type="image/x-icon" />
<link rel="shortcut icon" href="Docs/beagle.ico" type="image/x-icon" />
<link rel="publisher" href="" />
<style type="text/css" media="screen">@import "Docs/common.css";</style>
<style type="text/css" media="screen">@import "Docs/login.css";</style>
<style type="text/css" media="screen">@import "Docs/beagle.css";</style>
<script type="text/javascript" src="Docs/jquery.js"></script>
<script type="text/javascript" src="Docs/jquery.ui.core.js"></script>
<script type="text/javascript" src="Docs/jquery.ui.widget.js"></script>
<div class="top">
<div class="top-header"><a href="/"><img src="Docs/images/beagle_logo_326x60.png" alt="Beagle Board -" style="background:white;border:0;width:326;height:60;" /></a>
<div class="social">
<span style="padding-left:8px"><a href=""><img src= "Docs/images/icon_facebook.png" style="width:27;height:28;border:0" alt="facebook" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_twitter.png" style="width:27;height:28;border:0" alt="twitter"/></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_linkedin.png" style="width:27;height:28;border:0" alt="linkedin" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/youTube-icon.png" style="width:27;height:28;border:0" alt="YouTube" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_google+.png" style="width:27;height:28;border:0" alt="google+"/></a></span>
<a id="top"></a>
<!-- DIV that centers page - START -->
<div id="wrapper">
<!--start menu bar-->
<div id='cssmenu'>
<li class='has-sub'><a href=''><span>Start &#8659;</span></a>
<li class='has-sub'><a href=''><span>About Us</span></a></li>
<li class='has-sub'><a href=''><span>Getting Started</span></a></li>
<li class='has-sub'><a href=''><span>Latest Software Images</span></a></li>
<li class='has-sub'><a href=''><span>Subscribe to Newsletter</span></a></li>
<li class='has-sub'><a href=''><span>Discover Boards &#8659;</span></a>
<li class='has-sub'><a href=''><span>&#9654; BeagleBone Black &#9664;</span></a></li>
<li class='has-sub'><a href=''><span>&#9654; BeagleBone Black Wireless &#9664;</span></a></li>
<li class='has-sub'><a href=''><span>SeeedStudio BeagleBone Green</span></a></li>
<li class='has-sub'><a href=''><span>SeeedStudio BeagleBone Green Wireless</span></a></li>
<li class='has-sub'><a href=''><span>BeagleBone Capes</span></a></li>
<li class='has-sub'><a href=''><span>BeagleBone</span></a></li>
<li class='has-sub'><a href=''><span>&#9654; BeagleBoard-X15 &#9664;</span></a></li>
<li class='has-sub'><a href=''><span>BeagleBoard-xM</span></a></li>
<li class='has-sub'><a href=''><span>BeagleBoard</span></a></li>
<li class='has-sub'><a href=''><span>Learn &#8659;</span></a>
<li class='has-sub'><a href=''><span>Introduction</span></a></li>
<li class='has-sub'><a href='' target="_blank"><span>Books &#10138;</span></a></li>
<li class='has-sub'><a href='' target="_blank"><span>Wiki &#10138;</span></a></li>
<li class='has-sub'><a href=''><span>Hardware Support</span></a></li>
<li class='has-sub'><a href=''><span>Software Support</span></a></li>
<li class='has-sub'><a href='' target="_blank"><span>Adafruit Tutorials &#10138;</span></a></li>
<li class='has-sub'><a href=''><span>BoneScript Library</span></a></li>
<li class='has-sub'><a href=''><span>FAQ</span></a></li>
<li class='has-sub'><a href=''><span>Explore &#8659;</span></a>
<li class='has-sub'><a href=''><span>Blog</span></a></li>
<li class='has-sub'><a href=''><span>Projects</span></a></li>
<li class='has-sub'><a href=''><span>Google Summer of Code</span></a></li>
<li class='has-sub'><a href=''><span>Videos</span></a></li>
<li class='has-sub'><a href=''><span>Collaborate &#8659;</span></a>
<li class='has-sub'><a href=''><span>Live Chat</span></a></li>
<li class='has-sub'><a href=''><span>Forums</span></a></li>
<li class='has-sub'><a href=''><span>Register Project</span></a></li>
<li class='has-sub'><a href=''><span>Subscribe to Newsletter</span></a></li>
<li class='has-sub'><a href='' target="_blank"><span>Github &#10138;</span></a></li>
<div id="search">
<ul><li class="google">
<form action="" id="cse-search-box">
<input type="hidden" name="cx" value="001071468846613058269:xd-gxvzmbq4" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" style="width:180px;" />
<input class="btn1" type="submit" name="sa" value="Search"/>
<script type="text/javascript" src=";lang=en"></script>
<!--end menu bar-->
<div id="content">
<div id="contentbuffer">
<div id="page">
<!-- body START -->
<a href=""><img style="position: absolute; top: 0; right: 0; border: 0;" src="" alt="Fork me on GitHub" data-canonical-src=""></a>
<script type="text/javascript" src="Docs/beagle-ui.js"></script>
<script type="text/javascript" src="Docs/bonescript.js"></script>
var step1done = false;
var testedOnce = false;
function testForCompletedSteps() {
if(!testedOnce) {
testedOnce = true;
if(typeof ga == "function") {
ga('send', 'event', 'bonescript', 'started', 'getting-started');
if(!step1done && window.location.toString().match(/^file.*BEAGLEBONE\/START.htm$/)) {
step1done = true;
if(typeof ga == "function") {
ga('send', 'event', 'bonescript', 'plugged-in', 'getting-started');
function foundBone(host) {
console.log("Found BeagleBone at " + host);
$('a.bonelink').each(function(i){ $(this).attr('href',"http://"+host); });
$('a#bonelinktext').html("http://" + host);
'<li><a href="http://' + host + '/" class="external">Web server</a></li>' +
'<li><a href="http://' + host + ':3000/" class="external">Cloud9 IDE</a></li>' +
'<li><a href="ssh://debian@' + host + '/" class="external">SSH server</a></li>' +
'<li><a href="http://' + host + ':1880/" class="external">Node-RED</a></li>'
step1done = true;
if(typeof ga == "function") {
ga('send', 'event', 'bonescript', 'connected7', 'getting-started');
<div id="floatMenu">
<ul id="quickLinks" style="display:none;">
<li id="fmStep1"><a href="#step1"><strong>Step 1:</strong><br />
Power and boot</a></li>
<li id="fmStep2"><a href="#step2"><strong>Step 2:</strong><br />
Enable a network connection</a></li>
<li id="fmStep3"><a href="#step3"><strong>Step 3:</strong><br />
Browse to web server on Beagle</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#update">Update to latest software</a></li>
<li><a href="#distros">Other software options</a></li>
<li><a href="#hardware">Hardware documentation</a></li>
<li><a href="#books">Books</a></li>
<div id="gettingstarted">
<h1>Start your Beagle</h1>
<p>Beagles are tiny computers with the capability of modern systems,
without the bulk, expense, or noise.
Read the step-by-step getting started tutorial below to begin developing with your Beagle in minutes.</p>
<p>For user supplied tips on getting started, visit the eLinux (or other) community wiki pages:</p>
<li><a class="external" href="">BeagleBoard</a></li>
<li><a class="external" href="">BeagleBoard-xM</a></li>
<li><a class="external" href="">BeagleBoard-X15</a></li>
<li><a class="external" href="">BeagleBone</a></li>
<li><a class="external" href="">BeagleBone Black</a></li>
<li><a class="external" href="">BeagleBone Black Wireless</a></li>
<li><a class="external" href="">BeagleBone Blue</a></li>
<li><a class="external" href="">SeeedStudio BeagleBone Green</a></li>
<li><a class="external" href="">SeeedStudio BeagleBone Green Wireless</a></li>
<li><a class="external" href="">SanCloud BeagleBone Enhanced</a></li>
<li><a class="external" href="">Neuromeka BeagleBone Air</a></li>
<h3><em>If any step fails, it is recommended to update to the <a href="#update">latest
software image</a> to use the instructions below.</em></h3>
<h3 id="step1"><img class="steps" src="Docs/images/btn_step1.gif" />
<strong>Power and boot</strong></h3>
<p>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. You'll connect
the <a href="" class="external">"type-B" plug</a> of
the USB cable to your Beagle and the "type-A" plug to your computer.
<em>Note that BeagleBoard-X15 must
always be powered instead by a 12V adapter with a barrel jack.</em></p>
<p>Alternatively, for Beagles other than BeagleBoard-X15 and BeagleBone Blue
that require 12V, you can utilize a 5V adapter connected to the barrel
<p>If your Beagle was provided with an <a href="" class="external">SD (microSD) card</a>, 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.
<p>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.</p>
<li>USR0 is typically configured at boot to blink in a heartbeat pattern</li>
<li>USR1 is typically configured at boot to light during SD (microSD) card accesses</li>
<li>USR2 is typically configured at boot to light during CPU activity</li>
<li>USR3 is typically configured at boot to light during eMMC accesses</li>
<li>WIFI is typically configured at boot to light with WiFi network association (<em>BeagleBone Blue only</em>)</li>
<img align="center" width="85%" src="Docs/images/BlackUSR.png" />
<h3 id="step2"><img class="steps" src="Docs/images/btn_step2.gif" /><strong>Enable a network connection</strong></h3>
<p>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 or, depending on the type of USB network adapter supported by your computer's operating system. Your Beagle will reserve or for itself.</p>
<p>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 for itself.</p>
<p>If your Beagle is connected to your local area network (LAN) via either Ethernet or WiFi, it will utilize <a href="" class="external">mDNS</a> to broadcast itself to your computer. If your computer supports mDNS, you should see your Beagle as beaglebone.local. <em>Non-BeagleBone boards will utilize alternate names. Multiple BeagleBone boards on the same network will add a suffix such as beaglebone-2.local.</em></p>
<p>The below table summarizes the typical addresses and should dynamically update to indicate an active connection. <em>Note that you must load <a href="">this page</a> without HTTPS security for the automatic detection to work.</em></p>
<table border="0">
<th>IP Address</th>
<th>Connection Type</th>
<th>Operating System(s)</th>
<td><iframe style="height:15px;width:90px;" frameborder="0" sandbox="allow-same-origin allow-scripts" src="Docs/testconn.htm?host=">Inactive</iframe></td>
<td>Mac OS X, Linux</td>
<td><iframe style="height:15px;width:90px;" frameborder="0" sandbox="allow-same-origin allow-scripts" src="Docs/testconn.htm?host=">Inactive</iframe></td>
<td><iframe style="height:15px;width:90px;" frameborder="0" sandbox="allow-same-origin allow-scripts" src="Docs/testconn.htm?host=">Inactive</iframe></td>
<td>mDNS enabled</td>
<td><iframe style="height:15px;width:90px;" frameborder="0" sandbox="allow-same-origin allow-scripts" src="Docs/testconn.htm?host=beaglebone.local">Inactive</iframe></td>
<td>mDNS enabled</td>
<td><iframe style="height:15px;width:90px;" frameborder="0" sandbox="allow-same-origin allow-scripts" src="Docs/testconn.htm?host=beaglebone-2.local">Inactive</iframe></td>
<p>With the latest images, <em>it should no longer be necessary to install drivers</em> 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.</p>
<table border="0">
<th>Operating System</th>
<th>USB Drivers</th>
<td>Windows (64-bit)</td>
<a target="_blank" href="">64-bit installer</a>
<td rowspan="2">
<p>If in doubt, try the 64-bit installer first.</p>
<li><b>Note #1:</b> Windows Driver Certification warning may pop up two or three times. Click "Ignore", "Install" or "Run"</li>
<li><b>Note #2:</b> To check if you're running 32 or 64-bit Windows see this: <a class="external" target="_blank" href=""></a>.</li>
<li><b>Note #3:</b> On systems without the latest service release, you may get an error (0xc000007b). In that case, please install the following and retry: <a class="external" target="_blank" href=""></a>.</li>
<li><b>Note #4:</b> You may need to reboot Windows.</li>
<li><b>Note #5:</b> These drivers have been tested to work up to Windows 10</li>
<td>Windows (32-bit)</td>
<a target="_blank" href="">32-bit installer</a>
<td>Mac OS X</td>
<a target="_blank" href="">Network</a><br />
<a target="_blank" href="">Serial</a><br />
<td>Install both sets of drivers.</td>
<a target="_blank" href=""></a>
<td>Driver installation isn't required, but you might find a few udev rules helpful.</td>
<p><b>Note:</b> Additional FTDI USB to serial/JTAG information and drivers are available from
<a class="external" target="_blank" href=""></a>.
<p><b>Note:</b> Additional USB to virtual Ethernet information and drivers are available from
<a target="_blank" class="external" href=""></a> and
<a target="_blank" class="external" href=""></a>.
<h3 id="step3"><img class="steps" src="Docs/images/btn_step3.gif" /><strong>Browse to your Beagle</strong></h3>
<p>Using either <a class="external" target="_blank" href="">Chrome</a> or <a target="_blank" href="" class="external">Firefox</a> (Internet Explorer will <b>NOT</b> 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.</p>
<ul class="arrow">
<li>Click here to launch: <a id="bonelinktext" class="bonelink external" href=""></a><br />
<small>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.</small>
<a class="bonelink" href=""><img src="Docs/images/bone101.png" width="600px" /></a>
<h2 id="troubleshooting">Troubleshooting</h2>
<p><em>Do not use Internet Explorer.</em></p>
<p>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.</p>
<p>When using 'ssh' with the provided image, the username is 'debian' and the password is 'temppwd'.</p>
<p>Visit <a href=""></a> for additional debugging tips.</p>
<h2 id="update">Update board with latest software</h2>
<h3>Step #1: Download the latest software image</h3>
<p>Download the lastest Debian image from <a href=""></a>. The "IoT" images provide more free disk space if you don't need to use a graphical user interface (GUI).</p>
<p><small><b>Note:</b>&nbsp;Due to sizing necessities, this download may take 30 minutes or more.</small></p>
<p>The Debian distribution ships with the boards. The file you download will have an .img.xz extension. This is a compressed sector-by-sector image of the SD card.</p>
<img src="Docs/images/download-latestimage.png" width="50%" />
<h3>Step #2: Install SD card programming utility</h3>
<p>Download and install <a target="_blank" href="">Etcher</a>.</p>
<img src="Docs/images/download-etcher.png" width="50%" /><br />
<img src="Docs/images/install-etcher.png" width="50%" /><br />
<p>Some general help on programming SD cards can be found on the <a target="_blank" href="">Ubuntu Image Writer page</a>.
<h3>Step #3: Connect SD card to your computer</h3>
<p>Use your computer's SD slot or a USB adapter to connect the SD card to your computer.</p>
<h3>Step #4: Write the image to your SD card</h3>
<p>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.</p>
<img src="Docs/images/write-latestimage.png" width="50%" />
<h3>Step #5: Eject the SD card</h3>
<p>Eject the newly programmed SD card.</p>
<h3>Step #6: Boot your board off of the SD card</h3>
<p>Insert SD card into your (powered-down) board, hold down the USER/BOOT/SD button (if your board has one) and apply power.<em>Note: this button will change the ROM boot mode of the processor on you board to prevent it from loading code from the on-board flash. If the software on you board was fairly recent and functional, pressing this button is completely optional.</em></p>
<p>If using a Beagle without on-board eMMC flash, you are done.</p>
<h3>Step #7: Program your on-board blash (BeagleBone Black and boards with eMMC flash only)</h3>
<p>If using BeagleBone Black or another Beagle with on-board eMMC flash and you want to write the image to your on-board eMMC, you'll need to follow the instructions at <a href=""></a>
and use an eMMC flasher image or turn one of the above downloaded images into one. The process for converting an image into an eMMC flasher image is summarized below.</p>
<p>When booted, edit the /boot/uEnv.txt file on the Linux partition on the microSD card and remove the '#' on the line with 'cmdline=init=/opt/scripts/tools/eMMC/'. Enabling this will cause booting the microSD card to flash the eMMC. eMMC flasher images are no longer immediately recommended to avoid people accidentally overwriting their eMMC flash.</p>
<p>Shutdown cleanly and repeat Step #6.</p>
<p>You'll now need to wait while the programming occurs. When the flashing is complete, all 4 USRx LEDs will be lit solid.</p>
<p><b>Note</b>: <em>This can take up to 30 minutes.</em></p>
<p>Power-down your board, remove the SD card and apply power again to be complete.</p>
<h2 id="distros">Other currently available software images</h2>
<p>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.</p>
<p>At the time of release, not all of these distributions support BeagleBone Black, but should soon.</p>
<ul class="arrow">
<li>Texas Instruments releases:
<a target="_blank" href="">
<a target="_blank" href="">
<a target="_blank" href="">
StarterWare (no OS)</a>
<a target="_blank" href="">Debian</a>,
<a target="_blank" href="">Angstrom Distribution</a>,
<a target="_blank" href="">Ubuntu</a>,
<a target="_blank" href="">ArchLinux</a>,
<a target="_blank" href="">Gentoo</a>,
<a target="_blank" href="">Sabayon</a>,
<a target="_blank" href="">Buildroot</a>,
<a target="_blank" href="">Erlang</a>,
<a target="_blank" href="">Fedora</a>
<a target="_blank" href="">QNX</a>,
<a target="_blank" href="">FreeBSD</a>
<li><a target="_blank" href="">Projects page</a></li>
<h2 id="hardware">Hardware documentation</h2>
<p>The <a class="external" target="_blank" href="">
BeagleBoneBlack wiki page</a> documents all of the known hardware issues, as well as the latest available software, hardware
hardware documentation and design materials.
<p>Time to read that manual and check out the design materials:
<a class="external" href="">BeagleBoard</a>,
<a class="external" href="">BeagleBoard-xM</a>,
<a class="external" href="">BeagleBoard-X15</a>,
<a class="external" href="">BeagleBone</a>,
<a class="external" href="">BeagleBone Black</a>,
<a class="external" href="">BeagleBone Black Wireless</a>, and
<a class="external" href="">BeagleBone Blue</a>.</p>
<p>Other links to design materials for various releases can be found at
<a class="external" href=""></a>.</p>
<h2 id="books">Books</h2>
<p>For a complete list of books on BeagleBone, see
<a href="" class="external"></a>.</p>
<div style="display:table;"><div style="display:table-cell;padding:10px;">
<a href=""><img style="width:98px;height:95px;" src="Docs/images/bad-to-the-bone.jpg" /></a>
</div><div style="display:table-cell;padding:10px;">
<a href=""><img style="width:98px;height:95px;" src="Docs/images/beaglebone-cookbook.jpg" /></a>
</div><div style="display:table-cell;padding:10px;">
<a href=""><img style="width:98px;height:95px;" src="Docs/images/exploring-beaglebone.jpg" /></a>
</div><div style="display:table-cell;padding:10px;">
<a href=""><img style="width:98px;height:95px;" src="Docs/images/embedded-linux-primer.jpg" /></a>
<h3><a href="" class="external">Bad to the Bone</a></h3>
<p>Perfect for high-school seniors or freshman univerisity level text, consider using "Bad to the Bone"</p>
<h3><a href="" class="external">BeagleBone Cookbook</a></h3>
<p>A lighter treatment suitable for a bit broader audience without the backgrounders on
programming and electronics, consider "BeagleBone Cookbook"
<h3><a href="" class="external">Exploring BeagleBone</a> and <a href="" class="external">Embedded Linux Primer</a></h3>
<p>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.
<!-- Content Area - END -->
<div style="clear:both;"></div>
<!-- body END -->
</div><!-- page -->
<div style="clear:both;"></div>
</div><!-- contentbuffer> </div><!-- content -->
<!-- Footer - START -->
<!--start footer-->
<div class="footer">
<div class="social">
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_facebook.png" style="width:27;height:28;border:0;" alt="facebook" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_twitter.png" style="width:27;height:28;border:0;" alt="twitter" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_linkedin.png" style="width:27;height:28;border:0" alt="linkedin" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/youTube-icon.png" style="width:27;height:28;border:0;" alt="YouTube" /></a></span>
<span style="padding-left:8px"><a href=""><img src="Docs/images/icon_google+.png" style="width:27;height:28;border:0;" alt="google+" /></a></span>
<div id="footer-col1">
<li><a href="">Boards</a></li>
<li><a href="">Getting Started</a></li>
<li><a href="">Support</a></li>
<div id="footer-col2">
<li><a href="">Community</a></li>
<li><a href="">Projects</a></li>
<li><a href="">Videos</a></li>
<div id="footer-col3">
<li><a href="">About Us</a></li>
<li><a href="">Privacy policy</a></li>
<li><a href="">Terms of Use</a></li>
<div id="cc"><a href="" target="_blank"><img src="Docs/images/88x31.png" alt="Creative Commons - Conditions - Attribution and Share Alike" style="width:88;height:31;border:0;" /></a><span style="padding-left:8px">Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 license </span></div>
<!-- Footer - END -->
<!-- DIV that centers page - END -->