310 lines
16 KiB
HTML
310 lines
16 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/as5601.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&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&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> |
|
|
<a href="#define-members">Macros</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">as5601.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <Wire.h></code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for as5601.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="as5601_8h__incl.png" border="0" usemap="#libraries_2as5601_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="as5601_8h__dep__incl.png" border="0" usemap="#libraries_2as5601_8hdep" alt=""/></div>
|
|
<map name="libraries_2as5601_8hdep" id="libraries_2as5601_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="as5601_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAS5601.html">AS5601</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class that functions for interacting with <a class="el" href="classAS5601.html" title="Class that functions for interacting with AS5601 magnetic rotary position sensor. ...">AS5601</a> magnetic rotary position sensor. <a href="classAS5601.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a8b7500a141450a9df212017430c0df9e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a8b7500a141450a9df212017430c0df9e">I2C_FREQ</a>   100000</td></tr>
|
|
<tr class="separator:a8b7500a141450a9df212017430c0df9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25c5389b80876b6074ce88c6572b2296"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a25c5389b80876b6074ce88c6572b2296">AS5601_ID</a>   0x36</td></tr>
|
|
<tr class="separator:a25c5389b80876b6074ce88c6572b2296"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f32fbf0619653f8582cfbb9b5022868"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a0f32fbf0619653f8582cfbb9b5022868">RAW_ANG_HIGH</a>   0x0C</td></tr>
|
|
<tr class="separator:a0f32fbf0619653f8582cfbb9b5022868"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60e1d311be398853144f59e1d2a37be1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a60e1d311be398853144f59e1d2a37be1">RAW_ANG_LOW</a>   0x0D</td></tr>
|
|
<tr class="separator:a60e1d311be398853144f59e1d2a37be1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f7e79cfe81dc06414550fa52418941e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a1f7e79cfe81dc06414550fa52418941e">STATUS_REG</a>   0x0B</td></tr>
|
|
<tr class="separator:a1f7e79cfe81dc06414550fa52418941e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b14c0a97e1a526bf898cd24de183afb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a6b14c0a97e1a526bf898cd24de183afb">AGC</a>   0x1A</td></tr>
|
|
<tr class="separator:a6b14c0a97e1a526bf898cd24de183afb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a44cb76675b777aed3142556943702c80"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a44cb76675b777aed3142556943702c80">MAGNITUDE_HIGH</a>   0x1B</td></tr>
|
|
<tr class="separator:a44cb76675b777aed3142556943702c80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27977fa09cf94bdf6e6f0f3d78d29c2e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a27977fa09cf94bdf6e6f0f3d78d29c2e">MAGNITUDE_LOW</a>   0x1C</td></tr>
|
|
<tr class="separator:a27977fa09cf94bdf6e6f0f3d78d29c2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50a238669bcc55ea8d1e6cdc48cf0193"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a50a238669bcc55ea8d1e6cdc48cf0193">CONF_HIGH</a>   0x07</td></tr>
|
|
<tr class="separator:a50a238669bcc55ea8d1e6cdc48cf0193"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a7b8dcb28f171791bc1d12c6fd88a7f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="as5601_8h.html#a5a7b8dcb28f171791bc1d12c6fd88a7f">CONF_LOW</a>   0x08</td></tr>
|
|
<tr class="separator:a5a7b8dcb28f171791bc1d12c6fd88a7f"><td class="memSeparator" colspan="2"> </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 class="el" href="classAS5601.html" title="Class that functions for interacting with AS5601 magnetic rotary position sensor. ...">AS5601</a> a magnetic rotary position sensor. It uses I2C protocol. The resolution of encoder is 12-bit.</p>
|
|
<p>Licensed under the GPLv3 </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a6b14c0a97e1a526bf898cd24de183afb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b14c0a97e1a526bf898cd24de183afb">◆ </a></span>AGC</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define AGC   0x1A</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00023">23</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00096">AS5601::get_agc()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25c5389b80876b6074ce88c6572b2296"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25c5389b80876b6074ce88c6572b2296">◆ </a></span>AS5601_ID</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define AS5601_ID   0x36</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00019">19</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00096">AS5601::get_agc()</a>, <a class="el" href="as5601_8h_source.html#l00116">AS5601::get_conf()</a>, <a class="el" href="as5601_8h_source.html#l00106">AS5601::get_magnitude()</a>, and <a class="el" href="as5601_8h_source.html#l00059">AS5601::get_pos()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50a238669bcc55ea8d1e6cdc48cf0193"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50a238669bcc55ea8d1e6cdc48cf0193">◆ </a></span>CONF_HIGH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONF_HIGH   0x07</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00026">26</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00116">AS5601::get_conf()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a7b8dcb28f171791bc1d12c6fd88a7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a7b8dcb28f171791bc1d12c6fd88a7f">◆ </a></span>CONF_LOW</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONF_LOW   0x08</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00027">27</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b7500a141450a9df212017430c0df9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b7500a141450a9df212017430c0df9e">◆ </a></span>I2C_FREQ</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define I2C_FREQ   100000</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00017">17</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00043">AS5601::Begin()</a>, and <a class="el" href="tc74_8h_source.html#l00048">tc74::init()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a44cb76675b777aed3142556943702c80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a44cb76675b777aed3142556943702c80">◆ </a></span>MAGNITUDE_HIGH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MAGNITUDE_HIGH   0x1B</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00024">24</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00106">AS5601::get_magnitude()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27977fa09cf94bdf6e6f0f3d78d29c2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27977fa09cf94bdf6e6f0f3d78d29c2e">◆ </a></span>MAGNITUDE_LOW</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MAGNITUDE_LOW   0x1C</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00025">25</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f32fbf0619653f8582cfbb9b5022868"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f32fbf0619653f8582cfbb9b5022868">◆ </a></span>RAW_ANG_HIGH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define RAW_ANG_HIGH   0x0C</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00020">20</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00059">AS5601::get_pos()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60e1d311be398853144f59e1d2a37be1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60e1d311be398853144f59e1d2a37be1">◆ </a></span>RAW_ANG_LOW</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define RAW_ANG_LOW   0x0D</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00021">21</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f7e79cfe81dc06414550fa52418941e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f7e79cfe81dc06414550fa52418941e">◆ </a></span>STATUS_REG</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define STATUS_REG   0x0B</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="as5601_8h_source.html#l00022">22</a> of file <a class="el" href="as5601_8h_source.html">as5601.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="as5601_8h_source.html#l00059">AS5601::get_pos()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|