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.

202 line
8.4KB

  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: SoftSPIClass Class 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_s_p_i_class-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">SoftSPIClass Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Base class for external soft SPI.
  70. <a href="class_soft_s_p_i_class.html#details">More...</a></p>
  71. <p><code>#include &lt;SdSpiSoftDriver.h&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for SoftSPIClass:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="class_soft_s_p_i_class__inherit__graph.png" border="0" usemap="#_soft_s_p_i_class_inherit__map" alt="Inheritance graph"/></div>
  76. <map name="_soft_s_p_i_class_inherit__map" id="_soft_s_p_i_class_inherit__map">
  77. <area shape="rect" title="Base class for external soft SPI." alt="" coords="35,5,134,32"/>
  78. <area shape="rect" href="class_soft_spi_driver.html" title="Class for external soft SPI." alt="" coords="5,80,164,121"/>
  79. </map>
  80. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:a871512a381bf808d58890be44adf6fda"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_s_p_i_class.html#a871512a381bf808d58890be44adf6fda">begin</a> ()=0</td></tr>
  85. <tr class="separator:a871512a381bf808d58890be44adf6fda"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a87a03c48f09b10bca193bd08566d54b9"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_s_p_i_class.html#a87a03c48f09b10bca193bd08566d54b9">receive</a> ()=0</td></tr>
  87. <tr class="separator:a87a03c48f09b10bca193bd08566d54b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a3b6378eb720ee48e34c46d90dcab18cc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_s_p_i_class.html#a3b6378eb720ee48e34c46d90dcab18cc">send</a> (uint8_t data)=0</td></tr>
  89. <tr class="separator:a3b6378eb720ee48e34c46d90dcab18cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <div class="textblock"><p>Base class for external soft SPI. </p>
  93. </div><h2 class="groupheader">Member Function Documentation</h2>
  94. <a id="a871512a381bf808d58890be44adf6fda"></a>
  95. <h2 class="memtitle"><span class="permalink"><a href="#a871512a381bf808d58890be44adf6fda">&#9670;&nbsp;</a></span>begin()</h2>
  96. <div class="memitem">
  97. <div class="memproto">
  98. <table class="mlabels">
  99. <tr>
  100. <td class="mlabels-left">
  101. <table class="memname">
  102. <tr>
  103. <td class="memname">virtual void SoftSPIClass::begin </td>
  104. <td>(</td>
  105. <td class="paramname"></td><td>)</td>
  106. <td></td>
  107. </tr>
  108. </table>
  109. </td>
  110. <td class="mlabels-right">
  111. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  112. </tr>
  113. </table>
  114. </div><div class="memdoc">
  115. <p>Initialize the SPI bus. </p>
  116. <p>Implemented in <a class="el" href="class_soft_spi_driver.html#a10552c46ff7d74df7b90081547357a13">SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>
  117. </div>
  118. </div>
  119. <a id="a87a03c48f09b10bca193bd08566d54b9"></a>
  120. <h2 class="memtitle"><span class="permalink"><a href="#a87a03c48f09b10bca193bd08566d54b9">&#9670;&nbsp;</a></span>receive()</h2>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="mlabels">
  124. <tr>
  125. <td class="mlabels-left">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">virtual uint8_t SoftSPIClass::receive </td>
  129. <td>(</td>
  130. <td class="paramname"></td><td>)</td>
  131. <td></td>
  132. </tr>
  133. </table>
  134. </td>
  135. <td class="mlabels-right">
  136. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Receive a byte.</p>
  141. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>
  142. <p>Implemented in <a class="el" href="class_soft_spi_driver.html#a0c2a84b8b0f7b4eaa9d970aa3f31a6d8">SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>
  143. </div>
  144. </div>
  145. <a id="a3b6378eb720ee48e34c46d90dcab18cc"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#a3b6378eb720ee48e34c46d90dcab18cc">&#9670;&nbsp;</a></span>send()</h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">virtual void SoftSPIClass::send </td>
  155. <td>(</td>
  156. <td class="paramtype">uint8_t&#160;</td>
  157. <td class="paramname"><em>data</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Send a byte.</p>
  168. <dl class="params"><dt>Parameters</dt><dd>
  169. <table class="params">
  170. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
  171. </table>
  172. </dd>
  173. </dl>
  174. <p>Implemented in <a class="el" href="class_soft_spi_driver.html#ae465952c49043991ec808c2f1eca8e9c">SoftSpiDriver&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>
  175. </div>
  176. </div>
  177. <hr/>The documentation for this class was generated from the following file:<ul>
  178. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_soft_driver_8h.html">SdSpiSoftDriver.h</a></li>
  179. </ul>
  180. </div><!-- contents -->
  181. <!-- start footer part -->
  182. <hr class="footer"/><address class="footer"><small>
  183. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  184. <img class="footer" src="doxygen.png" alt="doxygen"/>
  185. </a> 1.8.16
  186. </small></address>
  187. </body>
  188. </html>