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.

220 lines
10.0KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="class_soft_spi_driver-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Class for external soft SPI.
  70. <a href="class_soft_spi_driver.html#details">More...</a></p>
  71. <p><code>#include &lt;SdSpiSoftDriver.h&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt;:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="class_soft_spi_driver__inherit__graph.png" border="0" usemap="#_soft_spi_driver_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" alt="Inheritance graph"/></div>
  76. <map name="_soft_spi_driver_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" id="_soft_spi_driver_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map">
  77. <area shape="rect" title="Class for external soft SPI." alt="" coords="5,80,164,121"/>
  78. <area shape="rect" href="class_soft_s_p_i_class.html" title="Base class for external soft SPI." alt="" coords="35,5,134,32"/>
  79. </map>
  80. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  81. <div class="dynheader">
  82. Collaboration diagram for SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt;:</div>
  83. <div class="dyncontent">
  84. <div class="center"><img src="class_soft_spi_driver__coll__graph.png" border="0" usemap="#_soft_spi_driver_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" alt="Collaboration graph"/></div>
  85. <map name="_soft_spi_driver_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" id="_soft_spi_driver_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map">
  86. <area shape="rect" title="Class for external soft SPI." alt="" coords="5,80,164,121"/>
  87. <area shape="rect" href="class_soft_s_p_i_class.html" title="Base class for external soft SPI." alt="" coords="35,5,134,32"/>
  88. </map>
  89. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  90. <table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  92. Public Member Functions</h2></td></tr>
  93. <tr class="memitem:a10552c46ff7d74df7b90081547357a13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_spi_driver.html#a10552c46ff7d74df7b90081547357a13">begin</a> ()</td></tr>
  94. <tr class="separator:a10552c46ff7d74df7b90081547357a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a0c2a84b8b0f7b4eaa9d970aa3f31a6d8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_spi_driver.html#a0c2a84b8b0f7b4eaa9d970aa3f31a6d8">receive</a> ()</td></tr>
  96. <tr class="separator:a0c2a84b8b0f7b4eaa9d970aa3f31a6d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ae465952c49043991ec808c2f1eca8e9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_spi_driver.html#ae465952c49043991ec808c2f1eca8e9c">send</a> (uint8_t data)</td></tr>
  98. <tr class="separator:ae465952c49043991ec808c2f1eca8e9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <div class="textblock"><h3>template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt;<br />
  102. class SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt;</h3>
  103. <p>Class for external soft SPI. </p>
  104. </div><h2 class="groupheader">Member Function Documentation</h2>
  105. <a id="a10552c46ff7d74df7b90081547357a13"></a>
  106. <h2 class="memtitle"><span class="permalink"><a href="#a10552c46ff7d74df7b90081547357a13">&#9670;&nbsp;</a></span>begin()</h2>
  107. <div class="memitem">
  108. <div class="memproto">
  109. <div class="memtemplate">
  110. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  111. <table class="mlabels">
  112. <tr>
  113. <td class="mlabels-left">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname">void <a class="el" href="class_soft_spi_driver.html">SoftSpiDriver</a>&lt; MisoPin, MosiPin, SckPin &gt;::begin </td>
  117. <td>(</td>
  118. <td class="paramname"></td><td>)</td>
  119. <td></td>
  120. </tr>
  121. </table>
  122. </td>
  123. <td class="mlabels-right">
  124. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Initialize the SPI bus. </p>
  129. <p>Implements <a class="el" href="class_soft_s_p_i_class.html#a871512a381bf808d58890be44adf6fda">SoftSPIClass</a>.</p>
  130. </div>
  131. </div>
  132. <a id="a0c2a84b8b0f7b4eaa9d970aa3f31a6d8"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a0c2a84b8b0f7b4eaa9d970aa3f31a6d8">&#9670;&nbsp;</a></span>receive()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <div class="memtemplate">
  137. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">uint8_t <a class="el" href="class_soft_spi_driver.html">SoftSpiDriver</a>&lt; MisoPin, MosiPin, SckPin &gt;::receive </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Receive a byte.</p>
  156. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>
  157. <p>Implements <a class="el" href="class_soft_s_p_i_class.html#a87a03c48f09b10bca193bd08566d54b9">SoftSPIClass</a>.</p>
  158. </div>
  159. </div>
  160. <a id="ae465952c49043991ec808c2f1eca8e9c"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#ae465952c49043991ec808c2f1eca8e9c">&#9670;&nbsp;</a></span>send()</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <div class="memtemplate">
  165. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">void <a class="el" href="class_soft_spi_driver.html">SoftSpiDriver</a>&lt; MisoPin, MosiPin, SckPin &gt;::send </td>
  172. <td>(</td>
  173. <td class="paramtype">uint8_t&#160;</td>
  174. <td class="paramname"><em>data</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </td>
  179. <td class="mlabels-right">
  180. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Send a byte.</p>
  185. <dl class="params"><dt>Parameters</dt><dd>
  186. <table class="params">
  187. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
  188. </table>
  189. </dd>
  190. </dl>
  191. <p>Implements <a class="el" href="class_soft_s_p_i_class.html#a3b6378eb720ee48e34c46d90dcab18cc">SoftSPIClass</a>.</p>
  192. </div>
  193. </div>
  194. <hr/>The documentation for this class was generated from the following file:<ul>
  195. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_soft_driver_8h.html">SdSpiSoftDriver.h</a></li>
  196. </ul>
  197. </div><!-- contents -->
  198. <!-- start footer part -->
  199. <hr class="footer"/><address class="footer"><small>
  200. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  201. <img class="footer" src="doxygen.png" alt="doxygen"/>
  202. </a> 1.8.16
  203. </small></address>
  204. </body>
  205. </html>