visus
/
teensy-sdfat
關注 1
收藏 0
複製 0
程式碼 問題 0 合併請求 0 版本發佈 0 Wiki 活動
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
20 提交
1 分支
目錄樹: 319da5fb4f
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 '319da5fb4f'
${ noResults }
teensy-sdfat/html/class_digital_pin.html

438 line
18KB
原始文件 Blame 歷史記錄 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.10"/>

  7. <title>SdFat: DigitalPin&lt; PinNumber &gt; Class Template Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/searchdata.js"></script>

  13. <script type="text/javascript" src="search/search.js"></script>

  14. <script type="text/javascript">

  15.   $(document).ready(function() { init_search(); });

  16. </script>

  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  18. </head>

  19. <body>

  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  21. <div id="titlearea">

  22. <table cellspacing="0" cellpadding="0">

  23.  <tbody>

  24.  <tr style="height: 56px;">

  25.   <td id="projectalign" style="padding-left: 0.5em;">

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

  33. <!-- end header part -->

  34. <!-- Generated by Doxygen 1.8.10 -->

  35. <script type="text/javascript">

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  37. </script>

  38.   <div id="navrow1" class="tabs">

  39.     <ul class="tablist">

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  41.       <li><a href="modules.html"><span>Modules</span></a></li>

  42.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li><a href="files.html"><span>Files</span></a></li>

  44.       <li>

  45.         <div id="MSearchBox" class="MSearchBoxInactive">

  46.         <span class="left">

  47.           <img id="MSearchSelect" src="search/mag_sel.png"

  48.                onmouseover="return searchBox.OnSearchSelectShow()"

  49.                onmouseout="return searchBox.OnSearchSelectHide()"

  50.                alt=""/>

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  55.           </span><span class="right">

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

  62.   <div id="navrow2" class="tabs2">

  63.     <ul class="tablist">

  64.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  65.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. </div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. </div><!-- top -->

  84. <div class="header">

  85.   <div class="summary">

  86. <a href="#pub-methods">Public Member Functions</a> &#124;

  87. <a href="class_digital_pin-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

  89. <div class="title">DigitalPin&lt; PinNumber &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__digital_pin.html">Fast Pin I/O</a></div></div>  </div>

  90. </div><!--header-->

  91. <div class="contents">

  92. 

  93. <p>Fast digital port I/O.  

  94.  <a href="class_digital_pin.html#details">More...</a></p>

  95. 

  96. <p><code>#include &lt;DigitalPin.h&gt;</code></p>

  97. <table class="memberdecls">

  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  99. Public Member Functions</h2></td></tr>

  100. <tr class="memitem:aa6e07eea6e152d47c6f0d232bed9c45e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#aa6e07eea6e152d47c6f0d232bed9c45e">config</a> (uint8_t <a class="el" href="class_digital_pin.html#afe1550df47980934061d5578ec1fd644">mode</a>, bool level)</td></tr>

  101. <tr class="separator:aa6e07eea6e152d47c6f0d232bed9c45e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  102. <tr class="memitem:ab68480b09df5c4794c95cdf2230d4c55"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#ab68480b09df5c4794c95cdf2230d4c55">DigitalPin</a> ()</td></tr>

  103. <tr class="separator:ab68480b09df5c4794c95cdf2230d4c55"><td class="memSeparator" colspan="2">&#160;</td></tr>

  104. <tr class="memitem:add1677ecf4c7dc3c12effd39c1db34ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#add1677ecf4c7dc3c12effd39c1db34ed">high</a> ()</td></tr>

  105. <tr class="separator:add1677ecf4c7dc3c12effd39c1db34ed"><td class="memSeparator" colspan="2">&#160;</td></tr>

  106. <tr class="memitem:aeb6a3f66fb3f9fb9ec8233bdb18aa6eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#aeb6a3f66fb3f9fb9ec8233bdb18aa6eb">low</a> ()</td></tr>

  107. <tr class="separator:aeb6a3f66fb3f9fb9ec8233bdb18aa6eb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  108. <tr class="memitem:afe1550df47980934061d5578ec1fd644"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#afe1550df47980934061d5578ec1fd644">mode</a> (uint8_t mode)</td></tr>

  109. <tr class="separator:afe1550df47980934061d5578ec1fd644"><td class="memSeparator" colspan="2">&#160;</td></tr>

  110. <tr class="memitem:ab609c911b4a672e4d382260fc1fdd266"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#ab609c911b4a672e4d382260fc1fdd266">operator bool</a> () const </td></tr>

  111. <tr class="separator:ab609c911b4a672e4d382260fc1fdd266"><td class="memSeparator" colspan="2">&#160;</td></tr>

  112. <tr class="memitem:adbc9c84602246497a1dbe011e9339cc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_digital_pin.html">DigitalPin</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#adbc9c84602246497a1dbe011e9339cc0">operator=</a> (bool value)</td></tr>

  113. <tr class="separator:adbc9c84602246497a1dbe011e9339cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  114. <tr class="memitem:a55e344551ca86f8acd489aac277c9961"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#a55e344551ca86f8acd489aac277c9961">read</a> () const </td></tr>

  115. <tr class="separator:a55e344551ca86f8acd489aac277c9961"><td class="memSeparator" colspan="2">&#160;</td></tr>

  116. <tr class="memitem:ab2109c522836448cd6dfd576c1b5a5a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#ab2109c522836448cd6dfd576c1b5a5a0">toggle</a> ()</td></tr>

  117. <tr class="separator:ab2109c522836448cd6dfd576c1b5a5a0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  118. <tr class="memitem:a08b7eee5165c5055bd0bbbda491bdfff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#a08b7eee5165c5055bd0bbbda491bdfff">write</a> (bool value)</td></tr>

  119. <tr class="separator:a08b7eee5165c5055bd0bbbda491bdfff"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. </table>

  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  122. <div class="textblock"><h3>template&lt;uint8_t PinNumber&gt;<br />

  123. class DigitalPin&lt; PinNumber &gt;</h3>

  124. 

  125. <p>Fast digital port I/O. </p>

  126. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  127. <a class="anchor" id="ab68480b09df5c4794c95cdf2230d4c55"></a>

  128. <div class="memitem">

  129. <div class="memproto">

  130. <div class="memtemplate">

  131. template&lt;uint8_t PinNumber&gt; </div>

  132. <table class="mlabels">

  133.   <tr>

  134.   <td class="mlabels-left">

  135.       <table class="memname">

  136.         <tr>

  137.           <td class="memname"><a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::<a class="el" href="class_digital_pin.html">DigitalPin</a> </td>

  138.           <td>(</td>

  139.           <td class="paramname"></td><td>)</td>

  140.           <td></td>

  141.         </tr>

  142.       </table>

  143.   </td>

  144.   <td class="mlabels-right">

  145. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  146.   </tr>

  147. </table>

  148. </div><div class="memdoc">

  149. <p>Constructor </p>

  150. 

  151. </div>

  152. </div>

  153. <h2 class="groupheader">Member Function Documentation</h2>

  154. <a class="anchor" id="aa6e07eea6e152d47c6f0d232bed9c45e"></a>

  155. <div class="memitem">

  156. <div class="memproto">

  157. <div class="memtemplate">

  158. template&lt;uint8_t PinNumber&gt; </div>

  159. <table class="mlabels">

  160.   <tr>

  161.   <td class="mlabels-left">

  162.       <table class="memname">

  163.         <tr>

  164.           <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::config </td>

  165.           <td>(</td>

  166.           <td class="paramtype">uint8_t&#160;</td>

  167.           <td class="paramname"><em>mode</em>, </td>

  168.         </tr>

  169.         <tr>

  170.           <td class="paramkey"></td>

  171.           <td></td>

  172.           <td class="paramtype">bool&#160;</td>

  173.           <td class="paramname"><em>level</em>&#160;</td>

  174.         </tr>

  175.         <tr>

  176.           <td></td>

  177.           <td>)</td>

  178.           <td></td><td></td>

  179.         </tr>

  180.       </table>

  181.   </td>

  182.   <td class="mlabels-right">

  183. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  184.   </tr>

  185. </table>

  186. </div><div class="memdoc">

  187. <p>Set pin configuration. </p><dl class="params"><dt>Parameters</dt><dd>

  188.   <table class="params">

  189.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>INPUT or OUTPUT. </td></tr>

  190.     <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>If mode is OUTPUT, set level high/low. If mode is INPUT, enable or disable the pin's 20K pullup. </td></tr>

  191.   </table>

  192.   </dd>

  193. </dl>

  194. 

  195. </div>

  196. </div>

  197. <a class="anchor" id="add1677ecf4c7dc3c12effd39c1db34ed"></a>

  198. <div class="memitem">

  199. <div class="memproto">

  200. <div class="memtemplate">

  201. template&lt;uint8_t PinNumber&gt; </div>

  202. <table class="mlabels">

  203.   <tr>

  204.   <td class="mlabels-left">

  205.       <table class="memname">

  206.         <tr>

  207.           <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::high </td>

  208.           <td>(</td>

  209.           <td class="paramname"></td><td>)</td>

  210.           <td></td>

  211.         </tr>

  212.       </table>

  213.   </td>

  214.   <td class="mlabels-right">

  215. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  216.   </tr>

  217. </table>

  218. </div><div class="memdoc">

  219. <p>Set pin level high if output mode or enable 20K pullup if input mode. </p>

  220. 

  221. </div>

  222. </div>

  223. <a class="anchor" id="aeb6a3f66fb3f9fb9ec8233bdb18aa6eb"></a>

  224. <div class="memitem">

  225. <div class="memproto">

  226. <div class="memtemplate">

  227. template&lt;uint8_t PinNumber&gt; </div>

  228. <table class="mlabels">

  229.   <tr>

  230.   <td class="mlabels-left">

  231.       <table class="memname">

  232.         <tr>

  233.           <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::low </td>

  234.           <td>(</td>

  235.           <td class="paramname"></td><td>)</td>

  236.           <td></td>

  237.         </tr>

  238.       </table>

  239.   </td>

  240.   <td class="mlabels-right">

  241. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  242.   </tr>

  243. </table>

  244. </div><div class="memdoc">

  245. <p>Set pin level low if output mode or disable 20K pullup if input mode. </p>

  246. 

  247. </div>

  248. </div>

  249. <a class="anchor" id="afe1550df47980934061d5578ec1fd644"></a>

  250. <div class="memitem">

  251. <div class="memproto">

  252. <div class="memtemplate">

  253. template&lt;uint8_t PinNumber&gt; </div>

  254. <table class="mlabels">

  255.   <tr>

  256.   <td class="mlabels-left">

  257.       <table class="memname">

  258.         <tr>

  259.           <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::mode </td>

  260.           <td>(</td>

  261.           <td class="paramtype">uint8_t&#160;</td>

  262.           <td class="paramname"><em>mode</em></td><td>)</td>

  263.           <td></td>

  264.         </tr>

  265.       </table>

  266.   </td>

  267.   <td class="mlabels-right">

  268. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  269.   </tr>

  270. </table>

  271. </div><div class="memdoc">

  272. <p>Set pin mode. </p><dl class="params"><dt>Parameters</dt><dd>

  273.   <table class="params">

  274.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>INPUT, OUTPUT, or INPUT_PULLUP.</td></tr>

  275.   </table>

  276.   </dd>

  277. </dl>

  278. <p>The internal pullup resistors will be enabled if mode is INPUT_PULLUP and disabled if the mode is INPUT. </p>

  279. 

  280. </div>

  281. </div>

  282. <a class="anchor" id="ab609c911b4a672e4d382260fc1fdd266"></a>

  283. <div class="memitem">

  284. <div class="memproto">

  285. <div class="memtemplate">

  286. template&lt;uint8_t PinNumber&gt; </div>

  287. <table class="mlabels">

  288.   <tr>

  289.   <td class="mlabels-left">

  290.       <table class="memname">

  291.         <tr>

  292.           <td class="memname"><a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::operator bool </td>

  293.           <td>(</td>

  294.           <td class="paramname"></td><td>)</td>

  295.           <td> const</td>

  296.         </tr>

  297.       </table>

  298.   </td>

  299.   <td class="mlabels-right">

  300. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  301.   </tr>

  302. </table>

  303. </div><div class="memdoc">

  304. <p>Parenthesis operator. </p><dl class="section return"><dt>Returns</dt><dd>Pin's level </dd></dl>

  305. 

  306. </div>

  307. </div>

  308. <a class="anchor" id="adbc9c84602246497a1dbe011e9339cc0"></a>

  309. <div class="memitem">

  310. <div class="memproto">

  311. <div class="memtemplate">

  312. template&lt;uint8_t PinNumber&gt; </div>

  313. <table class="mlabels">

  314.   <tr>

  315.   <td class="mlabels-left">

  316.       <table class="memname">

  317.         <tr>

  318.           <td class="memname"><a class="el" href="class_digital_pin.html">DigitalPin</a>&amp; <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::operator= </td>

  319.           <td>(</td>

  320.           <td class="paramtype">bool&#160;</td>

  321.           <td class="paramname"><em>value</em></td><td>)</td>

  322.           <td></td>

  323.         </tr>

  324.       </table>

  325.   </td>

  326.   <td class="mlabels-right">

  327. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  328.   </tr>

  329. </table>

  330. </div><div class="memdoc">

  331. <p>Asignment operator. </p><dl class="params"><dt>Parameters</dt><dd>

  332.   <table class="params">

  333.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>If true set the pin's level high else set the pin's level low.</td></tr>

  334.   </table>

  335.   </dd>

  336. </dl>

  337. <dl class="section return"><dt>Returns</dt><dd>This <a class="el" href="class_digital_pin.html" title="Fast digital port I/O. ">DigitalPin</a> instance. </dd></dl>

  338. 

  339. </div>

  340. </div>

  341. <a class="anchor" id="a55e344551ca86f8acd489aac277c9961"></a>

  342. <div class="memitem">

  343. <div class="memproto">

  344. <div class="memtemplate">

  345. template&lt;uint8_t PinNumber&gt; </div>

  346. <table class="mlabels">

  347.   <tr>

  348.   <td class="mlabels-left">

  349.       <table class="memname">

  350.         <tr>

  351.           <td class="memname">bool <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::read </td>

  352.           <td>(</td>

  353.           <td class="paramname"></td><td>)</td>

  354.           <td> const</td>

  355.         </tr>

  356.       </table>

  357.   </td>

  358.   <td class="mlabels-right">

  359. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  360.   </tr>

  361. </table>

  362. </div><div class="memdoc">

  363. <dl class="section return"><dt>Returns</dt><dd>Pin's level. </dd></dl>

  364. 

  365. </div>

  366. </div>

  367. <a class="anchor" id="ab2109c522836448cd6dfd576c1b5a5a0"></a>

  368. <div class="memitem">

  369. <div class="memproto">

  370. <div class="memtemplate">

  371. template&lt;uint8_t PinNumber&gt; </div>

  372. <table class="mlabels">

  373.   <tr>

  374.   <td class="mlabels-left">

  375.       <table class="memname">

  376.         <tr>

  377.           <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::toggle </td>

  378.           <td>(</td>

  379.           <td class="paramname"></td><td>)</td>

  380.           <td></td>

  381.         </tr>

  382.       </table>

  383.   </td>

  384.   <td class="mlabels-right">

  385. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  386.   </tr>

  387. </table>

  388. </div><div class="memdoc">

  389. <p>Toggle a pin.</p>

  390. <p>If the pin is in output mode toggle the pin's level. If the pin is in input mode toggle the state of the 20K pullup. </p>

  391. 

  392. </div>

  393. </div>

  394. <a class="anchor" id="a08b7eee5165c5055bd0bbbda491bdfff"></a>

  395. <div class="memitem">

  396. <div class="memproto">

  397. <div class="memtemplate">

  398. template&lt;uint8_t PinNumber&gt; </div>

  399. <table class="mlabels">

  400.   <tr>

  401.   <td class="mlabels-left">

  402.       <table class="memname">

  403.         <tr>

  404.           <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::write </td>

  405.           <td>(</td>

  406.           <td class="paramtype">bool&#160;</td>

  407.           <td class="paramname"><em>value</em></td><td>)</td>

  408.           <td></td>

  409.         </tr>

  410.       </table>

  411.   </td>

  412.   <td class="mlabels-right">

  413. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  414.   </tr>

  415. </table>

  416. </div><div class="memdoc">

  417. <p>Write the pin's level. </p><dl class="params"><dt>Parameters</dt><dd>

  418.   <table class="params">

  419.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>If true set the pin's level high else set the pin's level low. </td></tr>

  420.   </table>

  421.   </dd>

  422. </dl>

  423. 

  424. </div>

  425. </div>

  426. <hr/>The documentation for this class was generated from the following file:<ul>

  427. <li>Arduino/libraries/SdFat/src/SdSpiCard/<a class="el" href="_digital_pin_8h.html">DigitalPin.h</a></li>

  428. </ul>

  429. </div><!-- contents -->

  430. <!-- start footer part -->

  431. <hr class="footer"/><address class="footer"><small>

  432. Generated on Sat Jan 23 2016 13:44:27 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  433. <img class="footer" src="doxygen.png" alt="doxygen"/>

  434. </a> 1.8.10

  435. </small></address>

  436. </body>

  437. </html>