taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
EEPROM24_8h_source.html
View File

@@ -3,6 +3,7 @@
<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.6"/>
<title>ArduinoLibs: EEPROM24.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -115,7 +116,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;inttypes.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="classI2CMaster.html">I2CMaster</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// Block select modes.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define EE_BSEL_NONE 0</span></div>
@@ -146,24 +147,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC1025 _EE24(131072UL, 128, EE_BSEL_17BIT_ADDR_ALT)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC1026 _EE24(131072UL, 128, EE_BSEL_17BIT_ADDR)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="code" href="classEEPROM24.html"> 60</a></span>&#160;<span class="keyword">class </span><a class="code" href="classEEPROM24.html" title="Reading and writing EEPROM&#39;s from the 24LCXX family.">EEPROM24</a></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classEEPROM24.html"> 60</a></span>&#160;<span class="keyword">class </span><a class="code" href="classEEPROM24.html">EEPROM24</a></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;{</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classEEPROM24.html#ae8547f6ff7711496e1959ee24a142995" title="Constructs a new EEPROM access object on bus for an EEPROM of the specified type.">EEPROM24</a>(<a class="code" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a> &amp;bus, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> type, uint8_t bank = 0);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classEEPROM24.html#ae8547f6ff7711496e1959ee24a142995">EEPROM24</a>(<a class="code" href="classI2CMaster.html">I2CMaster</a> &amp;bus, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> type, uint8_t bank = 0);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c"> 65</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes.">size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _size; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a"> 66</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes.">pageSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _pageSize; }</div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c"> 65</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c">size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _size; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a"> 66</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a">pageSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _pageSize; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise.">available</a>();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf">available</a>();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; uint8_t <a class="code" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; uint8_t <a class="code" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, uint8_t value);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, uint8_t value);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a> *_bus;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classI2CMaster.html">I2CMaster</a> *_bus;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _size;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _pageSize;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; uint8_t _mode;</div>
@@ -174,12 +175,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;};</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classEEPROM24_html_aa544875cef9bd05bf71d6c19be06cf7c"><div class="ttname"><a href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c">EEPROM24::size</a></div><div class="ttdeci">unsigned long size() const </div><div class="ttdoc">Returns the size of the EEPROM in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8h_source.html#l00065">EEPROM24.h:65</a></div></div>
<div class="ttc" id="classEEPROM24_html_a960971377d4decb122ff38d12603e586"><div class="ttname"><a href="classEEPROM24.html#a960971377d4decb122ff38d12603e586">EEPROM24::read</a></div><div class="ttdeci">uint8_t read(unsigned long address)</div><div class="ttdoc">Reads a single byte from the EEPROM at address. </div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8cpp_source.html#l00167">EEPROM24.cpp:167</a></div></div>
<div class="ttc" id="classEEPROM24_html"><div class="ttname"><a href="classEEPROM24.html">EEPROM24</a></div><div class="ttdoc">Reading and writing EEPROM&#39;s from the 24LCXX family. </div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8h_source.html#l00060">EEPROM24.h:60</a></div></div>
<div class="ttc" id="classEEPROM24_html_ae8547f6ff7711496e1959ee24a142995"><div class="ttname"><a href="classEEPROM24.html#ae8547f6ff7711496e1959ee24a142995">EEPROM24::EEPROM24</a></div><div class="ttdeci">EEPROM24(I2CMaster &amp;bus, unsigned long type, uint8_t bank=0)</div><div class="ttdoc">Constructs a new EEPROM access object on bus for an EEPROM of the specified type. ...</div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8cpp_source.html#l00095">EEPROM24.cpp:95</a></div></div>
<div class="ttc" id="classEEPROM24_html_a9e017772e3459ee4ab987e27d78937f8"><div class="ttname"><a href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8">EEPROM24::write</a></div><div class="ttdeci">bool write(unsigned long address, uint8_t value)</div><div class="ttdoc">Writes a byte value to address in the EEPROM. </div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8cpp_source.html#l00213">EEPROM24.cpp:213</a></div></div>
<div class="ttc" id="classEEPROM24_html_af33b23e2614f3966bbaf2554890c032a"><div class="ttname"><a href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a">EEPROM24::pageSize</a></div><div class="ttdeci">unsigned long pageSize() const </div><div class="ttdoc">Returns the size of a single EEPROM page in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8h_source.html#l00066">EEPROM24.h:66</a></div></div>
<div class="ttc" id="classI2CMaster_html"><div class="ttname"><a href="classI2CMaster.html">I2CMaster</a></div><div class="ttdoc">Abstract base class for I2C master implementations. </div><div class="ttdef"><b>Definition:</b> <a href="I2CMaster_8h_source.html#l00028">I2CMaster.h:28</a></div></div>
<div class="ttc" id="classEEPROM24_html_af8b70971d882b06de3fc6644a8ece3cf"><div class="ttname"><a href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf">EEPROM24::available</a></div><div class="ttdeci">bool available()</div><div class="ttdoc">Returns true if the EEPROM is available on the I2C bus; false otherwise. </div><div class="ttdef"><b>Definition:</b> <a href="EEPROM24_8cpp_source.html#l00152">EEPROM24.cpp:152</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>