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

214 lines
11 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/tc74.h 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">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="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">tc74.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;Wire.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for tc74.h:</div>
<div class="dyncontent">
<div class="center"><img src="tc74_8h__incl.png" border="0" usemap="#libraries_2tc74_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="tc74_8h__dep__incl.png" border="0" usemap="#libraries_2tc74_8hdep" alt=""/></div>
<map name="libraries_2tc74_8hdep" id="libraries_2tc74_8hdep">
<area shape="rect" id="node2" href="dc__motor__controller_8ino.html" title="dc_motor_controller\l/dc_motor_controller.ino" alt="" coords="5,80,184,121"/>
</map>
</div>
</div>
<p><a href="tc74_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtc74.html">tc74</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that functions for interacting with a TC74 Temperature sensor. <a href="classtc74.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae96d6b2a5131b4f3943d894c30fb42fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tc74_8h.html#ae96d6b2a5131b4f3943d894c30fb42fb">TC74_TEMPERATURE_REGISTER</a>&#160;&#160;&#160;0x00</td></tr>
<tr class="separator:ae96d6b2a5131b4f3943d894c30fb42fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ba5fdf8b49e61a58c97feb5bc35f9e3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tc74_8h.html#a6ba5fdf8b49e61a58c97feb5bc35f9e3">TC74_CONFIGURATION_REGISTER</a>&#160;&#160;&#160;0x01</td></tr>
<tr class="separator:a6ba5fdf8b49e61a58c97feb5bc35f9e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12e2bb5245f9bf9487853ad58c0b1011"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tc74_8h.html#a12e2bb5245f9bf9487853ad58c0b1011">TC74_STANDBY_COMMAND</a>&#160;&#160;&#160;0x80</td></tr>
<tr class="separator:a12e2bb5245f9bf9487853ad58c0b1011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad08dad0d1a91b91db4885beeeb645771"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tc74_8h.html#ad08dad0d1a91b91db4885beeeb645771">TC74_AWAKE_COMMAND</a>&#160;&#160;&#160;0x00</td></tr>
<tr class="separator:ad08dad0d1a91b91db4885beeeb645771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab77abc7de3ca9f3753905259d339069b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tc74_8h.html#ab77abc7de3ca9f3753905259d339069b">TC74_DATA_READY_FLAG</a>&#160;&#160;&#160;0x40</td></tr>
<tr class="separator:ab77abc7de3ca9f3753905259d339069b"><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>It is a driver for a TC74 Temperature sensor.</p>
<p>Licensed under the GPLv3 </p>
<p class="definition">Definition in file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad08dad0d1a91b91db4885beeeb645771"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad08dad0d1a91b91db4885beeeb645771">&#9670;&nbsp;</a></span>TC74_AWAKE_COMMAND</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TC74_AWAKE_COMMAND&#160;&#160;&#160;0x00</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00018">18</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">tc74::get_status()</a>, and <a class="el" href="tc74_8h_source.html#l00094">tc74::wake_up()</a>.</p>
</div>
</div>
<a id="a6ba5fdf8b49e61a58c97feb5bc35f9e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ba5fdf8b49e61a58c97feb5bc35f9e3">&#9670;&nbsp;</a></span>TC74_CONFIGURATION_REGISTER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TC74_CONFIGURATION_REGISTER&#160;&#160;&#160;0x01</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00016">16</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">tc74::get_status()</a>, <a class="el" href="tc74_8h_source.html#l00110">tc74::sleep()</a>, and <a class="el" href="tc74_8h_source.html#l00094">tc74::wake_up()</a>.</p>
</div>
</div>
<a id="ab77abc7de3ca9f3753905259d339069b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab77abc7de3ca9f3753905259d339069b">&#9670;&nbsp;</a></span>TC74_DATA_READY_FLAG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TC74_DATA_READY_FLAG&#160;&#160;&#160;0x40</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00019">19</a> of file <a class="el" href="tc74_8h_source.html">tc74.h</a>.</p>
</div>
</div>
<a id="a12e2bb5245f9bf9487853ad58c0b1011"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12e2bb5245f9bf9487853ad58c0b1011">&#9670;&nbsp;</a></span>TC74_STANDBY_COMMAND</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TC74_STANDBY_COMMAND&#160;&#160;&#160;0x80</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00017">17</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#l00110">tc74::sleep()</a>.</p>
</div>
</div>
<a id="ae96d6b2a5131b4f3943d894c30fb42fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae96d6b2a5131b4f3943d894c30fb42fb">&#9670;&nbsp;</a></span>TC74_TEMPERATURE_REGISTER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TC74_TEMPERATURE_REGISTER&#160;&#160;&#160;0x00</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tc74_8h_source.html#l00015">15</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#l00059">tc74::get_temp()</a>.</p>
</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.14
</small></address>
</body>
</html>