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

367 lines
18 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: tc74 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="classtc74-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tc74 Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that functions for interacting with a TC74 Temperature sensor.
<a href="classtc74.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="tc74_8h_source.html">tc74.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:a0adb7370c49b3f39787270357a07d12c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a0adb7370c49b3f39787270357a07d12c">tc74</a> (uint8_t id)</td></tr>
<tr class="separator:a0adb7370c49b3f39787270357a07d12c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e9df64f45929efc9b56b4668269ffbe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a9e9df64f45929efc9b56b4668269ffbe">init</a> ()</td></tr>
<tr class="memdesc:a9e9df64f45929efc9b56b4668269ffbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the I2C bus. <a href="#a9e9df64f45929efc9b56b4668269ffbe">More...</a><br /></td></tr>
<tr class="separator:a9e9df64f45929efc9b56b4668269ffbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e923d126027ab1e7102b4a203698eb3"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a5e923d126027ab1e7102b4a203698eb3">get_temp</a> ()</td></tr>
<tr class="memdesc:a5e923d126027ab1e7102b4a203698eb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the int8_t in temperature measurement register. <a href="#a5e923d126027ab1e7102b4a203698eb3">More...</a><br /></td></tr>
<tr class="separator:a5e923d126027ab1e7102b4a203698eb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91d194f87d6153a0556ab5fd857e66ee"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a91d194f87d6153a0556ab5fd857e66ee">get_status</a> ()</td></tr>
<tr class="memdesc:a91d194f87d6153a0556ab5fd857e66ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the int8_t in status register. <a href="#a91d194f87d6153a0556ab5fd857e66ee">More...</a><br /></td></tr>
<tr class="separator:a91d194f87d6153a0556ab5fd857e66ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e10af3dbd52592f902f81885dc166d2"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a9e10af3dbd52592f902f81885dc166d2">wake_up</a> ()</td></tr>
<tr class="memdesc:a9e10af3dbd52592f902f81885dc166d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wake up request to the sensor on the specified address. <a href="#a9e10af3dbd52592f902f81885dc166d2">More...</a><br /></td></tr>
<tr class="separator:a9e10af3dbd52592f902f81885dc166d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5304cfec3e2fd0955db133ae0892c734"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a5304cfec3e2fd0955db133ae0892c734">sleep</a> ()</td></tr>
<tr class="memdesc:a5304cfec3e2fd0955db133ae0892c734"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep device request to the sensor on the specified address. <a href="#a5304cfec3e2fd0955db133ae0892c734">More...</a><br /></td></tr>
<tr class="separator:a5304cfec3e2fd0955db133ae0892c734"><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:a9aef242072cf2021850126f6931cd577"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html#a9aef242072cf2021850126f6931cd577">_id</a></td></tr>
<tr class="separator:a9aef242072cf2021850126f6931cd577"><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 a TC74 Temperature sensor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Set the ID of temperature sensor, I2C address TC74_A0 0b10010000 TC74_A1 0b10010010 TC74_A2 0b10010100 TC74_A3 0b10010110 TC74_A4 0b10011000 TC74_A5 0b10011010 TC74_A6 0b10011100 TC74_A7 0b10011110 </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00036">36</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0adb7370c49b3f39787270357a07d12c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0adb7370c49b3f39787270357a07d12c">&#9670;&nbsp;</a></span>tc74()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">tc74::tc74 </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id</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 class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00039">39</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">References <a class="el" href="tc74_8h_source.html#l00121">_id</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a91d194f87d6153a0556ab5fd857e66ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91d194f87d6153a0556ab5fd857e66ee">&#9670;&nbsp;</a></span>get_status()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int8_t tc74::get_status </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>Reads the int8_t in status register. </p>
<dl class="section return"><dt>Returns</dt><dd>The status register int8_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00075">75</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">References <a class="el" href="tc74_8h_source.html#l00121">_id</a>, <a class="el" href="tc74_8h_source.html#l00018">TC74_AWAKE_COMMAND</a>, and <a class="el" href="tc74_8h_source.html#l00016">TC74_CONFIGURATION_REGISTER</a>.</p>
<p class="reference">Referenced by <a class="el" href="tc74_8h_source.html#l00110">sleep()</a>, and <a class="el" href="tc74_8h_source.html#l00094">wake_up()</a>.</p>
</div>
</div>
<a id="a5e923d126027ab1e7102b4a203698eb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e923d126027ab1e7102b4a203698eb3">&#9670;&nbsp;</a></span>get_temp()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int8_t tc74::get_temp </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>Reads the int8_t in temperature measurement register. </p>
<dl class="section return"><dt>Returns</dt><dd>The temperature int8_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00059">59</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">References <a class="el" href="tc74_8h_source.html#l00121">_id</a>, and <a class="el" href="tc74_8h_source.html#l00015">TC74_TEMPERATURE_REGISTER</a>.</p>
<p class="reference">Referenced by <a class="el" href="dc__motor__controller_8ino_source.html#l00105">loop()</a>.</p>
</div>
</div>
<a id="a9e9df64f45929efc9b56b4668269ffbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e9df64f45929efc9b56b4668269ffbe">&#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 tc74::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="tc74_8h_source.html#l00048">48</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">References <a class="el" href="as5601_8h_source.html#l00017">I2C_FREQ</a>.</p>
</div>
</div>
<a id="a5304cfec3e2fd0955db133ae0892c734"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5304cfec3e2fd0955db133ae0892c734">&#9670;&nbsp;</a></span>sleep()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int8_t tc74::sleep </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>Sleep device request to the sensor on the specified address. </p>
<dl class="section return"><dt>Returns</dt><dd>The status register int8_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00110">110</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">References <a class="el" href="tc74_8h_source.html#l00121">_id</a>, <a class="el" href="tc74_8h_source.html#l00075">get_status()</a>, <a class="el" href="tc74_8h_source.html#l00016">TC74_CONFIGURATION_REGISTER</a>, and <a class="el" href="tc74_8h_source.html#l00017">TC74_STANDBY_COMMAND</a>.</p>
<p class="reference">Referenced by <a class="el" href="dc__motor__controller_8ino_source.html#l00105">loop()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classtc74_a5304cfec3e2fd0955db133ae0892c734_cgraph.png" border="0" usemap="#classtc74_a5304cfec3e2fd0955db133ae0892c734_cgraph" alt=""/></div>
<map name="classtc74_a5304cfec3e2fd0955db133ae0892c734_cgraph" id="classtc74_a5304cfec3e2fd0955db133ae0892c734_cgraph">
<area shape="rect" id="node2" href="classtc74.html#a91d194f87d6153a0556ab5fd857e66ee" title="Reads the int8_t in status register. " alt="" coords="147,5,273,32"/>
</map>
</div>
</div>
</div>
<a id="a9e10af3dbd52592f902f81885dc166d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e10af3dbd52592f902f81885dc166d2">&#9670;&nbsp;</a></span>wake_up()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int8_t tc74::wake_up </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>Wake up request to the sensor on the specified address. </p>
<dl class="section return"><dt>Returns</dt><dd>The status register int8_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00094">94</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">References <a class="el" href="tc74_8h_source.html#l00121">_id</a>, <a class="el" href="tc74_8h_source.html#l00075">get_status()</a>, <a class="el" href="tc74_8h_source.html#l00018">TC74_AWAKE_COMMAND</a>, and <a class="el" href="tc74_8h_source.html#l00016">TC74_CONFIGURATION_REGISTER</a>.</p>
<p class="reference">Referenced by <a class="el" href="dc__motor__controller_8ino_source.html#l00105">loop()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classtc74_a9e10af3dbd52592f902f81885dc166d2_cgraph.png" border="0" usemap="#classtc74_a9e10af3dbd52592f902f81885dc166d2_cgraph" alt=""/></div>
<map name="classtc74_a9e10af3dbd52592f902f81885dc166d2_cgraph" id="classtc74_a9e10af3dbd52592f902f81885dc166d2_cgraph">
<area shape="rect" id="node2" href="classtc74.html#a91d194f87d6153a0556ab5fd857e66ee" title="Reads the int8_t in status register. " alt="" coords="169,5,296,32"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9aef242072cf2021850126f6931cd577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9aef242072cf2021850126f6931cd577">&#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">int tc74::_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="tc74_8h_source.html#l00121">121</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="tc74_8h_source.html#l00075">get_status()</a>, <a class="el" href="tc74_8h_source.html#l00059">get_temp()</a>, <a class="el" href="tc74_8h_source.html#l00110">sleep()</a>, <a class="el" href="tc74_8h_source.html#l00039">tc74()</a>, and <a class="el" href="tc74_8h_source.html#l00094">wake_up()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libraries/<a class="el" href="tc74_8h_source.html">tc74.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