| blob | bfd9b42d69662ba1a7a78f92cace62476b36ae77 |
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <?xml-stylesheet type="text/xsl" href="helma.xsl"?>
3 <xmlroot xmlns:hop="http://www.helma.org/docs/guide/features/database">
4 <hopobject id="2765" name="bone101" prototype="Page" created="1371588720910" lastModified="1386714261059">
5 <hop:parent idref="121" prototyperef="Page"/>
6 <is_xhtml type="boolean">true</is_xhtml>
7 <http_remotehost>68.43.104.104</http_remotehost>
8 <http_language>en-US,en;q=0.8</http_language>
9 <uri>bone101</uri>
10 <http_browser>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.63 Safari/537.36</http_browser>
11 <time type="date">10.12.2013 16:24:21 CST</time>
12 <hopsession>68.43.104.occnfohvio7s</hopsession>
13 <body><h2>BeagleBone 101</h2>\r
14 \r
15 <div id='side-menu' class="t3_sidebar">\r
16 <ul class="left-menu">\r
17 <strong>Navigation</strong>\r
18 <li><a href="/Support/BoneScript/menu/">Menu contents</a></li>\r
19 </ul>\r
20 </div>\r
21 <div class="t3_content_1">\r
22 <div id='connect-status'></div>\r
23 <div id="content_child">\r
24 <!--- START CONTENT -->\r
25 <h1>BeagleBone: open-hardware expandable computer</h1>\r
26 <h2>Artist-tested, engineer approved</h2>\r
27 <p>The left-hand navigation bar will help you explore\r
28 your board and learn how to program it.\r
29 </p>\r
30 <img src="/static/images/artist-tested-engineer-approved.jpg" />\r
31 \r
32 <h2 id="software"></h2>\r
33 <h2>Latest ARM open source focused on easy hardware experimentation</h2>\r
34 <ul>\r
35 <img src="/static/images/beaglebone-in-hand.JPG" align="right" width="25%" />\r
36 <li>Ships ready to use<ul>\r
37 <li>Angstrom Distribution with C++, Perl, Python, ...</li>\r
38 <li>Linux drivers support countless USB peripherals</li>\r
39 <li>Interactive tutorial to start learning about capabilities</li>\r
40 </ul></li>\r
41 <li>Open source means options<ul>\r
42 <li>Texas Instruments releases:\r
43 <a target="_blank" href="http://beagleboard.org/project/rowboat">Android</a>,\r
44 <a target="_blank" href="http://beagleboard.org/project/amsdk">Linux</a>,\r
45 <a target="_blank" href="http://beagleboard.org/project/starterware">StarterWare (no OS)</a>\r
46 </li>\r
47 <li>Linux: \r
48 <a target="_blank" href="http://beagleboard.org/project/angstrom">Angstrom Distribution</a>,\r
49 <a target="_blank" href="http://beagleboard.org/project/ubuntu">Ubuntu</a>,\r
50 <a target="_blank" href="http://beagleboard.org/project/debian">Debian</a>,\r
51 <a target="_blank" href="http://beagleboard.org/project/AM/">ArchLinux</a>,\r
52 <a target="_blank" href="http://beagleboard.org/project/sabayon/">Sabayon</a>,\r
53 <a target="_blank" href="http://beagleboard.org/project/buildroot/">Buildroot</a>,\r
54 <a target="_blank" href="http://beagleboard.org/project/Nerves/">Erlang</a>,\r
55 <a target="_blank" href="http://beagleboard.org/project/fedora/">Fedora</a>\r
56 </li>\r
57 <li>Other:\r
58 <a target="_blank" href="http://beagleboard.org/project/QNX+Neutrino+on+OMAP/">QNX</a>,\r
59 <a target="_blank" href="http://beagleboard.org/project/freebsd/">FreeBSD</a>\r
60 </li>\r
61 <li><a target="_blank" href="http://beagleboard.org/project">Projects page</a></li>\r
62 </ul></li>\r
63 <img align="right" src="/static/images/imager.png" width="30%" />\r
64 <li>SD card images like get-out-of-jail-free card\r
65 <pre>xzcat XXX.img.xz | sudo dd of=/dev/sdX</pre>\r
66 <ul>\r
67 <li>Can be used just as easily for backups</li>\r
68 <li>Board can be booted from SD using device ROM, so you can't "brick" it</li>\r
69 <li> \r
70 <a href="http://http://www.7-zip.org/">7-zip</a> \r
71 and\r
72 <a href="https://wiki.ubuntu.com/Win32DiskImager">\r
73 Ubuntu Win32DiskImager\r
74 </a>\r
75 enable programming cards from Windows\r
76 </li>\r
77 </ul>\r
78 </li>\r
79 </ul>\r
80 \r
81 <h2 id="updates"><a href="/Support/BoneScript/updates/">Update board with\r
82 latest software</a></h2>\r
83 <p>There are multiple ways to run initial software on your board, but\r
84 it is likley that the simplest way to get an update is to create an\r
85 exact replica of a bootable microSD card and boot off of it. The\r
86 BeagleBone Black has 2GB of eMMC storage that can be initialized by\r
87 a program booted off of a microSD card. If you want to update to the\r
88 latest software image for your board, this is a way to do that.</p>\r
89 <p>See <a href="/Support/BoneScript/updates/">updates</a> for the\r
90 step-by-step guide.</p>\r
91 <p>Information about getting the source code for the image shipped with\r
92 your board can be found at <a target="_blank" href="http://beagleboard.org/angstrom">\r
93 beagleboard.org/angstrom</a>, along with instructions for rebuilding it.</p>\r
94 \r
95 <h2 id="bonescript"><a href="/Support/BoneScript/">Bonescript interactive \r
96 guide</a></h2>\r
97 <p>Bonescript is a JavaScript library to simplify learning how to perform\r
98 physical computing tasks using your embedded Linux. This web page is able\r
99 to interact with your board to provide an interactive tutorial.\r
100 </p>\r
101 <h3>Example\r
102 <button class="dynlink" onclick="demoRun('code')">run</button>\r
103 <button class="dynlink" onclick="demoRestore('code'); restore()">restore</button>\r
104 </h3>\r
105 <pre id="code" class="use-editor">\r
106 var b = require('bonescript');\r
107 b.pinMode('USR0', b.OUTPUT);\r
108 b.pinMode('USR1', b.OUTPUT);\r
109 b.pinMode('USR2', b.OUTPUT);\r
110 b.pinMode('USR3', b.OUTPUT);\r
111 b.digitalWrite('USR0', b.HIGH);\r
112 b.digitalWrite('USR1', b.HIGH);\r
113 b.digitalWrite('USR2', b.HIGH);\r
114 b.digitalWrite('USR3', b.HIGH);\r
115 setTimeout(restore, 2000);\r
116 </pre>\r
117 <script>\r
118 function restore() {\r
119 var b = require('bonescript');\r
120 var p = '/sys/class/leds/beaglebone:green:usr';\r
121 b.digitalWrite('USR0', b.LOW);\r
122 b.digitalWrite('USR1', b.LOW);\r
123 b.digitalWrite('USR2', b.LOW);\r
124 b.digitalWrite('USR3', b.LOW);\r
125 resetUSR0();\r
126 function resetUSR0() {\r
127 b.writeTextFile(p+'0/trigger', 'heartbeat', resetUSR1);\r
128 }\r
129 function resetUSR1() {\r
130 b.writeTextFile(p+'1/trigger', 'mmc0', resetUSR2);\r
131 }\r
132 function resetUSR2() {\r
133 b.writeTextFile(p+'2/trigger', 'cpu0', resetUSR3);\r
134 }\r
135 function resetUSR3() {\r
136 b.writeTextFile(p+'3/trigger', 'mmc1', complete);\r
137 }\r
138 function complete() {\r
139 }\r
140 }\r
141 </script>\r
142 <p>Running the above example will cause all of your LEDs to light up at once for a\r
143 couple of seconds.\r
144 </p>\r
145 <p>To learn more about Bonescript, please continue exploring \r
146 <a href="/Support/BoneScript/">this interactive guide</a>.\r
147 </p>\r
148 \r
149 <h2 id="cloud9"><a target="_blank" class="cloud9-url" href="http://192.168.7.2:3000">Cloud9 IDE</a></h2>\r
150 <p>To begin editing programs that live on your board, you can use the Cloud9 IDE.</p>\r
151 <p>Click on the "Cloud9 IDE" link above to start the editor.</p>\r
152 <a target="_blank" class="cloud9-url">\r
153 <img src="/static/images/Cloud9_Screen.png" width="100%" />\r
154 </a>\r
155 \r
156 <p>As a simple exercise to become familiar with <a href="http://c9.io" target="_blank">Cloud9 IDE</a> and the <a target="_blank" href="http://beagleboard.org/project/bonescript">Bonescript JavaScript library</a>, creating a simple application to blink one of the 4 user programmable LEDs on the BeagleBone is a good start.</p>\r
157 <ul class="action">\r
158 <li><b>Step A:</b> Close any open file tabs.<br /><br />\r
159 <img src="/static/images/c9-close-tab.png" /><br /><br />\r
160 </li>\r
161 <li><b>Step B:</b> Click the "+" in the top-right to create a new file.<br /><br />\r
162 <img src="/static/images/c9-create-tab.png" /><br /><br />\r
163 <img src="/static/images/c9-new-tab.png" /><br /><br />\r
164 </li>\r
165 <li><b>Step C:</b> Cut and paste the following code into the new tab:<br />\r
166 <pre>\r
167 var b = require('bonescript');\r
168 \r
169 var state = b.LOW;\r
170 \r
171 b.pinMode("USR0", b.OUTPUT);\r
172 b.pinMode("USR1", b.OUTPUT);\r
173 b.pinMode("USR2", b.OUTPUT);\r
174 b.pinMode("USR3", b.OUTPUT);\r
175 setInterval(toggle, 1000);\r
176 \r
177 function toggle() {\r
178 if(state == b.LOW) state = b.HIGH;\r
179 else state = b.LOW;\r
180 b.digitalWrite("USR3", state);\r
181 }</pre>\r
182 </li>\r
183 <li><b>Step D:</b> Save the file by clicking the disk icon and giving the file a name with the .js extension.<br /><br />\r
184 <img src="/static/images/c9-disk-icon.png" /><br /><br />\r
185 <img src="/static/images/c9-save-name.png" /><br /><br />\r
186 <img src="/static/images/c9-save-name-complete.png" /><br /><br />\r
187 <img src="/static/images/c9-named-tab.png" /><br /><br />\r
188 </li>\r
189 <li><b>Step E:</b> Run the code by selecting the arrow to the right of "run" (or "debug") in the toolbar to pull down the list of files to run and select your new file.<br /><br />\r
190 <img src="/static/images/c9-run.png" /><br /><br />\r
191 </li>\r
192 <li><b>Step F:</b> Observe the BeagleBone USR3 LED blinking steadily about 5 times a second.<br /><br />\r
193 </li>\r
194 <li><b>Step G:</b> Stop the code by clicking "stop" in the toolbar.<br /><br />\r
195 <img src="/static/images/c9-stop.png" /><br /><br />\r
196 </li>\r
197 </ul>\r
198 <p>Additional information about the Bonescript library is available in the presentation viewed in the next step and on-line at <a target="_blank" href="http://beagleboard.org/project/bonescript">http://beagleboard.org/project/bonescript</a>.</p>\r
199 <h3>Autorun</h3>\r
200 <p>Once you've finished developing your JavaScript application, you can have it start upon boot-up by simply\r
201 dropping it into the 'autorun' subfolder (located at /var/lib/cloud9/autorun in the file system).\r
202 </p>\r
203 <p>The systemd bonescript-autorun.service runs at start-up and uses the /usr/lib/node_modules/bonescript/autorun.js\r
204 script to automatically detect when .js files are in this directory and invoke them as separate processes with\r
205 node.js. When the files are changed or moved, the script will kill the processes.\r
206 </p>\r
207 <h3>Resources</h3>\r
208 <p>To learn more about Cloud9 IDE and to synchronize the software on your board with cloud-hosted services, see\r
209 <a target="_blank" href="http://c9.io">www.c9.io</a>.\r
210 <p>For more information on Node.JS, the JavaScript interpreter, see <a target="_blank" href="http://nodejs.org">www.nodejs.org</a>.\r
211 Note that version 0.8.22 is what is currently installed on the default image and you can find the api documentation\r
212 at <a target="_blank" href="http://nodejs.org/docs/v0.8.22/api">www.nodejs.org/docs/v0.8.22/api</a>.\r
213 </p>\r
214 <p>For more information about the Bonescript library, see <a target="_blank" href="http://beagleboard.org/bonescript">\r
215 www.beagleboard.org/bonescript</a>.\r
216 </p>\r
217 \r
218 <h2 id="gateone"><a target="_blank" class="gateone-url" href="https://192.168.7.2">GateOne SSH client</a></h2>\r
219 <p><small><em>Note:</em> GateOne has been removed from the default image\r
220 due to performance and reliability concerns. We hope to bring it back\r
221 soon.\r
222 </small></p>\r
223 <p>GateOne provides a method for logging into the shell of your board without installing an\r
224 ssh client on your computer. Click on the "GateOne SSH client" link above to login.\r
225 </p>\r
226 <ul>\r
227 <li><em>Host/IP or SSH URL</em> - localhost</li>\r
228 <li><em>Port</em> - 22</li>\r
229 <li><em>User</em> - root</li>\r
230 <li><em>Password</em> - <empty></li>\r
231 </ul>\r
232 <p><small><em>Note</em>: If you get errors, you might need to set the date on your BeagleBone.\r
233 <button class="dynlink" onclick="setDate();">Set Date</button>\r
234 </small></p>\r
235 <a target="_blank" class="gateone-url">\r
236 <img src="/static/images/gateone.png" width="100%" />\r
237 </a>\r
238 <script>\r
239 function setDate() {\r
240 var b = require('bonescript');\r
241 b.setDate(Date().toString());\r
242 }\r
243 </script>\r
244 \r
245 <h3>List of common Linux commands</h3>\r
246 <table><tr>\r
247 <td><ul>\r
248 <li><em>pwd</em> - show current directory</li>\r
249 <li><em>cd</em> - change current directory</li>\r
250 <li><em>ls</em> - list directory contents</li>\r
251 <li><em>chmod</em> - change file permissions</li>\r
252 <li><em>chown</em> - change file ownership</li>\r
253 <li><em>cp</em> - copy files</li>\r
254 <li><em>mv</em> - move files</li>\r
255 <li><em>rm</em> - remove files</li>\r
256 <li><em>mkdir</em> - make directory</li>\r
257 <li><em>rmdir</em> - remove directory</li>\r
258 <li><em>cat</em> - dump file contents</li>\r
259 <li><em>less</em> - progressively dump file</li>\r
260 <li><em>vi</em> - edit file (complex)</li>\r
261 <li><em>nano</em> - edit file (simple)</li>\r
262 <li><em>head</em> - trim dump to top</li>\r
263 <li><em>tail</em> - trim dump to bottom</li>\r
264 </ul></td>\r
265 <td><ul>\r
266 <li><em>echo</em> - print/dump value</li>\r
267 <li><em>env</em> - dump environment variables</li>\r
268 <li><em>export</em> - set environment variable</li>\r
269 <li><em>history</em> - dump command history</li>\r
270 <li><em>grep</em> - search dump for strings</li>\r
271 <li><em>man</em> - get help on command</li>\r
272 <li><em>apropos</em> - show list of man pages</li>\r
273 <li><em>find</em> - search for files</li>\r
274 <li><em>tar</em> - create/extract file archives</li>\r
275 <li><em>gzip</em> - compress a file</li>\r
276 <li><em>gunzip</em> - decompress a file</li>\r
277 <li><em>du</em> - show disk usage</li>\r
278 <li><em>df</em> - show disk free space</li>\r
279 <li><em>mount</em> - mount disks</li>\r
280 <li><em>tee</em> - write dump to file in parallel</li>\r
281 <li><em>hexdump</em> - readable binary dumps</li>\r
282 </ul></td>\r
283 </tr></table>\r
284 \r
285 <h3>Other programming environments</h3>\r
286 <p>The board also ships with gcc, python and more that can be invoked directly from the command-line.</p>\r
287 \r
288 <h1 id="hardware">Hardware documentation</h1>\r
289 <p><a target="_blank" href="http://circuitco.com/support/index.php?title=BeagleBoneBlack">\r
290 CircuitCo.com's BeagleBoneBlack page</a> documents all of the known hardware issues, as well as the latest available software, \r
291 hardware documentation and design materials.\r
292 </p>\r
293 <p><em>Always read the System Reference Manual!!!</em></p>\r
294 \r
295 <h3><a href="http://beagleboard.org/hardware/design">Design materials</a></h3>\r
296 <p>Design materials for creating your own customized version of the hardware or for better\r
297 understanding the design are also linked from the traditional home of\r
298 "<a href="http://beagleboard.org/hardware/design">http://beagleboard.org/hardware/design</a>"\r
299 </p>\r
300 \r
301 <h3>BeagleBone Black hardware details</h3>\r
302 <img src="/static/images/black_hardware_details.png" width="100%" />\r
303 <p>Revision A5 also provides a POWER button that can be used to enter and exit hibernate modes once\r
304 that feature is implemented in the software.\r
305 </p>\r
306 \r
307 <h3 id="headers">Headers</h3>\r
308 <p>The expansion headers provide extensive I/O capabitilities.</p>\r
309 <img src="/static/images/cape-headers.png" width="100%" />\r
310 <p>Each digital I/O pin has 8 different modes that can be selected, including GPIO.</p>\r
311 <img src="/static/images/cape-headers-digital.png" width="100%" />\r
312 <p>In GPIO mode, each digital I/O can produce interrupts.</p>\r
313 <img id="headers-pwm" src="/static/images/cape-headers-pwm.png" width="100%" />\r
314 <p>Up to 8 digital I/O pins can be configured with pulse-width modulators (PWM) to\r
315 produce signals to control motors or create analog voltage levels, without taking\r
316 up any extra CPU cycles.\r
317 </p>\r
318 <img src="/static/images/cape-headers-analog.png" width="100%" />\r
319 <p><em>Make sure you don't input more than 1.8V to the analog input pins.</em></p>\r
320 <p>This is a single 12-bit analog-to-digital converter with 8 channels, 7 of which\r
321 are made available on the headers.\r
322 </p>\r
323 <img src="/static/images/cape-headers-serial.png" width="100%" />\r
324 <p>There is a dedicated header for getting to the UART0 pins and connecting a\r
325 debug cable. Five additional serial ports are brought to the expansion headers,\r
326 but one of them only has a single direction brought to the headers.\r
327 </p>\r
328 <img src="/static/images/cape-headers-i2c.png" width="100%" />\r
329 <p>The first I2C bus is utilized for reading EEPROMS on cape add-on boards and\r
330 can't be used for other digital I/O operations without interfering with that\r
331 function, but you can still use it to add other I2C devices at available\r
332 addresses.\r
333 </p>\r
334 <p>The second I2C bus is available for you to configure and use.</p>\r
335 <img src="/static/images/cape-headers-spi.png" width="100%" />\r
336 <p>For shifting out data fast, you might consider using one of the SPI ports.</p>\r
337 \r
338 <img src="/static/images/boris-cape.png" width="20%" align="right" />\r
339 <h1 id="capes"><a target="_blank" href="http://beaglebonecapes.com">Capes</a></h1>\r
340 <p>Capes are really just daughterboards for BeagleBone and BeagleBone Black, but\r
341 we refer to them enough that a short name makes sense. BeagleBone wears them, they\r
342 typically have a cut-out around the Ethernet connector that gives them a cape-like\r
343 shape and <em>Underdog is a Beagle</em>!\r
344 </p>\r
345 <p>The <a href="http://beaglebonecapes.com" target="_blank">beaglebonecapes.com</a>\r
346 site attempts to consolidate the currently available cape add-on boards for\r
347 BeagleBone and BeagleBone Black.\r
348 </p>\r
349 <img src="/static/images/what-is-a-cape.png" width="100%" />\r
350 <p>The types of capes available is quite diverse, from 3D printer capes and\r
351 touchscreen displays to wireless communications and FPGA-based prototyping tools.\r
352 </p>\r
353 <img src="/static/images/cape-eeprom.png" width="100%" />\r
354 <p>Every cape that utilizes pins on the expansion header is expected to notify\r
355 software on the board by providing contents within EEPROM connected to I2C2 with\r
356 an address from 0x54 to 0x57. To work with other capes, you can make your\r
357 address selectable between those values to avoid conflicts. It is also possible\r
358 to provide through connectors such that other capes can also get connections to\r
359 the cape header pins\r
360 </p>\r
361 <h3 id="headers-black">Headers on BeagleBone Black</h3>\r
362 <img src="/static/images/black-emmc-and-hdmi-pins.png" width="100%" />\r
363 <p>BeagleBone Black ships with two virtual capes already on it, one for the\r
364 on-board eMMC storage and one for the HDMI output. When configured for use\r
365 these virtual capes consume actual resources.\r
366 </p>\r
367 <p>If the eMMC is not placed in\r
368 reset, the MMC1* signals may not be used without potentially corrupting the\r
369 contents of your on-board eMMC---and possibly damaging the physical circuit\r
370 as well.\r
371 </p>\r
372 <p>The HDMI signals are all inputs to the HDMI device, so there is no need to\r
373 put the HDMI device into reset, but using those pins for other operations will\r
374 cause the HDMI output to be disrupted. However, note that the Linux software\r
375 typically allocates these for use by the HDMI driver, so your software might\r
376 not be able to get access to them without unloading that driver.\r
377 </p>\r
378 <h2>Cape demos</h2>\r
379 <ul>\r
380 <li><em><a href="/Support/BoneScript/cape_bacon/">Bacon\r
381 Cape</a></em> - Teach basic interactions</li>\r
382 </ul>\r
383 \r
384 <!--- START FOOTER -->\r
385 </div>\r
386 </div>\r
387 <div style="clear:both;"></div>\r
388 <script src="/static/bonescript-demo.js"></script></body>
389 <pseudoparent idref="121" prototyperef="Page"/>
390 <http_referer>http://beagleboard.org/Support/bone101/edit</http_referer>
391 <http_host>beagleboard.org</http_host>
392 <user>jkridner@gmail.com</user>
393 <lang>en-us</lang>
394 <hop:child idref="2807" prototyperef="Page"/>
395 <hop:child idref="2822" prototyperef="Page"/>
396 <hop:child idref="2823" prototyperef="Page"/>
397 <hop:child idref="2824" prototyperef="Page"/>
398 <hop:child idref="2849" prototyperef="Page"/>
399 <hop:child idref="3030" prototyperef="Page"/>
400 <hop:child idref="3170" prototyperef="Page"/>
401 <hop:child idref="3171" prototyperef="Page"/>
402 </hopobject>
403 </xmlroot>