avr/cI2C
avr/cI2C
1
0
Fork 0
mirror of https://github.com/SMFSW/cI2C synced 2024-11-22 09:54:23 +01:00
Code Issues Releases Wiki Activity
8790fed763
cI2C/html/ci2c__master__read_8ino.html
Travis CI 8790fed763 Deploy code docs to GitHub Pages Travis build: 17 
Commit: b9babcdde0
2018-05-04 15:51:12 +00:00

201 lines
11 KiB
HTML
Raw Blame History

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arduino Hardware I2C for AVR MCUs (plain c): examples/ci2c_master_read/ci2c_master_read.ino File 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino Hardware I2C for AVR MCUs (plain c)
&#160;<span id="projectnumber">1.3</span>
</div>
<div id="projectbrief">Arduino Hardware I2C for AVR MCUs (plain c) documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d28a4824dc47e487b107a5db32ef43c4.html">examples</a></li><li class="navelem"><a class="el" href="dir_da41f142aa2492330ee0814d5b195d46.html">ci2c_master_read</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">ci2c_master_read.ino File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="ci2c_8h_source.html">ci2c.h</a>&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ci2c_master_read.ino:</div>
<div class="dyncontent">
<div class="center"><img src="ci2c__master__read_8ino__incl.png" border="0" usemap="#examples_2ci2c__master__read_2ci2c__master__read_8ino" alt=""/></div>
<map name="examples_2ci2c__master__read_2ci2c__master__read_8ino" id="examples_2ci2c__master__read_2ci2c__master__read_8ino">
<area shape="rect" id="node2" href="ci2c_8h.html" title="arduino i2c in plain c declarations " alt="" coords="118,96,175,123"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4fc01d736fe50cf5b977f755b675f11d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ci2c__master__read_8ino.html#a4fc01d736fe50cf5b977f755b675f11d">setup</a> ()</td></tr>
<tr class="separator:a4fc01d736fe50cf5b977f755b675f11d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe461d27b9c48d5921c00d521181f12f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ci2c__master__read_8ino.html#afe461d27b9c48d5921c00d521181f12f">loop</a> ()</td></tr>
<tr class="separator:afe461d27b9c48d5921c00d521181f12f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2fc323c2ac98fd84324b5f6c4196e876"><td class="memItemLeft" align="right" valign="top">const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ci2c__master__read_8ino.html#a2fc323c2ac98fd84324b5f6c4196e876">blank</a> = 0xEE</td></tr>
<tr class="separator:a2fc323c2ac98fd84324b5f6c4196e876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59b901a6dacd5ea8c9ceaa93cd8a1b2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ci2c_8h.html#a916f30ff94044ecc9f8a177446da485a">I2C_SLAVE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ci2c__master__read_8ino.html#a59b901a6dacd5ea8c9ceaa93cd8a1b2b">FRAM</a></td></tr>
<tr class="separator:a59b901a6dacd5ea8c9ceaa93cd8a1b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="afe461d27b9c48d5921c00d521181f12f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe461d27b9c48d5921c00d521181f12f">&#9670;&nbsp;</a></span>loop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void loop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="ci2c__master__read_8ino_afe461d27b9c48d5921c00d521181f12f_cgraph.png" border="0" usemap="#ci2c__master__read_8ino_afe461d27b9c48d5921c00d521181f12f_cgraph" alt=""/></div>
<map name="ci2c__master__read_8ino_afe461d27b9c48d5921c00d521181f12f_cgraph" id="ci2c__master__read_8ino_afe461d27b9c48d5921c00d521181f12f_cgraph">
<area shape="rect" id="node2" href="ci2c_8c.html#ad5e4a006f6cea5844a810fab30b40f87" title="This function reads data from the address specified and stores this data in the area provided by the ..." alt="" coords="117,107,192,133"/>
<area shape="rect" id="node3" href="ci2c_8h.html#afc15fc625892e1e50e831d7934073299" title="This inline is a wrapper to I2C_read in case of contigous operations. " alt="" coords="101,157,208,184"/>
<area shape="rect" id="node4" href="ci2c_8h.html#ad5e4a006f6cea5844a810fab30b40f87" title="This function reads data from the address specified and stores this data in the area provided by the ..." alt="" coords="268,5,343,32"/>
<area shape="rect" id="node5" href="ci2c_8h.html#a2c25bc5fdf909b7d45d722970eb04d82" title="I2C bus reset (Release SCL and SDA lines and re&#45;enable module) " alt="" coords="266,56,345,83"/>
<area shape="rect" id="node6" href="ci2c_8h.html#aaadadbb29f315f2030223665f1988188" title="Send start condition. " alt="" coords="267,107,343,133"/>
<area shape="rect" id="node7" href="ci2c_8h.html#a53eb804c24e8e86717f7aaebdab1aa53" title="Send stop condition. " alt="" coords="268,157,343,184"/>
<area shape="rect" id="node8" href="ci2c_8h.html#ab20db75dfa22dc47df506cab3bd11c60" title="Send byte on bus. " alt="" coords="270,208,341,235"/>
<area shape="rect" id="node9" href="ci2c_8h.html#a8d6d7eb118ea1505df039075a00c267b" title="Receive byte from bus. " alt="" coords="271,259,339,285"/>
<area shape="rect" id="node10" href="ci2c_8h.html#aae536cceb33d07e71af9d459a2fc6dc8" title="Send I2C address. " alt="" coords="256,309,355,336"/>
</map>
</div>
</div>
</div>
<a id="a4fc01d736fe50cf5b977f755b675f11d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fc01d736fe50cf5b977f755b675f11d">&#9670;&nbsp;</a></span>setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="ci2c__master__read_8ino_a4fc01d736fe50cf5b977f755b675f11d_cgraph.png" border="0" usemap="#ci2c__master__read_8ino_a4fc01d736fe50cf5b977f755b675f11d_cgraph" alt=""/></div>
<map name="ci2c__master__read_8ino_a4fc01d736fe50cf5b977f755b675f11d_cgraph" id="ci2c__master__read_8ino_a4fc01d736fe50cf5b977f755b675f11d_cgraph">
<area shape="rect" id="node2" href="ci2c_8c.html#a99283d800332d700deed19f5a37e61d8" title="Enable I2c module on arduino board (including pull&#45;ups, enabling of ACK, and setting clock frequency)..." alt="" coords="129,19,196,45"/>
<area shape="rect" id="node5" href="ci2c_8c.html#af93c2e35e06edcea492607b628d5ae1f" title="Init an I2C slave structure for cMI2C communication. " alt="" coords="110,95,215,121"/>
<area shape="rect" id="node3" href="ci2c_8c.html#a7c5b1857ae28ade8959a8a06f500ecde" title="Change I2C frequency. " alt="" coords="290,5,401,32"/>
<area shape="rect" id="node4" href="ci2c_8c.html#a2c25bc5fdf909b7d45d722970eb04d82" title="I2C bus reset (Release SCL and SDA lines and re&#45;enable module) " alt="" coords="475,5,554,32"/>
<area shape="rect" id="node6" href="ci2c_8c.html#ad0eed3132d3284d6f921d13488721226" title="Change I2C slave address. " alt="" coords="276,56,415,83"/>
<area shape="rect" id="node7" href="ci2c_8c.html#a47d121773459b24568e5df4f81fbf905" title="Change I2C registers map size (for access) " alt="" coords="264,107,427,133"/>
<area shape="rect" id="node8" href="ci2c_8c.html#a8d88530833d3685d52ea5486b1316427" title="Redirect slave I2C read/write function (if needed for advanced use) " alt="" coords="266,157,425,184"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a2fc323c2ac98fd84324b5f6c4196e876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fc323c2ac98fd84324b5f6c4196e876">&#9670;&nbsp;</a></span>blank</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t blank = 0xEE</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a59b901a6dacd5ea8c9ceaa93cd8a1b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59b901a6dacd5ea8c9ceaa93cd8a1b2b">&#9670;&nbsp;</a></span>FRAM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ci2c_8h.html#a916f30ff94044ecc9f8a177446da485a">I2C_SLAVE</a> FRAM</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink