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

35
SoftI2C_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: SoftI2C.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,19 +115,19 @@ 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 &quot;I2CMaster.h&quot;</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="classSoftI2C.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classSoftI2C.html" title="Bit-banged implementation of an I2C master.">SoftI2C</a> : <span class="keyword">public</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="classSoftI2C.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classSoftI2C.html">SoftI2C</a> : <span class="keyword">public</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; <a class="code" href="classSoftI2C.html#adb6e00ee3f930f1d32010a18feb5f6cc" title="Constructs a new software I2C master on dataPin and clockPin.">SoftI2C</a>(uint8_t dataPin, uint8_t clockPin);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="classSoftI2C.html#adb6e00ee3f930f1d32010a18feb5f6cc">SoftI2C</a>(uint8_t dataPin, uint8_t clockPin);</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="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classSoftI2C.html#aad488669f28f6a5a4ceaae3de61d38f4" 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>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classSoftI2C.html#aad488669f28f6a5a4ceaae3de61d38f4">maxTransferSize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classSoftI2C.html#aa8a3219f4e6ff52306cc3c219f37d8f9" 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="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classSoftI2C.html#ab46f0b6363c9cfe6fb3ab907956d5d73" title="Writes a single byte value on the I2C bus.">write</a>(uint8_t value);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classSoftI2C.html#aa12ae82813598b2e9ea70463c23c5bf3" title="Ends the current write operation.">endWrite</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classSoftI2C.html#aa8a3219f4e6ff52306cc3c219f37d8f9">startWrite</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> address);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classSoftI2C.html#ab46f0b6363c9cfe6fb3ab907956d5d73">write</a>(uint8_t value);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classSoftI2C.html#aa12ae82813598b2e9ea70463c23c5bf3">endWrite</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classSoftI2C.html#aa0dafc067cfa374af75e060dca647ec3" 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);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classSoftI2C.html#a849af91018caedbb82e83f02c543305e" title="Returns the number of bytes that are still available for reading.">available</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint8_t <a class="code" href="classSoftI2C.html#a330dbba5b726fa161a6b01a9ca49e1bc" title="Reads a single byte from the I2C bus.">read</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classSoftI2C.html#aa0dafc067cfa374af75e060dca647ec3">startRead</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> address, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classSoftI2C.html#a849af91018caedbb82e83f02c543305e">available</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint8_t <a class="code" href="classSoftI2C.html#a330dbba5b726fa161a6b01a9ca49e1bc">read</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint8_t _dataPin;</div>
@@ -143,12 +144,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classSoftI2C_html"><div class="ttname"><a href="classSoftI2C.html">SoftI2C</a></div><div class="ttdoc">Bit-banged implementation of an I2C master. </div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8h_source.html#l00028">SoftI2C.h:28</a></div></div>
<div class="ttc" id="classSoftI2C_html_aa0dafc067cfa374af75e060dca647ec3"><div class="ttname"><a href="classSoftI2C.html#aa0dafc067cfa374af75e060dca647ec3">SoftI2C::startRead</a></div><div class="ttdeci">bool startRead(unsigned int address, unsigned int count)</div><div class="ttdoc">Starts a read operation for count bytes by sending the start condition and the I2C control byte...</div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00135">SoftI2C.cpp:135</a></div></div>
<div class="ttc" id="classSoftI2C_html_aa12ae82813598b2e9ea70463c23c5bf3"><div class="ttname"><a href="classSoftI2C.html#aa12ae82813598b2e9ea70463c23c5bf3">SoftI2C::endWrite</a></div><div class="ttdeci">bool endWrite()</div><div class="ttdoc">Ends the current write operation. </div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00129">SoftI2C.cpp:129</a></div></div>
<div class="ttc" id="classSoftI2C_html_adb6e00ee3f930f1d32010a18feb5f6cc"><div class="ttname"><a href="classSoftI2C.html#adb6e00ee3f930f1d32010a18feb5f6cc">SoftI2C::SoftI2C</a></div><div class="ttdeci">SoftI2C(uint8_t dataPin, uint8_t clockPin)</div><div class="ttdoc">Constructs a new software I2C master on dataPin and clockPin. </div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00050">SoftI2C.cpp:50</a></div></div>
<div class="ttc" id="classSoftI2C_html_a849af91018caedbb82e83f02c543305e"><div class="ttname"><a href="classSoftI2C.html#a849af91018caedbb82e83f02c543305e">SoftI2C::available</a></div><div class="ttdeci">unsigned int available()</div><div class="ttdoc">Returns the number of bytes that are still available for reading. </div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00155">SoftI2C.cpp:155</a></div></div>
<div class="ttc" id="classSoftI2C_html_a330dbba5b726fa161a6b01a9ca49e1bc"><div class="ttname"><a href="classSoftI2C.html#a330dbba5b726fa161a6b01a9ca49e1bc">SoftI2C::read</a></div><div class="ttdeci">uint8_t read()</div><div class="ttdoc">Reads a single byte from the I2C bus. </div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00160">SoftI2C.cpp:160</a></div></div>
<div class="ttc" id="classSoftI2C_html_ab46f0b6363c9cfe6fb3ab907956d5d73"><div class="ttname"><a href="classSoftI2C.html#ab46f0b6363c9cfe6fb3ab907956d5d73">SoftI2C::write</a></div><div class="ttdeci">void write(uint8_t value)</div><div class="ttdoc">Writes a single byte value on the I2C bus. </div><div class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00118">SoftI2C.cpp:118</a></div></div>
<div class="ttc" id="classSoftI2C_html_aad488669f28f6a5a4ceaae3de61d38f4"><div class="ttname"><a href="classSoftI2C.html#aad488669f28f6a5a4ceaae3de61d38f4">SoftI2C::maxTransferSize</a></div><div class="ttdeci">unsigned int maxTransferSize() const </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 class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00065">SoftI2C.cpp:65</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="classSoftI2C_html_aa8a3219f4e6ff52306cc3c219f37d8f9"><div class="ttname"><a href="classSoftI2C.html#aa8a3219f4e6ff52306cc3c219f37d8f9">SoftI2C::startWrite</a></div><div class="ttdeci">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 class="ttdef"><b>Definition:</b> <a href="SoftI2C_8cpp_source.html#l00104">SoftI2C.cpp:104</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>