Web edits
[beagleboard.org.git] / db / 2479.xml
blob8959d3a93fcaf43323f4861ea4d48785bb06613e
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="2479" name="pinMode" prototype="Page" created="1366437568700" lastModified="1376929152814">
5   <hop:parent idref="2471" prototyperef="Page"/>
6     <is_xhtml type="boolean">true</is_xhtml>
7     <http_remotehost>192.94.94.105</http_remotehost>
8     <http_language>en-US,en;q=0.8</http_language>
9     <uri>pinMode</uri>
10     <http_browser>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36</http_browser>
11     <time type="date">19.08.2013 11:19:12 CDT</time>
12     <hopsession>192.94.94.172.24.115.15jj4gpcpk5bg</hopsession>
13     <body>&lt;script src=&quot;/static/bonescript-demo.js&quot;&gt;&lt;/script&gt;\r
15 &lt;!-- side-menu --&gt;\r
16 &lt;h2&gt;Bonescript&lt;/h2&gt;\r
17 &lt;div id=&apos;side-menu&apos; class=&quot;t3_sidebar&quot;&gt;\r
18     &lt;ul class=&quot;left-menu&quot;&gt;\r
19         &lt;strong&gt;Navigation&lt;/strong&gt;\r
20         &lt;li&gt;&lt;a href=&quot;/static/side-menu.html&quot;&gt;Menu contents&lt;/a&gt;&lt;/li&gt;\r
21     &lt;/ul&gt;\r
22 &lt;/div&gt;\r
24 &lt;div class=&quot;t3_content_1&quot;&gt;\r
25 &lt;div id=&apos;connect-status&apos;&gt;&lt;/div&gt;\r
26 &lt;div id=&quot;content_child&quot;&gt;\r
27 &lt;!--- START CONTENT --&gt;\r
29 &lt;h1&gt;pinMode(pin, direction, [mux], [pullup], [slew], [callback])&lt;/h1&gt;\r
30 &lt;p&gt;&lt;b&gt;&lt;em&gt;Note&lt;/em&gt;: This function doesn&apos;t work until BoneScript version 0.2.3&lt;/b&gt;&lt;/p&gt;\r
31 &lt;p&gt;This function configures the mode of a digital I/O pin.&lt;/p&gt;\r
32 &lt;h2&gt;Arguments&lt;/h2&gt;\r
33 &lt;ul&gt;\r
34  &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
35  &lt;li&gt;&lt;em&gt;direction&lt;/em&gt;: &lt;a href=&quot;/support/bonescript#input&quot;&gt;INPUT&lt;/a&gt;,\r
36     &lt;a href=&quot;/support/bonescript#input_pullup&quot;&gt;INPUT_PULLUP&lt;/a&gt; (under development on 3.8 kernel) or \r
37     &lt;a href=&quot;/support/bonescript#output&quot;&gt;OUTPUT&lt;/a&gt;&lt;/li&gt;\r
38  &lt;li&gt;&lt;em&gt;mux&lt;/em&gt;: index to mux mode (under development on 3.8 kernel)&lt;/li&gt;\r
39  &lt;li&gt;&lt;em&gt;pullup&lt;/em&gt;: &apos;pullup&apos;, &apos;pulldown&apos; or &apos;disabled&apos; (under development on 3.8 kernel)&lt;/li&gt;\r
40  &lt;li&gt;&lt;em&gt;slew&lt;/em&gt;: &apos;fast&apos; or &apos;slow&apos; (under development on 3.8 kernel)&lt;/li&gt;\r
41  &lt;li&gt;&lt;em&gt;callback&lt;/em&gt;: called upon completion&lt;/li&gt;\r
42 &lt;/ul&gt;\r
43 &lt;h2&gt;Return value&lt;/h2&gt;\r
44 &lt;ul&gt;\r
45  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/#true&quot;&gt;true&lt;/a&gt; if successful&lt;/li&gt;\r
46  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/#false&quot;&gt;false&lt;/a&gt; on failure&lt;/li&gt;\r
47 &lt;/ul&gt;\r
48 &lt;h2&gt;callback(x)&lt;/h2&gt;\r
49 &lt;ul&gt;\r
50  &lt;li&gt;&lt;em&gt;x.value&lt;/em&gt;: return value&lt;/li&gt;\r
51  &lt;li&gt;&lt;em&gt;x.err&lt;/em&gt;: error status message&lt;/li&gt;\r
52 &lt;/ul&gt;\r
53 &lt;h2&gt;Example\r
54  &lt;button class=&quot;dynlink&quot; onclick=&quot;demoRun(&apos;code&apos;)&quot;&gt;run&lt;/button&gt;\r
55  &lt;button class=&quot;dynlink&quot; onclick=&quot;demoRestore(&apos;code&apos;)&quot;&gt;restore&lt;/button&gt;\r
56 &lt;/h2&gt;\r
57 &lt;pre id=&quot;code&quot; class=&quot;use-editor&quot; style=&quot;height: 250px;&quot;&gt;\r
58 var b = require(&apos;bonescript&apos;);\r
59 b.pinMode(&quot;P8_13&quot;, b.OUTPUT, 7, &apos;pullup&apos;, \r
60  &apos;fast&apos;, printStatus);\r
61 b.getPinMode(&quot;P8_13&quot;, printPinMux);\r
62 function printStatus(x) {\r
63     console.log(&apos;value = &apos; + x.value);\r
64     console.log(&apos;err = &apos; + x.err);\r
65 }\r
66 function printPinMux(x) {\r
67     console.log(&apos;mux = &apos; + x.mux);\r
68     console.log(&apos;pullup = &apos; + x.pullup);\r
69     console.log(&apos;slew = &apos; + x.slew);\r
70     console.log(&apos;options = &apos; + x.options.join(&apos;,&apos;));\r
71     console.log(&apos;err = &apos; + x.err);\r
72 }&lt;/pre&gt;\r
73 &lt;div id=&apos;console-output&apos; style=&quot;height: 160px;&quot;&gt;&lt;/div&gt;\r
74 &lt;h2&gt;Build and execute instructions&lt;/h2&gt;\r
75 &lt;ul&gt;\r
76 &lt;li&gt;Check out some of the other examples to see and verify pinMode functionality.&lt;/li&gt;\r
77 &lt;/ul&gt;\r
78 &lt;h2&gt;See also&lt;/h2&gt;\r
79 &lt;h3&gt;Topics&lt;/h3&gt;\r
80 &lt;ul&gt;\r
81  &lt;li&gt;&lt;a href=&quot;/support/bonescript/#headers&quot;&gt;BeagleBone expansion headers&lt;/a&gt;&lt;/li&gt;\r
82  &lt;li&gt;&lt;a href=&quot;/support/bonescript/#digitalio&quot;&gt;Digital I/O&lt;/a&gt;&lt;/li&gt;\r
83 &lt;/ul&gt;\r
84 &lt;h3&gt;Related functions&lt;/h3&gt;\r
85 &lt;ul&gt;\r
86  &lt;li&gt;&lt;a href=&quot;/Support/BoneScript/getPinMode&quot;&gt;getPinMode&lt;/a&gt;&lt;/li&gt;\r
87 &lt;/ul&gt;\r
88 &lt;/div&gt;&lt;/div&gt;&lt;div style=&quot;clear:both;&quot;&gt;&lt;/div&gt;</body>
89     <pseudoparent idref="2471" prototyperef="Page"/>
90     <http_referer>http://beagleboard.org/support/BoneScript/pinMode/edit</http_referer>
91     <http_host>beagleboard.org</http_host>
92     <user>jkridner@gmail.com</user>
93     <lang>en-us</lang>
94   </hopobject>
95 </xmlroot>