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

52
classI2CMaster.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: I2CMaster 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>
@@ -86,7 +87,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classI2CMaster-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">I2CMaster Class Reference</div> </div>
<div class="title">I2CMaster Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
@@ -100,34 +101,41 @@ Inheritance diagram for I2CMaster:</div>
<div class="center">
<img src="classI2CMaster.png" usemap="#I2CMaster_map" alt=""/>
<map id="I2CMaster_map" name="I2CMaster_map">
<area href="classSoftI2C.html" title="Bit-banged implementation of an I2C master." alt="SoftI2C" shape="rect" coords="0,56,70,80"/>
<area href="classSoftI2C.html" title="Bit-banged implementation of an I2C master. " alt="SoftI2C" shape="rect" coords="0,56,70,80"/>
</map>
</div></div>
<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:a3cd0cea8169ac4e6dd6f39fd6cfb1926"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cd0cea8169ac4e6dd6f39fd6cfb1926"></a>
virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#a3cd0cea8169ac4e6dd6f39fd6cfb1926">maxTransferSize</a> () const =0</td></tr>
<tr class="memdesc:a3cd0cea8169ac4e6dd6f39fd6cfb1926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the maximum number of bytes that can be read or written in a single request by this bus master. <br/></td></tr>
<tr class="separator:a3cd0cea8169ac4e6dd6f39fd6cfb1926"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01960fc821cb25e4c88c26d2c6107e35"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35">startWrite</a> (unsigned int address)</td></tr>
<tr class="memdesc:a01960fc821cb25e4c88c26d2c6107e35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a write operation by sending a start condition and the I2C control byte. <a href="#a01960fc821cb25e4c88c26d2c6107e35"></a><br/></td></tr>
<tr class="memdesc:a01960fc821cb25e4c88c26d2c6107e35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a write operation by sending a start condition and the I2C control byte. <a href="#a01960fc821cb25e4c88c26d2c6107e35">More...</a><br/></td></tr>
<tr class="separator:a01960fc821cb25e4c88c26d2c6107e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bf6b84cb1e2b3a37a4a0260d0b6f960"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960">write</a> (uint8_t value)=0</td></tr>
<tr class="memdesc:a0bf6b84cb1e2b3a37a4a0260d0b6f960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a single byte <em>value</em> on the I2C bus. <a href="#a0bf6b84cb1e2b3a37a4a0260d0b6f960"></a><br/></td></tr>
<tr class="memdesc:a0bf6b84cb1e2b3a37a4a0260d0b6f960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a single byte <em>value</em> on the I2C bus. <a href="#a0bf6b84cb1e2b3a37a4a0260d0b6f960">More...</a><br/></td></tr>
<tr class="separator:a0bf6b84cb1e2b3a37a4a0260d0b6f960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab29f63551ddeb032a91505d1c0b8ac41"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41">endWrite</a> ()=0</td></tr>
<tr class="memdesc:ab29f63551ddeb032a91505d1c0b8ac41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends the current write operation. <a href="#ab29f63551ddeb032a91505d1c0b8ac41"></a><br/></td></tr>
<tr class="memdesc:ab29f63551ddeb032a91505d1c0b8ac41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends the current write operation. <a href="#ab29f63551ddeb032a91505d1c0b8ac41">More...</a><br/></td></tr>
<tr class="separator:ab29f63551ddeb032a91505d1c0b8ac41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e5f1a1a4c2242699be5a35fc4872fde"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde">startRead</a> (unsigned int address, unsigned int count)=0</td></tr>
<tr class="memdesc:a4e5f1a1a4c2242699be5a35fc4872fde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a read operation for <em>count</em> bytes by sending the start condition and the I2C control byte. <a href="#a4e5f1a1a4c2242699be5a35fc4872fde"></a><br/></td></tr>
<tr class="memdesc:a4e5f1a1a4c2242699be5a35fc4872fde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a read operation for <em>count</em> bytes by sending the start condition and the I2C control byte. <a href="#a4e5f1a1a4c2242699be5a35fc4872fde">More...</a><br/></td></tr>
<tr class="separator:a4e5f1a1a4c2242699be5a35fc4872fde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6458fa99cfd9e6270ae6dff993955833"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833">available</a> ()=0</td></tr>
<tr class="memdesc:a6458fa99cfd9e6270ae6dff993955833"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes that are still available for reading. <a href="#a6458fa99cfd9e6270ae6dff993955833"></a><br/></td></tr>
<tr class="memdesc:a6458fa99cfd9e6270ae6dff993955833"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes that are still available for reading. <a href="#a6458fa99cfd9e6270ae6dff993955833">More...</a><br/></td></tr>
<tr class="separator:a6458fa99cfd9e6270ae6dff993955833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49eeebb57f6bc06de39973fe836369cd"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd">read</a> ()=0</td></tr>
<tr class="memdesc:a49eeebb57f6bc06de39973fe836369cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a single byte from the I2C bus. <a href="#a49eeebb57f6bc06de39973fe836369cd"></a><br/></td></tr>
<tr class="memdesc:a49eeebb57f6bc06de39973fe836369cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a single byte from the I2C bus. <a href="#a49eeebb57f6bc06de39973fe836369cd">More...</a><br/></td></tr>
<tr class="separator:a49eeebb57f6bc06de39973fe836369cd"><td class="memSeparator" colspan="2">&#160;</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>Abstract base class for I2C master implementations. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSoftI2C.html" title="Bit-banged implementation of an I2C master.">SoftI2C</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSoftI2C.html" title="Bit-banged implementation of an I2C master. ">SoftI2C</a> </dd></dl>
<p>Definition at line <a class="el" href="I2CMaster_8h_source.html#l00028">28</a> of file <a class="el" href="I2CMaster_8h_source.html">I2CMaster.h</a>.</p>
</div><h2>Member Function Documentation</h2>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6458fa99cfd9e6270ae6dff993955833"></a>
<div class="memitem">
<div class="memproto">
@@ -150,7 +158,7 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
</div><div class="memdoc">
<p>Returns the number of bytes that are still available for reading. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead()</a>, <a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus.">read()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead()</a>, <a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus. ">read()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSoftI2C.html#a849af91018caedbb82e83f02c543305e">SoftI2C</a>.</p>
@@ -179,7 +187,7 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Ends the current write operation. </p>
<p>Returns true if the write operation was acknowledged; false otherwise.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte.">startWrite()</a>, <a class="el" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960" title="Writes a single byte value on the I2C bus.">write()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte. ">startWrite()</a>, <a class="el" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960" title="Writes a single byte value on the I2C bus. ">write()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSoftI2C.html#aa12ae82813598b2e9ea70463c23c5bf3">SoftI2C</a>.</p>
@@ -207,7 +215,7 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
</div><div class="memdoc">
<p>Reads a single byte from the I2C bus. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead()</a>, <a class="el" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833" title="Returns the number of bytes that are still available for reading.">available()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead()</a>, <a class="el" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833" title="Returns the number of bytes that are still available for reading. ">available()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSoftI2C.html#a330dbba5b726fa161a6b01a9ca49e1bc">SoftI2C</a>.</p>
@@ -247,8 +255,8 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Starts a read operation for <em>count</em> bytes by sending the start condition and the I2C control byte. </p>
<p>The <em>address</em> must be the 7-bit or 10-bit address of the I2C slave on the bus.</p>
<p>Returns true if the read request was acknowledged by the I2C slave or false otherwise. If true, this function should be followed by <em>count</em> calls to <a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus.">read()</a> to fetch the bytes.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833" title="Returns the number of bytes that are still available for reading.">available()</a>, <a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus.">read()</a>, <a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte.">startWrite()</a> </dd></dl>
<p>Returns true if the read request was acknowledged by the I2C slave or false otherwise. If true, this function should be followed by <em>count</em> calls to <a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus. ">read()</a> to fetch the bytes.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833" title="Returns the number of bytes that are still available for reading. ">available()</a>, <a class="el" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus. ">read()</a>, <a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte. ">startWrite()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSoftI2C.html#aa0dafc067cfa374af75e060dca647ec3">SoftI2C</a>.</p>
@@ -278,7 +286,7 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Starts a write operation by sending a start condition and the I2C control byte. </p>
<p>The <em>address</em> must be the 7-bit or 10-bit address of the I2C slave on the bus.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960" title="Writes a single byte value on the I2C bus.">write()</a>, <a class="el" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41" title="Ends the current write operation.">endWrite()</a>, <a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960" title="Writes a single byte value on the I2C bus. ">write()</a>, <a class="el" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41" title="Ends the current write operation. ">endWrite()</a>, <a class="el" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classSoftI2C.html#aa8a3219f4e6ff52306cc3c219f37d8f9">SoftI2C</a>.</p>
@@ -307,7 +315,7 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
</div><div class="memdoc">
<p>Writes a single byte <em>value</em> on the I2C bus. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte.">startWrite()</a>, <a class="el" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41" title="Ends the current write operation.">endWrite()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte. ">startWrite()</a>, <a class="el" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41" title="Ends the current write operation. ">endWrite()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSoftI2C.html#ab46f0b6363c9cfe6fb3ab907956d5d73">SoftI2C</a>.</p>
@@ -320,9 +328,9 @@ virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class
</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>