mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
@@ -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 Class Reference</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>
|
||||
@@ -95,35 +96,43 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
|
||||
<p><code>#include <<a class="el" href="EEPROM24_8h_source.html">EEPROM24.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ae8547f6ff7711496e1959ee24a142995"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#ae8547f6ff7711496e1959ee24a142995">EEPROM24</a> (<a class="el" href="classI2CMaster.html">I2CMaster</a> &bus, unsigned long type, uint8_t bank=0)</td></tr>
|
||||
<tr class="memdesc:ae8547f6ff7711496e1959ee24a142995"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new EEPROM access object on <em>bus</em> for an EEPROM of the specified <em>type</em>. <a href="#ae8547f6ff7711496e1959ee24a142995"></a><br/></td></tr>
|
||||
<tr class="memdesc:ae8547f6ff7711496e1959ee24a142995"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new EEPROM access object on <em>bus</em> for an EEPROM of the specified <em>type</em>. <a href="#ae8547f6ff7711496e1959ee24a142995">More...</a><br/></td></tr>
|
||||
<tr class="separator:ae8547f6ff7711496e1959ee24a142995"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa544875cef9bd05bf71d6c19be06cf7c"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c">size</a> () const </td></tr>
|
||||
<tr class="memdesc:aa544875cef9bd05bf71d6c19be06cf7c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the EEPROM in bytes. <a href="#aa544875cef9bd05bf71d6c19be06cf7c"></a><br/></td></tr>
|
||||
<tr class="memdesc:aa544875cef9bd05bf71d6c19be06cf7c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the EEPROM in bytes. <a href="#aa544875cef9bd05bf71d6c19be06cf7c">More...</a><br/></td></tr>
|
||||
<tr class="separator:aa544875cef9bd05bf71d6c19be06cf7c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af33b23e2614f3966bbaf2554890c032a"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a">pageSize</a> () const </td></tr>
|
||||
<tr class="memdesc:af33b23e2614f3966bbaf2554890c032a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of a single EEPROM page in bytes. <a href="#af33b23e2614f3966bbaf2554890c032a"></a><br/></td></tr>
|
||||
<tr class="memdesc:af33b23e2614f3966bbaf2554890c032a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of a single EEPROM page in bytes. <a href="#af33b23e2614f3966bbaf2554890c032a">More...</a><br/></td></tr>
|
||||
<tr class="separator:af33b23e2614f3966bbaf2554890c032a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af8b70971d882b06de3fc6644a8ece3cf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf">available</a> ()</td></tr>
|
||||
<tr class="memdesc:af8b70971d882b06de3fc6644a8ece3cf"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the EEPROM is available on the I2C bus; false otherwise. <a href="#af8b70971d882b06de3fc6644a8ece3cf"></a><br/></td></tr>
|
||||
<tr class="memdesc:af8b70971d882b06de3fc6644a8ece3cf"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the EEPROM is available on the I2C bus; false otherwise. <a href="#af8b70971d882b06de3fc6644a8ece3cf">More...</a><br/></td></tr>
|
||||
<tr class="separator:af8b70971d882b06de3fc6644a8ece3cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a960971377d4decb122ff38d12603e586"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586">read</a> (unsigned long address)</td></tr>
|
||||
<tr class="memdesc:a960971377d4decb122ff38d12603e586"><td class="mdescLeft"> </td><td class="mdescRight">Reads a single byte from the EEPROM at <em>address</em>. <a href="#a960971377d4decb122ff38d12603e586"></a><br/></td></tr>
|
||||
<tr class="memdesc:a960971377d4decb122ff38d12603e586"><td class="mdescLeft"> </td><td class="mdescRight">Reads a single byte from the EEPROM at <em>address</em>. <a href="#a960971377d4decb122ff38d12603e586">More...</a><br/></td></tr>
|
||||
<tr class="separator:a960971377d4decb122ff38d12603e586"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a63e23dc014415f947975359ac09f627e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#a63e23dc014415f947975359ac09f627e">read</a> (unsigned long address, void *data, size_t length)</td></tr>
|
||||
<tr class="memdesc:a63e23dc014415f947975359ac09f627e"><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of <em>length</em> bytes from the EEPROM at <em>address</em> into the specified <em>data</em> buffer. <a href="#a63e23dc014415f947975359ac09f627e"></a><br/></td></tr>
|
||||
<tr class="memdesc:a63e23dc014415f947975359ac09f627e"><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of <em>length</em> bytes from the EEPROM at <em>address</em> into the specified <em>data</em> buffer. <a href="#a63e23dc014415f947975359ac09f627e">More...</a><br/></td></tr>
|
||||
<tr class="separator:a63e23dc014415f947975359ac09f627e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9e017772e3459ee4ab987e27d78937f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8">write</a> (unsigned long address, uint8_t value)</td></tr>
|
||||
<tr class="memdesc:a9e017772e3459ee4ab987e27d78937f8"><td class="mdescLeft"> </td><td class="mdescRight">Writes a byte <em>value</em> to <em>address</em> in the EEPROM. <a href="#a9e017772e3459ee4ab987e27d78937f8"></a><br/></td></tr>
|
||||
<tr class="memdesc:a9e017772e3459ee4ab987e27d78937f8"><td class="mdescLeft"> </td><td class="mdescRight">Writes a byte <em>value</em> to <em>address</em> in the EEPROM. <a href="#a9e017772e3459ee4ab987e27d78937f8">More...</a><br/></td></tr>
|
||||
<tr class="separator:a9e017772e3459ee4ab987e27d78937f8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3d918ed34da7ca6d21a776c0614eebf3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classEEPROM24.html#a3d918ed34da7ca6d21a776c0614eebf3">write</a> (unsigned long address, const void *data, size_t length)</td></tr>
|
||||
<tr class="memdesc:a3d918ed34da7ca6d21a776c0614eebf3"><td class="mdescLeft"> </td><td class="mdescRight">Writes <em>length</em> bytes from a <em>data</em> buffer to <em>address</em> in the EEPROM. <a href="#a3d918ed34da7ca6d21a776c0614eebf3"></a><br/></td></tr>
|
||||
<tr class="memdesc:a3d918ed34da7ca6d21a776c0614eebf3"><td class="mdescLeft"> </td><td class="mdescRight">Writes <em>length</em> bytes from a <em>data</em> buffer to <em>address</em> in the EEPROM. <a href="#a3d918ed34da7ca6d21a776c0614eebf3">More...</a><br/></td></tr>
|
||||
<tr class="separator:a3d918ed34da7ca6d21a776c0614eebf3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Reading and writing EEPROM's from the 24LCXX family. </p>
|
||||
<p>The 24LCXX family of EEPROM's provide a variety of memory sizes from 16 bytes up to 128 kBytes that can be accessed via the I2C protocol. These chips can be used to augment the 1 kByte or so of builtin EEPROM memory that is typical on Arduino boards. The EEPROM should be wired to an Arduino Uno as follows:</p>
|
||||
<div class="image">
|
||||
<img src="eeprom_circuit.png" alt="eeprom_circuit.png"/>
|
||||
</div>
|
||||
<p>Access to a 24LCXX chip is initialized as follows:</p>
|
||||
<div class="fragment"><div class="line"><a class="code" href="classSoftI2C.html" title="Bit-banged implementation of an I2C master.">SoftI2C</a> i2c(A4, A5);</div>
|
||||
<div class="line"><a class="code" href="classEEPROM24.html" title="Reading and writing EEPROM's from the 24LCXX family.">EEPROM24</a> eeprom(i2c, EEPROM_24LC256);</div>
|
||||
</div><!-- fragment --><p>Once initialized, <a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read()</a> and <a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write()</a> can be used to manipulate the contents of the EEPROM's memory.</p>
|
||||
<div class="fragment"><div class="line"><a class="code" href="classSoftI2C.html">SoftI2C</a> i2c(A4, A5);</div>
|
||||
<div class="line"><a class="code" href="classEEPROM24.html">EEPROM24</a> eeprom(i2c, EEPROM_24LC256);</div>
|
||||
</div><!-- fragment --><p>Once initialized, <a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address. ">read()</a> and <a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM. ">write()</a> can be used to manipulate the contents of the EEPROM's memory.</p>
|
||||
<p>The following EEPROM types are supported by this class:</p>
|
||||
<table class="doxtable">
|
||||
<tr>
|
||||
@@ -162,13 +171,13 @@ Public Member Functions</h2></td></tr>
|
||||
<td>24lc1026</td><td><code>EEPROM_24LC1026</code> </td><td>128 kBytes </td></tr>
|
||||
</table>
|
||||
<p>There can be multiple 24LCXX chips on the same I2C bus, as long as their A0, A1, and A2 address pins are set to different values. For example, two 24LC256 chips can be used to provide the same memory capacity as a single 24LC512 chip. The optional <em>bank</em> parameter to the constructor is used to assign different bank addresses to each chip:</p>
|
||||
<div class="fragment"><div class="line"><a class="code" href="classSoftI2C.html" title="Bit-banged implementation of an I2C master.">SoftI2C</a> i2c(A4, A5);</div>
|
||||
<div class="line"><a class="code" href="classEEPROM24.html" title="Reading and writing EEPROM's from the 24LCXX family.">EEPROM24</a> eeprom0(i2c, EEPROM_24LC256, 0);</div>
|
||||
<div class="line"><a class="code" href="classEEPROM24.html" title="Reading and writing EEPROM's from the 24LCXX family.">EEPROM24</a> eeprom1(i2c, EEPROM_24LC256, 1);</div>
|
||||
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a> </dd></dl>
|
||||
<div class="fragment"><div class="line"><a class="code" href="classSoftI2C.html">SoftI2C</a> i2c(A4, A5);</div>
|
||||
<div class="line"><a class="code" href="classEEPROM24.html">EEPROM24</a> eeprom0(i2c, EEPROM_24LC256, 0);</div>
|
||||
<div class="line"><a class="code" href="classEEPROM24.html">EEPROM24</a> eeprom1(i2c, EEPROM_24LC256, 1);</div>
|
||||
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html" title="Abstract base class for I2C master implementations. ">I2CMaster</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8h_source.html#l00060">60</a> of file <a class="el" href="EEPROM24_8h_source.html">EEPROM24.h</a>.</p>
|
||||
</div><h2>Constructor & Destructor Documentation</h2>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="ae8547f6ff7711496e1959ee24a142995"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -206,7 +215,7 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2>Member Function Documentation</h2>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="af8b70971d882b06de3fc6644a8ece3cf"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -222,7 +231,7 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Returns true if the EEPROM is available on the I2C bus; false otherwise. </p>
|
||||
<p>This function can be used to probe the I2C bus to determine if the EEPROM is present or not.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read()</a>, <a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address. ">read()</a>, <a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM. ">write()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8cpp_source.html#l00152">152</a> of file <a class="el" href="EEPROM24_8cpp_source.html">EEPROM24.cpp</a>.</p>
|
||||
|
||||
@@ -251,7 +260,7 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Returns the size of a single EEPROM page in bytes. </p>
|
||||
<p>Writes that are a multiple of the page size and aligned on a page boundary will typically be more efficient than non-aligned writes.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes.">size()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes. ">size()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8h_source.html#l00066">66</a> of file <a class="el" href="EEPROM24_8h_source.html">EEPROM24.h</a>.</p>
|
||||
|
||||
@@ -272,7 +281,7 @@ Public Member Functions</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads a single byte from the EEPROM at <em>address</em>. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM. ">write()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8cpp_source.html#l00167">167</a> of file <a class="el" href="EEPROM24_8cpp_source.html">EEPROM24.cpp</a>.</p>
|
||||
|
||||
@@ -309,8 +318,8 @@ Public Member Functions</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads a block of <em>length</em> bytes from the EEPROM at <em>address</em> into the specified <em>data</em> buffer. </p>
|
||||
<p>Returns the number of bytes that were read, which may be short if <em>address</em> + <em>length</em> is greater than <a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes.">size()</a> or the EEPROM is not available on the I2C bus.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write()</a>, <a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise.">available()</a> </dd></dl>
|
||||
<p>Returns the number of bytes that were read, which may be short if <em>address</em> + <em>length</em> is greater than <a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes. ">size()</a> or the EEPROM is not available on the I2C bus.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM. ">write()</a>, <a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise. ">available()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8cpp_source.html#l00187">187</a> of file <a class="el" href="EEPROM24_8cpp_source.html">EEPROM24.cpp</a>.</p>
|
||||
|
||||
@@ -338,7 +347,7 @@ Public Member Functions</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the size of the EEPROM in bytes. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes.">pageSize()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes. ">pageSize()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8h_source.html#l00065">65</a> of file <a class="el" href="EEPROM24_8h_source.html">EEPROM24.h</a>.</p>
|
||||
|
||||
@@ -370,7 +379,7 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Writes a byte <em>value</em> to <em>address</em> in the EEPROM. </p>
|
||||
<p>Returns true if the byte was written successfully, or false if <em>address</em> is out of range or the EEPROM is not available on the I2C bus.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read()</a>, <a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise.">available()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address. ">read()</a>, <a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise. ">available()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8cpp_source.html#l00213">213</a> of file <a class="el" href="EEPROM24_8cpp_source.html">EEPROM24.cpp</a>.</p>
|
||||
|
||||
@@ -407,9 +416,9 @@ Public Member Functions</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Writes <em>length</em> bytes from a <em>data</em> buffer to <em>address</em> in the EEPROM. </p>
|
||||
<p>Returns the number of bytes that were written, which may be short if <em>address</em> + <em>length</em> is greater than <a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes.">size()</a> or the EEPROM is not available on the I2C bus.</p>
|
||||
<p>Best performance will be achieved if <em>address</em> and <em>length</em> are a multiple of <a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes.">pageSize()</a>.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read()</a>, <a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise.">available()</a>, <a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes.">pageSize()</a> </dd></dl>
|
||||
<p>Returns the number of bytes that were written, which may be short if <em>address</em> + <em>length</em> is greater than <a class="el" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes. ">size()</a> or the EEPROM is not available on the I2C bus.</p>
|
||||
<p>Best performance will be achieved if <em>address</em> and <em>length</em> are a multiple of <a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes. ">pageSize()</a>.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address. ">read()</a>, <a class="el" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise. ">available()</a>, <a class="el" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes. ">pageSize()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="EEPROM24_8cpp_source.html#l00235">235</a> of file <a class="el" href="EEPROM24_8cpp_source.html">EEPROM24.cpp</a>.</p>
|
||||
|
||||
@@ -422,9 +431,9 @@ Public Member Functions</h2></td></tr>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by  <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>
|
||||
|
||||
Reference in New Issue
Block a user