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.

516 lines
23KB

  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.8"/>
  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/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">SdFat
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.8 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="modules.html"><span>Modules</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  65. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="class_digital_pin-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <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>
  87. </div><!--header-->
  88. <div class="contents">
  89. <p>Fast digital port I/O.
  90. <a href="class_digital_pin.html#details">More...</a></p>
  91. <p><code>#include &lt;DigitalPin.h&gt;</code></p>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <tr class="memitem:ac08cb2fcdac8a690b3392c9d5b144962"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#ac08cb2fcdac8a690b3392c9d5b144962">config</a> (bool <a class="el" href="class_digital_pin.html#adac065cc695efb139c12a82b7f1f0d58">mode</a>, bool level)</td></tr>
  96. <tr class="separator:ac08cb2fcdac8a690b3392c9d5b144962"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:ab68480b09df5c4794c95cdf2230d4c55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a099543ea462aed58ee4ab86a4046b0b3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#a099543ea462aed58ee4ab86a4046b0b3">DigitalPin</a> (bool pinMode)</td></tr>
  100. <tr class="separator:a099543ea462aed58ee4ab86a4046b0b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ae9aab88abca3d2eb733a68a989735028"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#ae9aab88abca3d2eb733a68a989735028">DigitalPin</a> (bool <a class="el" href="class_digital_pin.html#adac065cc695efb139c12a82b7f1f0d58">mode</a>, bool level)</td></tr>
  102. <tr class="separator:ae9aab88abca3d2eb733a68a989735028"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:add1677ecf4c7dc3c12effd39c1db34ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:aeb6a3f66fb3f9fb9ec8233bdb18aa6eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:adac065cc695efb139c12a82b7f1f0d58"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html#adac065cc695efb139c12a82b7f1f0d58">mode</a> (bool pinMode)</td></tr>
  108. <tr class="separator:adac065cc695efb139c12a82b7f1f0d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:ab609c911b4a672e4d382260fc1fdd266"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:adbc9c84602246497a1dbe011e9339cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a55e344551ca86f8acd489aac277c9961"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:ab2109c522836448cd6dfd576c1b5a5a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:a08b7eee5165c5055bd0bbbda491bdfff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table>
  120. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  121. <div class="textblock"><h3>template&lt;uint8_t PinNumber&gt;<br />
  122. class DigitalPin&lt; PinNumber &gt;</h3>
  123. <p>Fast digital port I/O. </p>
  124. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  125. <a class="anchor" id="ab68480b09df5c4794c95cdf2230d4c55"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <div class="memtemplate">
  129. template&lt;uint8_t PinNumber&gt; </div>
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <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>
  136. <td>(</td>
  137. <td class="paramname"></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Constructor </p>
  148. </div>
  149. </div>
  150. <a class="anchor" id="a099543ea462aed58ee4ab86a4046b0b3"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <div class="memtemplate">
  154. template&lt;uint8_t PinNumber&gt; </div>
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <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>
  161. <td>(</td>
  162. <td class="paramtype">bool&#160;</td>
  163. <td class="paramname"><em>pinMode</em></td><td>)</td>
  164. <td></td>
  165. </tr>
  166. </table>
  167. </td>
  168. <td class="mlabels-right">
  169. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
  174. <table class="params">
  175. <tr><td class="paramdir">[in]</td><td class="paramname">pinMode</td><td>if true set output mode else input mode. </td></tr>
  176. </table>
  177. </dd>
  178. </dl>
  179. </div>
  180. </div>
  181. <a class="anchor" id="ae9aab88abca3d2eb733a68a989735028"></a>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <div class="memtemplate">
  185. template&lt;uint8_t PinNumber&gt; </div>
  186. <table class="mlabels">
  187. <tr>
  188. <td class="mlabels-left">
  189. <table class="memname">
  190. <tr>
  191. <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>
  192. <td>(</td>
  193. <td class="paramtype">bool&#160;</td>
  194. <td class="paramname"><em>mode</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">bool&#160;</td>
  200. <td class="paramname"><em>level</em>&#160;</td>
  201. </tr>
  202. <tr>
  203. <td></td>
  204. <td>)</td>
  205. <td></td><td></td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>If true set output mode else input mode </td></tr>
  217. <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 pull-up. </td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. </div>
  222. </div>
  223. <h2 class="groupheader">Member Function Documentation</h2>
  224. <a class="anchor" id="ac08cb2fcdac8a690b3392c9d5b144962"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <div class="memtemplate">
  228. template&lt;uint8_t PinNumber&gt; </div>
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::config </td>
  235. <td>(</td>
  236. <td class="paramtype">bool&#160;</td>
  237. <td class="paramname"><em>mode</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype">bool&#160;</td>
  243. <td class="paramname"><em>level</em>&#160;</td>
  244. </tr>
  245. <tr>
  246. <td></td>
  247. <td>)</td>
  248. <td></td><td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>set pin configuration </p><dl class="params"><dt>Parameters</dt><dd>
  258. <table class="params">
  259. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>If true set output mode else input mode </td></tr>
  260. <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 pull-up. </td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. </div>
  265. </div>
  266. <a class="anchor" id="add1677ecf4c7dc3c12effd39c1db34ed"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <div class="memtemplate">
  270. template&lt;uint8_t PinNumber&gt; </div>
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::high </td>
  277. <td>(</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </td>
  283. <td class="mlabels-right">
  284. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Set pin level high if output mode or enable 20K pull-up if input mode. </p>
  289. </div>
  290. </div>
  291. <a class="anchor" id="aeb6a3f66fb3f9fb9ec8233bdb18aa6eb"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <div class="memtemplate">
  295. template&lt;uint8_t PinNumber&gt; </div>
  296. <table class="mlabels">
  297. <tr>
  298. <td class="mlabels-left">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::low </td>
  302. <td>(</td>
  303. <td class="paramname"></td><td>)</td>
  304. <td></td>
  305. </tr>
  306. </table>
  307. </td>
  308. <td class="mlabels-right">
  309. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <p>Set pin level low if output mode or disable 20K pull-up if input mode. </p>
  314. </div>
  315. </div>
  316. <a class="anchor" id="adac065cc695efb139c12a82b7f1f0d58"></a>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <div class="memtemplate">
  320. template&lt;uint8_t PinNumber&gt; </div>
  321. <table class="mlabels">
  322. <tr>
  323. <td class="mlabels-left">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::mode </td>
  327. <td>(</td>
  328. <td class="paramtype">bool&#160;</td>
  329. <td class="paramname"><em>pinMode</em></td><td>)</td>
  330. <td></td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Set pin mode </p><dl class="params"><dt>Parameters</dt><dd>
  340. <table class="params">
  341. <tr><td class="paramdir">[in]</td><td class="paramname">pinMode</td><td>if true set output mode else input mode.</td></tr>
  342. </table>
  343. </dd>
  344. </dl>
  345. <p><a class="el" href="class_digital_pin.html#adac065cc695efb139c12a82b7f1f0d58">mode()</a> does not enable or disable the 20K pull-up for input mode. </p>
  346. </div>
  347. </div>
  348. <a class="anchor" id="ab609c911b4a672e4d382260fc1fdd266"></a>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <div class="memtemplate">
  352. template&lt;uint8_t PinNumber&gt; </div>
  353. <table class="mlabels">
  354. <tr>
  355. <td class="mlabels-left">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname"><a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::operator bool </td>
  359. <td>(</td>
  360. <td class="paramname"></td><td>)</td>
  361. <td> const</td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Parenthesis operator </p><dl class="section return"><dt>Returns</dt><dd>Pin's level </dd></dl>
  371. </div>
  372. </div>
  373. <a class="anchor" id="adbc9c84602246497a1dbe011e9339cc0"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <div class="memtemplate">
  377. template&lt;uint8_t PinNumber&gt; </div>
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <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>
  384. <td>(</td>
  385. <td class="paramtype">bool&#160;</td>
  386. <td class="paramname"><em>value</em></td><td>)</td>
  387. <td></td>
  388. </tr>
  389. </table>
  390. </td>
  391. <td class="mlabels-right">
  392. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>Asignment operator </p><dl class="params"><dt>Parameters</dt><dd>
  397. <table class="params">
  398. <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>
  399. </table>
  400. </dd>
  401. </dl>
  402. <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>
  403. </div>
  404. </div>
  405. <a class="anchor" id="a55e344551ca86f8acd489aac277c9961"></a>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <div class="memtemplate">
  409. template&lt;uint8_t PinNumber&gt; </div>
  410. <table class="mlabels">
  411. <tr>
  412. <td class="mlabels-left">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">bool <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::read </td>
  416. <td>(</td>
  417. <td class="paramname"></td><td>)</td>
  418. <td> const</td>
  419. </tr>
  420. </table>
  421. </td>
  422. <td class="mlabels-right">
  423. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <dl class="section return"><dt>Returns</dt><dd>Pin's level </dd></dl>
  428. </div>
  429. </div>
  430. <a class="anchor" id="ab2109c522836448cd6dfd576c1b5a5a0"></a>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <div class="memtemplate">
  434. template&lt;uint8_t PinNumber&gt; </div>
  435. <table class="mlabels">
  436. <tr>
  437. <td class="mlabels-left">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::toggle </td>
  441. <td>(</td>
  442. <td class="paramname"></td><td>)</td>
  443. <td></td>
  444. </tr>
  445. </table>
  446. </td>
  447. <td class="mlabels-right">
  448. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>toggle a pin</p>
  453. <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 pull-up. </p>
  454. </div>
  455. </div>
  456. <a class="anchor" id="a08b7eee5165c5055bd0bbbda491bdfff"></a>
  457. <div class="memitem">
  458. <div class="memproto">
  459. <div class="memtemplate">
  460. template&lt;uint8_t PinNumber&gt; </div>
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">void <a class="el" href="class_digital_pin.html">DigitalPin</a>&lt; PinNumber &gt;::write </td>
  467. <td>(</td>
  468. <td class="paramtype">bool&#160;</td>
  469. <td class="paramname"><em>value</em></td><td>)</td>
  470. <td></td>
  471. </tr>
  472. </table>
  473. </td>
  474. <td class="mlabels-right">
  475. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  476. </tr>
  477. </table>
  478. </div><div class="memdoc">
  479. <p>Write the pin's level. </p><dl class="params"><dt>Parameters</dt><dd>
  480. <table class="params">
  481. <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>
  482. </table>
  483. </dd>
  484. </dl>
  485. </div>
  486. </div>
  487. <hr/>The documentation for this class was generated from the following file:<ul>
  488. <li>Arduino/libraries/SdFat/utility/<a class="el" href="_digital_pin_8h.html">DigitalPin.h</a></li>
  489. </ul>
  490. </div><!-- contents -->
  491. <!-- start footer part -->
  492. <hr class="footer"/><address class="footer"><small>
  493. Generated on Sun Feb 1 2015 10:21:40 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  494. <img class="footer" src="doxygen.png" alt="doxygen"/>
  495. </a> 1.8.8
  496. </small></address>
  497. </body>
  498. </html>