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

31
I2CMaster_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: I2CMaster.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>
@@ -114,26 +115,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<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;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classI2CMaster.html"> 28</a></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="l00028"></a><span class="lineno"><a class="line" href="classI2CMaster.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classI2CMaster.html">I2CMaster</a> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classI2CMaster.html#a3cd0cea8169ac4e6dd6f39fd6cfb1926" title="Returns the maximum number of bytes that can be read or written in a single request by this bus maste...">maxTransferSize</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classI2CMaster.html#a3cd0cea8169ac4e6dd6f39fd6cfb1926">maxTransferSize</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35" title="Starts a write operation by sending a start condition and the I2C control byte.">startWrite</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> address);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960" title="Writes a single byte value on the I2C bus.">write</a>(uint8_t value) = 0;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41" title="Ends the current write operation.">endWrite</a>() = 0;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35">startWrite</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> address);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960">write</a>(uint8_t value) = 0;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41">endWrite</a>() = 0;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde" title="Starts a read operation for count bytes by sending the start condition and the I2C control byte...">startRead</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> address, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count) = 0;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833" title="Returns the number of bytes that are still available for reading.">available</a>() = 0;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd" title="Reads a single byte from the I2C bus.">read</a>() = 0;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde">startRead</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> address, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count) = 0;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833">available</a>() = 0;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd">read</a>() = 0;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;};</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classI2CMaster_html_a0bf6b84cb1e2b3a37a4a0260d0b6f960"><div class="ttname"><a href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960">I2CMaster::write</a></div><div class="ttdeci">virtual void write(uint8_t value)=0</div><div class="ttdoc">Writes a single byte value on the I2C bus. </div></div>
<div class="ttc" id="classI2CMaster_html_a4e5f1a1a4c2242699be5a35fc4872fde"><div class="ttname"><a href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde">I2CMaster::startRead</a></div><div class="ttdeci">virtual bool startRead(unsigned int address, unsigned int count)=0</div><div class="ttdoc">Starts a read operation for count bytes by sending the start condition and the I2C control byte...</div></div>
<div class="ttc" id="classI2CMaster_html_a3cd0cea8169ac4e6dd6f39fd6cfb1926"><div class="ttname"><a href="classI2CMaster.html#a3cd0cea8169ac4e6dd6f39fd6cfb1926">I2CMaster::maxTransferSize</a></div><div class="ttdeci">virtual unsigned int maxTransferSize() const =0</div><div class="ttdoc">Returns the maximum number of bytes that can be read or written in a single request by this bus maste...</div></div>
<div class="ttc" id="classI2CMaster_html_a6458fa99cfd9e6270ae6dff993955833"><div class="ttname"><a href="classI2CMaster.html#a6458fa99cfd9e6270ae6dff993955833">I2CMaster::available</a></div><div class="ttdeci">virtual unsigned int available()=0</div><div class="ttdoc">Returns the number of bytes that are still available for reading. </div></div>
<div class="ttc" id="classI2CMaster_html_a01960fc821cb25e4c88c26d2c6107e35"><div class="ttname"><a href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35">I2CMaster::startWrite</a></div><div class="ttdeci">virtual void startWrite(unsigned int address)</div><div class="ttdoc">Starts a write operation by sending a start condition and the I2C control byte. </div></div>
<div class="ttc" id="classI2CMaster_html_ab29f63551ddeb032a91505d1c0b8ac41"><div class="ttname"><a href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41">I2CMaster::endWrite</a></div><div class="ttdeci">virtual bool endWrite()=0</div><div class="ttdoc">Ends the current write operation. </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="classI2CMaster_html_a49eeebb57f6bc06de39973fe836369cd"><div class="ttname"><a href="classI2CMaster.html#a49eeebb57f6bc06de39973fe836369cd">I2CMaster::read</a></div><div class="ttdeci">virtual uint8_t read()=0</div><div class="ttdoc">Reads a single byte from the I2C bus. </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>