Log updates
[beagleboard.org.git] / db / 2779.xml
blobb6e87cf3adf8baa84c9b515b8c4c1071f6921430
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="2779" name="digitalRead" prototype="Page" created="1371824739649" lastModified="1371824832512">
5   <hop:parent idref="2471" prototyperef="Page"/>
6     <is_xhtml type="boolean">true</is_xhtml>
7     <http_remotehost>127.0.0.1</http_remotehost>
8     <http_language>en-US,en;q=0.8</http_language>
9     <uri>digitalRead</uri>
10     <http_browser>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/27.0.1453.110 Safari/537.36</http_browser>
11     <time type="date">21.06.2013 09:27:12 CDT</time>
12     <hopsession>127.0.0.192.94.94.z5cudt01kfu3</hopsession>
13     <body>&lt;script src=&quot;/static/bonescript-demo.js&quot;&gt;&lt;/script&gt;\r
14     &lt;h2&gt;BoneScript&lt;/h2&gt;\r
16     &lt;div id=&apos;side-menu&apos; class=&quot;t3_sidebar&quot;&gt;\r
17      &lt;ul class=&quot;left-menu&quot;&gt;\r
18       &lt;strong&gt;Navigation&lt;/strong&gt;\r
19       &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/menu/&quot;&gt;Menu contents&lt;/a&gt;&lt;/li&gt;\r
20      &lt;/ul&gt;\r
21     &lt;/div&gt;\r
22     &lt;div class=&quot;t3_content_1&quot;&gt;\r
23      &lt;div id=&apos;connect-status&apos;&gt;&lt;/div&gt;\r
24      &lt;div id=&quot;content_child&quot;&gt;\r
26 &lt;h1&gt;digitalRead(pin, [callback])&lt;/h1&gt;\r
27 &lt;p&gt;Read the status of a digital I/O pin.&lt;/p&gt;\r
28 &lt;h2&gt;Arguments&lt;/h2&gt;\r
29 &lt;ul&gt;\r
30  &lt;li&gt;&lt;em&gt;pin&lt;/em&gt;: the &lt;a href=&quot;/Support/BoneScript/#pin&quot;&gt;BeagleBone pin&lt;/a&gt; identifier&lt;/li&gt;\r
31  &lt;li&gt;&lt;em&gt;callback&lt;/em&gt;: called upon completion&lt;/li&gt;\r
32 &lt;/ul&gt;\r
33 &lt;h2&gt;Return value&lt;/h2&gt;\r
34 &lt;ul&gt;\r
35  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/#HIGH&quot;&gt;HIGH&lt;/a&gt; if pin is HIGH&lt;/li&gt;\r
36  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/#LOW&quot;&gt;LOW&lt;/a&gt; if pin is LOW&lt;/li&gt;\r
37 &lt;/ul&gt;\r
38 &lt;h2&gt;callback(x)&lt;/h2&gt;\r
39 &lt;ul&gt;\r
40  &lt;li&gt;&lt;em&gt;x.value&lt;/em&gt;: return value&lt;/li&gt;\r
41  &lt;li&gt;&lt;em&gt;x.err&lt;/em&gt;: error status message&lt;/li&gt;\r
42 &lt;/ul&gt;\r
43 &lt;h2&gt;Example\r
44  &lt;button class=&quot;dynlink&quot; onclick=&quot;demoRun(&apos;code&apos;)&quot;&gt;run&lt;/button&gt;\r
45  &lt;button class=&quot;dynlink&quot; onclick=&quot;demoRestore(&apos;code&apos;)&quot;&gt;restore&lt;/button&gt;\r
46 &lt;/h2&gt;\r
47 &lt;pre id=&quot;code&quot; class=&quot;use-editor&quot; style=&quot;height: 140px;&quot;&gt;\r
48 var b = require(&apos;bonescript&apos;);\r
49 b.pinMode(&apos;P8_19&apos;, b.INPUT);\r
50 b.digitalRead(&apos;P8_19&apos;, printStatus);\r
51 function printStatus(x) {\r
52     console.log(&apos;x.value = &apos; + x.value);\r
53     console.log(&apos;x.err = &apos; + x.err);\r
54 }&lt;/pre&gt;\r
55 &lt;div readonly id=&apos;console-output&apos; style=&apos;height: 80px;&apos;&gt;&lt;/div&gt;\r
56 &lt;h2&gt;Build and execute instructions&lt;/h2&gt;\r
57 &lt;ul&gt;\r
58  &lt;li&gt;Apply 0V to P8_19 and run the example code.&lt;/li&gt;\r
59  &lt;li&gt;Apply 3.3V to P8_19 and run the example code again.&lt;/li&gt;\r
60  &lt;li&gt;Alter the code to look at inputs on other pins.&lt;/li&gt;\r
61 &lt;/ul&gt;\r
62 &lt;h2&gt;See also&lt;/h2&gt;\r
63 &lt;h3&gt;Topics&lt;/h3&gt;\r
64 &lt;ul&gt;\r
65  &lt;li&gt;&lt;a href=&quot;/Support/bone101/#headers&quot;&gt;BeagleBone expansion headers&lt;/a&gt;&lt;/li&gt;\r
66  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/#digitalio&quot;&gt;Digital I/O&lt;/a&gt;&lt;/li&gt;\r
67 &lt;/ul&gt;\r
68 &lt;h3&gt;Related functions&lt;/h3&gt;\r
69 &lt;ul&gt;\r
70  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/#require&quot;&gt;require&lt;/a&gt;&lt;/li&gt;\r
71  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/pinMode/&quot;&gt;pinMode&lt;/a&gt;&lt;/li&gt;\r
72  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/digitalWrite/&quot;&gt;digitalWrite&lt;/a&gt;&lt;/li&gt;\r
73  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/attachInterrupt/&quot;&gt;attachInterrupt&lt;/a&gt;&lt;/li&gt;\r
74 &lt;/ul&gt;\r
75 &lt;h3&gt;Examples&lt;/h3&gt;\r
76 &lt;ul&gt;\r
77  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/cape_bacon/&quot;&gt;Bacon Cape&lt;/a&gt;&lt;/li&gt;\r
78 &lt;/ul&gt;\r
79 &lt;/div&gt;&lt;/div&gt;\r
80 &lt;div style=&quot;clear:both;&quot;&gt;&lt;/div&gt;</body>
81     <pseudoparent idref="2471" prototyperef="Page"/>
82     <http_referer>http://beagleboard.org/support/BoneScript/digitalRead/edit</http_referer>
83     <http_host>beagleboard.org</http_host>
84     <user>blog.hangerhead.com</user>
85     <lang>en-us</lang>
86   </hopobject>
87 </xmlroot>