visus
/
teensy-sdfat
Beobachten 1
Favorisieren 0
Fork 0
Code Issues 0 Pull-Requests 0 Releases 0 Wiki Aktivität
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
19 Commits
1 Branch
Struktur: 7016042d22
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „7016042d22“
${ noResults }
teensy-sdfat/html/class_sd_spi_lib.html

349 Zeilen
15KB
Originalformat Blame Verlauf 

  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: SdSpiLib Class 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. 

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

  76. <div id="MSearchResultsWindow">

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

  78.         name="MSearchResults" id="MSearchResults">

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

  86. <a href="class_sd_spi_lib-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">SdSpiLib Class Reference</div>  </div>

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

  90. <div class="contents">

  91. 

  92. <p>Arduino SPI library class for access to SD and SDHC flash memory cards.  

  93.  <a href="class_sd_spi_lib.html#details">More...</a></p>

  94. 

  95. <p><code>#include &lt;SdSpi.h&gt;</code></p>

  96. <table class="memberdecls">

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

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

  99. <tr class="memitem:a34be8cc85dbded6ef4364a52d668c16a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a34be8cc85dbded6ef4364a52d668c16a">begin</a> ()</td></tr>

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

  101. <tr class="memitem:afecc9a75f05a7f3c9d74cd40b310c343"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#afecc9a75f05a7f3c9d74cd40b310c343">beginTransaction</a> (uint8_t divisor)</td></tr>

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

  103. <tr class="memitem:a8e9bf91c47f1923abeb14d338aaae569"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a8e9bf91c47f1923abeb14d338aaae569">endTransaction</a> ()</td></tr>

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

  105. <tr class="memitem:ac3c8027243a2fef5894809cbb7bed837"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#ac3c8027243a2fef5894809cbb7bed837">receive</a> ()</td></tr>

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

  107. <tr class="memitem:ad835adf6990e6368ec577f00edf365b0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#ad835adf6990e6368ec577f00edf365b0">receive</a> (uint8_t *buf, size_t n)</td></tr>

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

  109. <tr class="memitem:a070de2435f58f4f98c224c4b1b4be888"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a070de2435f58f4f98c224c4b1b4be888">send</a> (uint8_t b)</td></tr>

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

  111. <tr class="memitem:a58af4700449aadc2b418fac59fda6e1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a58af4700449aadc2b418fac59fda6e1b">send</a> (const uint8_t *buf, size_t n)</td></tr>

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

  113. </table>

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

  115. <div class="textblock"><p>Arduino SPI library class for access to SD and SDHC flash memory cards. </p>

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

  117. <a class="anchor" id="a34be8cc85dbded6ef4364a52d668c16a"></a>

  118. <div class="memitem">

  119. <div class="memproto">

  120. <table class="mlabels">

  121.   <tr>

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

  123.       <table class="memname">

  124.         <tr>

  125.           <td class="memname">void SdSpiLib::begin </td>

  126.           <td>(</td>

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

  128.           <td></td>

  129.         </tr>

  130.       </table>

  131.   </td>

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

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

  134.   </tr>

  135. </table>

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

  137. <p>Initialize SPI pins. </p>

  138. 

  139. </div>

  140. </div>

  141. <a class="anchor" id="afecc9a75f05a7f3c9d74cd40b310c343"></a>

  142. <div class="memitem">

  143. <div class="memproto">

  144. <table class="mlabels">

  145.   <tr>

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

  147.       <table class="memname">

  148.         <tr>

  149.           <td class="memname">void SdSpiLib::beginTransaction </td>

  150.           <td>(</td>

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

  152.           <td class="paramname"><em>divisor</em></td><td>)</td>

  153.           <td></td>

  154.         </tr>

  155.       </table>

  156.   </td>

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

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

  159.   </tr>

  160. </table>

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

  162. <p>Set SPI options for access to SD/SDHC cards.</p>

  163. <dl class="params"><dt>Parameters</dt><dd>

  164.   <table class="params">

  165.     <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SCK clock divider relative to the system clock. </td></tr>

  166.   </table>

  167.   </dd>

  168. </dl>

  169. 

  170. </div>

  171. </div>

  172. <a class="anchor" id="a8e9bf91c47f1923abeb14d338aaae569"></a>

  173. <div class="memitem">

  174. <div class="memproto">

  175. <table class="mlabels">

  176.   <tr>

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

  178.       <table class="memname">

  179.         <tr>

  180.           <td class="memname">void SdSpiLib::endTransaction </td>

  181.           <td>(</td>

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

  183.           <td></td>

  184.         </tr>

  185.       </table>

  186.   </td>

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

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

  189.   </tr>

  190. </table>

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

  192. <p>End SPI transaction. </p>

  193. 

  194. </div>

  195. </div>

  196. <a class="anchor" id="ac3c8027243a2fef5894809cbb7bed837"></a>

  197. <div class="memitem">

  198. <div class="memproto">

  199. <table class="mlabels">

  200.   <tr>

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

  202.       <table class="memname">

  203.         <tr>

  204.           <td class="memname">uint8_t SdSpiLib::receive </td>

  205.           <td>(</td>

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

  207.           <td></td>

  208.         </tr>

  209.       </table>

  210.   </td>

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

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

  213.   </tr>

  214. </table>

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

  216. <p>Receive a byte.</p>

  217. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>

  218. 

  219. </div>

  220. </div>

  221. <a class="anchor" id="ad835adf6990e6368ec577f00edf365b0"></a>

  222. <div class="memitem">

  223. <div class="memproto">

  224. <table class="mlabels">

  225.   <tr>

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

  227.       <table class="memname">

  228.         <tr>

  229.           <td class="memname">uint8_t SdSpiLib::receive </td>

  230.           <td>(</td>

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

  232.           <td class="paramname"><em>buf</em>, </td>

  233.         </tr>

  234.         <tr>

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

  236.           <td></td>

  237.           <td class="paramtype">size_t&#160;</td>

  238.           <td class="paramname"><em>n</em>&#160;</td>

  239.         </tr>

  240.         <tr>

  241.           <td></td>

  242.           <td>)</td>

  243.           <td></td><td></td>

  244.         </tr>

  245.       </table>

  246.   </td>

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

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

  249.   </tr>

  250. </table>

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

  252. <p>Receive multiple bytes.</p>

  253. <dl class="params"><dt>Parameters</dt><dd>

  254.   <table class="params">

  255.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>

  256.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to receive.</td></tr>

  257.   </table>

  258.   </dd>

  259. </dl>

  260. <dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>

  261. 

  262. </div>

  263. </div>

  264. <a class="anchor" id="a070de2435f58f4f98c224c4b1b4be888"></a>

  265. <div class="memitem">

  266. <div class="memproto">

  267. <table class="mlabels">

  268.   <tr>

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

  270.       <table class="memname">

  271.         <tr>

  272.           <td class="memname">void SdSpiLib::send </td>

  273.           <td>(</td>

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

  275.           <td class="paramname"><em>b</em></td><td>)</td>

  276.           <td></td>

  277.         </tr>

  278.       </table>

  279.   </td>

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

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

  282.   </tr>

  283. </table>

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

  285. <p>Send a byte.</p>

  286. <dl class="params"><dt>Parameters</dt><dd>

  287.   <table class="params">

  288.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>Byte to send </td></tr>

  289.   </table>

  290.   </dd>

  291. </dl>

  292. 

  293. </div>

  294. </div>

  295. <a class="anchor" id="a58af4700449aadc2b418fac59fda6e1b"></a>

  296. <div class="memitem">

  297. <div class="memproto">

  298. <table class="mlabels">

  299.   <tr>

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

  301.       <table class="memname">

  302.         <tr>

  303.           <td class="memname">void SdSpiLib::send </td>

  304.           <td>(</td>

  305.           <td class="paramtype">const uint8_t *&#160;</td>

  306.           <td class="paramname"><em>buf</em>, </td>

  307.         </tr>

  308.         <tr>

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

  310.           <td></td>

  311.           <td class="paramtype">size_t&#160;</td>

  312.           <td class="paramname"><em>n</em>&#160;</td>

  313.         </tr>

  314.         <tr>

  315.           <td></td>

  316.           <td>)</td>

  317.           <td></td><td></td>

  318.         </tr>

  319.       </table>

  320.   </td>

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

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

  323.   </tr>

  324. </table>

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

  326. <p>Send multiple bytes.</p>

  327. <dl class="params"><dt>Parameters</dt><dd>

  328.   <table class="params">

  329.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>

  330.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to send. </td></tr>

  331.   </table>

  332.   </dd>

  333. </dl>

  334. 

  335. </div>

  336. </div>

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

  338. <li>Arduino/libraries/SdFat/src/SdSpiCard/<a class="el" href="_sd_spi_8h.html">SdSpi.h</a></li>

  339. </ul>

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

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

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

  343. Generated on Sun Jul 19 2015 10:15:53 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  345. </a> 1.8.8

  346. </small></address>

  347. </body>

  348. </html>