|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.16"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>SdFat: SoftSPIClass Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">SdFat
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.16 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="class_soft_s_p_i_class-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">SoftSPIClass Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p>Base class for external soft SPI.
- <a href="class_soft_s_p_i_class.html#details">More...</a></p>
-
- <p><code>#include <SdSpiSoftDriver.h></code></p>
- <div class="dynheader">
- Inheritance diagram for SoftSPIClass:</div>
- <div class="dyncontent">
- <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>
- <map name="_soft_s_p_i_class_inherit__map" id="_soft_s_p_i_class_inherit__map">
- <area shape="rect" title="Base class for external soft SPI." alt="" coords="35,5,134,32"/>
- <area shape="rect" href="class_soft_spi_driver.html" title="Class for external soft SPI." alt="" coords="5,80,164,121"/>
- </map>
- <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a871512a381bf808d58890be44adf6fda"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_s_p_i_class.html#a871512a381bf808d58890be44adf6fda">begin</a> ()=0</td></tr>
- <tr class="separator:a871512a381bf808d58890be44adf6fda"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87a03c48f09b10bca193bd08566d54b9"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_s_p_i_class.html#a87a03c48f09b10bca193bd08566d54b9">receive</a> ()=0</td></tr>
- <tr class="separator:a87a03c48f09b10bca193bd08566d54b9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b6378eb720ee48e34c46d90dcab18cc"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:a3b6378eb720ee48e34c46d90dcab18cc"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Base class for external soft SPI. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="a871512a381bf808d58890be44adf6fda"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a871512a381bf808d58890be44adf6fda">◆ </a></span>begin()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SoftSPIClass::begin </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Initialize the SPI bus. </p>
-
- <p>Implemented in <a class="el" href="class_soft_spi_driver.html#a10552c46ff7d74df7b90081547357a13">SoftSpiDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a id="a87a03c48f09b10bca193bd08566d54b9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a87a03c48f09b10bca193bd08566d54b9">◆ </a></span>receive()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint8_t SoftSPIClass::receive </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receive a byte.</p>
- <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>
-
- <p>Implemented in <a class="el" href="class_soft_spi_driver.html#a0c2a84b8b0f7b4eaa9d970aa3f31a6d8">SoftSpiDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a id="a3b6378eb720ee48e34c46d90dcab18cc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3b6378eb720ee48e34c46d90dcab18cc">◆ </a></span>send()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SoftSPIClass::send </td>
- <td>(</td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>data</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a byte.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
- </table>
- </dd>
- </dl>
-
- <p>Implemented in <a class="el" href="class_soft_spi_driver.html#ae465952c49043991ec808c2f1eca8e9c">SoftSpiDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_soft_driver_8h.html">SdSpiSoftDriver.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Fri Dec 6 2019 09:45:12 for SdFat by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.16
- </small></address>
- </body>
- </html>
|