spacecruft
/
satnogs-rotator-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Activity
satnogs-rotator-firmware/doxygen_files/html/classi2c__mux.html

322 lines
14 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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>satnogs-rotator-firmware: i2c_mux 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/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">satnogs-rotator-firmware
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classi2c__mux-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">i2c_mux Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that functions for interacting with I2C 1-of-2 multiplexer.
<a href="classi2c__mux.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>&gt;</code></p>
<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:aacb992d29412ed15eb0b8b1983dcf976"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__mux.html#aacb992d29412ed15eb0b8b1983dcf976">i2c_mux</a> (uint8_t id, uint8_t ch0, uint8_t ch1)</td></tr>
<tr class="separator:aacb992d29412ed15eb0b8b1983dcf976"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a297c753f7c9fd03b7a6be09a7d3bd87a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__mux.html#a297c753f7c9fd03b7a6be09a7d3bd87a">init</a> ()</td></tr>
<tr class="memdesc:a297c753f7c9fd03b7a6be09a7d3bd87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the I2C bus. <a href="#a297c753f7c9fd03b7a6be09a7d3bd87a">More...</a><br /></td></tr>
<tr class="separator:a297c753f7c9fd03b7a6be09a7d3bd87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4a7327c09d2f0ea8ee5a5797871e876"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__mux.html#af4a7327c09d2f0ea8ee5a5797871e876">set_channel</a> (uint8_t ch)</td></tr>
<tr class="memdesc:af4a7327c09d2f0ea8ee5a5797871e876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the channel. <a href="#af4a7327c09d2f0ea8ee5a5797871e876">More...</a><br /></td></tr>
<tr class="separator:af4a7327c09d2f0ea8ee5a5797871e876"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ad56c7d14d6638caa0bccce4d609256c6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6">_id</a></td></tr>
<tr class="separator:ad56c7d14d6638caa0bccce4d609256c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acca9a43816973b7471017cbc1d6fd70a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__mux.html#acca9a43816973b7471017cbc1d6fd70a">_ch0</a></td></tr>
<tr class="separator:acca9a43816973b7471017cbc1d6fd70a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aa95a560e46d8a078ca2fd2eeb4dab4"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__mux.html#a3aa95a560e46d8a078ca2fd2eeb4dab4">_ch1</a></td></tr>
<tr class="separator:a3aa95a560e46d8a078ca2fd2eeb4dab4"><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>Class that functions for interacting with I2C 1-of-2 multiplexer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>I2C ID in HEX </td></tr>
<tr><td class="paramname">ch0</td><td>Channel 0 in HEX </td></tr>
<tr><td class="paramname">ch1</td><td>Channel 1 in HEX </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00028">28</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aacb992d29412ed15eb0b8b1983dcf976"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacb992d29412ed15eb0b8b1983dcf976">&#9670;&nbsp;</a></span>i2c_mux()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">i2c_mux::i2c_mux </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ch0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ch1</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00031">31</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
<p class="reference">References <a class="el" href="i2c__mux_8h_source.html#l00067">_ch0</a>, <a class="el" href="i2c__mux_8h_source.html#l00067">_ch1</a>, and <a class="el" href="i2c__mux_8h_source.html#l00067">_id</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a297c753f7c9fd03b7a6be09a7d3bd87a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a297c753f7c9fd03b7a6be09a7d3bd87a">&#9670;&nbsp;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void i2c_mux::init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the I2C bus. </p>
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00042">42</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
<p class="reference">References <a class="el" href="i2c__mux_8h_source.html#l00015">I2C_FREQ</a>.</p>
<p class="reference">Referenced by <a class="el" href="dc__motor__controller_8ino_source.html#l00071">setup()</a>.</p>
</div>
</div>
<a id="af4a7327c09d2f0ea8ee5a5797871e876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4a7327c09d2f0ea8ee5a5797871e876">&#9670;&nbsp;</a></span>set_channel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void i2c_mux::set_channel </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ch</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ch</td><td>Set the channel that is connected with Master, CH0 or CH1 </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00054">54</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
<p class="reference">References <a class="el" href="i2c__mux_8h_source.html#l00067">_ch0</a>, <a class="el" href="i2c__mux_8h_source.html#l00067">_ch1</a>, and <a class="el" href="i2c__mux_8h_source.html#l00067">_id</a>.</p>
<p class="reference">Referenced by <a class="el" href="dc__motor__controller_8ino_source.html#l00214">homing()</a>, and <a class="el" href="dc__motor__controller_8ino_source.html#l00105">loop()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acca9a43816973b7471017cbc1d6fd70a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acca9a43816973b7471017cbc1d6fd70a">&#9670;&nbsp;</a></span>_ch0</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t i2c_mux::_ch0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00067">67</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="i2c__mux_8h_source.html#l00031">i2c_mux()</a>, and <a class="el" href="i2c__mux_8h_source.html#l00054">set_channel()</a>.</p>
</div>
</div>
<a id="a3aa95a560e46d8a078ca2fd2eeb4dab4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aa95a560e46d8a078ca2fd2eeb4dab4">&#9670;&nbsp;</a></span>_ch1</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t i2c_mux::_ch1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00067">67</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="i2c__mux_8h_source.html#l00031">i2c_mux()</a>, and <a class="el" href="i2c__mux_8h_source.html#l00054">set_channel()</a>.</p>
</div>
</div>
<a id="ad56c7d14d6638caa0bccce4d609256c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad56c7d14d6638caa0bccce4d609256c6">&#9670;&nbsp;</a></span>_id</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t i2c_mux::_id</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="i2c__mux_8h_source.html#l00067">67</a> of file <a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="i2c__mux_8h_source.html#l00031">i2c_mux()</a>, and <a class="el" href="i2c__mux_8h_source.html#l00054">set_channel()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libraries/<a class="el" href="i2c__mux_8h_source.html">i2c_mux.h</a></li>
</ul>
</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.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink