satnogs-rotator-firmware/doxygen_files/html/i2c__mux_8h_source.html

89 lines
13 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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>satnogs-rotator-firmware: libraries/i2c_mux.h Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">i2c_mux.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="i2c__mux_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#ifndef I2C_MUX_H_</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define I2C_MUX_H_</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;Wire.h&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="i2c__mux_8h.html#a8b7500a141450a9df212017430c0df9e"> 15</a></span>&#160;<span class="preprocessor">#define I2C_FREQ 100000</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classi2c__mux.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classi2c__mux.html">i2c_mux</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;</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classi2c__mux.html#aacb992d29412ed15eb0b8b1983dcf976"> 31</a></span>&#160; <a class="code" href="classi2c__mux.html#aacb992d29412ed15eb0b8b1983dcf976">i2c_mux</a>(uint8_t <span class="keywordtype">id</span>, uint8_t ch0, uint8_t ch1) {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6">_id</a> = id;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classi2c__mux.html#acca9a43816973b7471017cbc1d6fd70a">_ch0</a> = ch0;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classi2c__mux.html#a3aa95a560e46d8a078ca2fd2eeb4dab4">_ch1</a> = ch1;</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;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classi2c__mux.html#a297c753f7c9fd03b7a6be09a7d3bd87a"> 42</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classi2c__mux.html#a297c753f7c9fd03b7a6be09a7d3bd87a">init</a>() {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; Wire.begin();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; Wire.setClock(<a class="code" href="i2c__mux_8h.html#a8b7500a141450a9df212017430c0df9e">I2C_FREQ</a>);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classi2c__mux.html#af4a7327c09d2f0ea8ee5a5797871e876"> 54</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classi2c__mux.html#af4a7327c09d2f0ea8ee5a5797871e876">set_channel</a>(uint8_t ch) {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">if</span> (ch == <a class="code" href="classi2c__mux.html#acca9a43816973b7471017cbc1d6fd70a">_ch0</a>) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; Wire.beginTransmission(<a class="code" href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6">_id</a>);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; Wire.write(<a class="code" href="classi2c__mux.html#acca9a43816973b7471017cbc1d6fd70a">_ch0</a>);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; Wire.endTransmission();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ch == <a class="code" href="classi2c__mux.html#a3aa95a560e46d8a078ca2fd2eeb4dab4">_ch1</a>) {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; Wire.beginTransmission(<a class="code" href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6">_id</a>);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; Wire.write(<a class="code" href="classi2c__mux.html#a3aa95a560e46d8a078ca2fd2eeb4dab4">_ch1</a>);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; Wire.endTransmission();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6"> 67</a></span>&#160; uint8_t <a class="code" href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6">_id</a>, <a class="code" href="classi2c__mux.html#acca9a43816973b7471017cbc1d6fd70a">_ch0</a>, <a class="code" href="classi2c__mux.html#a3aa95a560e46d8a078ca2fd2eeb4dab4">_ch1</a>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* I2C_MUX_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="i2c__mux_8h_html_a8b7500a141450a9df212017430c0df9e"><div class="ttname"><a href="i2c__mux_8h.html#a8b7500a141450a9df212017430c0df9e">I2C_FREQ</a></div><div class="ttdeci">#define I2C_FREQ</div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00015">i2c_mux.h:15</a></div></div>
<div class="ttc" id="classi2c__mux_html_ad56c7d14d6638caa0bccce4d609256c6"><div class="ttname"><a href="classi2c__mux.html#ad56c7d14d6638caa0bccce4d609256c6">i2c_mux::_id</a></div><div class="ttdeci">uint8_t _id</div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00067">i2c_mux.h:67</a></div></div>
<div class="ttc" id="classi2c__mux_html_aacb992d29412ed15eb0b8b1983dcf976"><div class="ttname"><a href="classi2c__mux.html#aacb992d29412ed15eb0b8b1983dcf976">i2c_mux::i2c_mux</a></div><div class="ttdeci">i2c_mux(uint8_t id, uint8_t ch0, uint8_t ch1)</div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00031">i2c_mux.h:31</a></div></div>
<div class="ttc" id="classi2c__mux_html_af4a7327c09d2f0ea8ee5a5797871e876"><div class="ttname"><a href="classi2c__mux.html#af4a7327c09d2f0ea8ee5a5797871e876">i2c_mux::set_channel</a></div><div class="ttdeci">void set_channel(uint8_t ch)</div><div class="ttdoc">Change the channel. </div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00054">i2c_mux.h:54</a></div></div>
<div class="ttc" id="classi2c__mux_html"><div class="ttname"><a href="classi2c__mux.html">i2c_mux</a></div><div class="ttdoc">Class that functions for interacting with I2C 1-of-2 multiplexer. </div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00028">i2c_mux.h:28</a></div></div>
<div class="ttc" id="classi2c__mux_html_a3aa95a560e46d8a078ca2fd2eeb4dab4"><div class="ttname"><a href="classi2c__mux.html#a3aa95a560e46d8a078ca2fd2eeb4dab4">i2c_mux::_ch1</a></div><div class="ttdeci">uint8_t _ch1</div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00067">i2c_mux.h:67</a></div></div>
<div class="ttc" id="classi2c__mux_html_acca9a43816973b7471017cbc1d6fd70a"><div class="ttname"><a href="classi2c__mux.html#acca9a43816973b7471017cbc1d6fd70a">i2c_mux::_ch0</a></div><div class="ttdeci">uint8_t _ch0</div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00067">i2c_mux.h:67</a></div></div>
<div class="ttc" id="classi2c__mux_html_a297c753f7c9fd03b7a6be09a7d3bd87a"><div class="ttname"><a href="classi2c__mux.html#a297c753f7c9fd03b7a6be09a7d3bd87a">i2c_mux::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">Initialize the I2C bus. </div><div class="ttdef"><b>Definition:</b> <a href="i2c__mux_8h_source.html#l00042">i2c_mux.h:42</a></div></div>
</div><!-- fragment --></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>