1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
arduinolibs/classI2CMaster.html
Rhys Weatherley 9d2e774894 Update docs
2016-08-27 14:32:42 +10:00

337 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>ArduinoLibs: I2CMaster 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">ArduinoLibs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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> &#124;
<a href="classI2CMaster-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">I2CMaster Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract base class for I2C master implementations.
<a href="classI2CMaster.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="I2CMaster_8h_source.html">I2CMaster.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for I2CMaster:</div>
<div class="dyncontent">
<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"/>
</map>
</div></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: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">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">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">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">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">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">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 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>
<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 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6458fa99cfd9e6270ae6dff993955833"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int I2CMaster::available </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>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>
<p>Implemented in <a class="el" href="classSoftI2C.html#a849af91018caedbb82e83f02c543305e">SoftI2C</a>.</p>
</div>
</div>
<a class="anchor" id="ab29f63551ddeb032a91505d1c0b8ac41"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool I2CMaster::endWrite </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>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>
<p>Implemented in <a class="el" href="classSoftI2C.html#aa12ae82813598b2e9ea70463c23c5bf3">SoftI2C</a>.</p>
</div>
</div>
<a class="anchor" id="a49eeebb57f6bc06de39973fe836369cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t I2CMaster::read </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>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>
<p>Implemented in <a class="el" href="classSoftI2C.html#a330dbba5b726fa161a6b01a9ca49e1bc">SoftI2C</a>.</p>
</div>
</div>
<a class="anchor" id="a4e5f1a1a4c2242699be5a35fc4872fde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool I2CMaster::startRead </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>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>Implemented in <a class="el" href="classSoftI2C.html#aa0dafc067cfa374af75e060dca647ec3">SoftI2C</a>.</p>
</div>
</div>
<a class="anchor" id="a01960fc821cb25e4c88c26d2c6107e35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void I2CMaster::startWrite </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>
<p>Reimplemented in <a class="el" href="classSoftI2C.html#aa8a3219f4e6ff52306cc3c219f37d8f9">SoftI2C</a>.</p>
</div>
</div>
<a class="anchor" id="a0bf6b84cb1e2b3a37a4a0260d0b6f960"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void I2CMaster::write </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>value</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>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>
<p>Implemented in <a class="el" href="classSoftI2C.html#ab46f0b6363c9cfe6fb3ab907956d5d73">SoftI2C</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="I2CMaster_8h_source.html">I2CMaster.h</a></li>
<li><a class="el" href="I2CMaster_8cpp_source.html">I2CMaster.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Aug 27 2016 14:32:20 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>