Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
201
group___a_d_c___group3.html
Normal file
201
group___a_d_c___group3.html
Normal file
@@ -0,0 +1,201 @@
|
||||
<!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.9.1"/>
|
||||
<title>discoverpixy: Temperature Sensor, Vrefint (Voltage Reference internal)</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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 style="padding-left: 0.5em;">
|
||||
<div id="projectname">discoverpixy
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.9.1 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Temperature Sensor, Vrefint (Voltage Reference internal)<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> » <a class="el" href="group___a_d_c.html">ADC</a> » <a class="el" href="group___a_d_c___private___functions.html">ADC_Private_Functions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Temperature Sensor, Vrefint and VBAT management functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for Temperature Sensor, Vrefint (Voltage Reference internal):</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___a_d_c___group3.png" border="0" alt="" usemap="#group______a__d__c______group3"/>
|
||||
<map name="group______a__d__c______group3" id="group______a__d__c______group3">
|
||||
<area shape="rect" id="node1" href="group___a_d_c___private___functions.html" title="ADC_Private_Functions" alt="" coords="5,20,164,47"/></map>
|
||||
</td></tr></table></center>
|
||||
</div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga848682e2d7d3de9f8cf03ffa4c11f0b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group3.html#ga848682e2d7d3de9f8cf03ffa4c11f0b5">ADC_TempSensorVrefintCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga848682e2d7d3de9f8cf03ffa4c11f0b5"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the temperature sensor and Vrefint channels. <a href="#ga848682e2d7d3de9f8cf03ffa4c11f0b5">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga848682e2d7d3de9f8cf03ffa4c11f0b5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga17fc58510ddc80024e65d9738ad6e98c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group3.html#ga17fc58510ddc80024e65d9738ad6e98c">ADC_VBATCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga17fc58510ddc80024e65d9738ad6e98c"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the VBAT (Voltage Battery) channel. <a href="#ga17fc58510ddc80024e65d9738ad6e98c">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga17fc58510ddc80024e65d9738ad6e98c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Temperature Sensor, Vrefint and VBAT management functions. </p>
|
||||
<p>and VBAT (Voltage BATtery) management functions </p><pre class="fragment"> ===============================================================================
|
||||
##### Temperature Sensor, Vrefint and VBAT management functions #####
|
||||
===============================================================================
|
||||
[..] This section provides functions allowing to enable/ disable the internal
|
||||
connections between the ADC and the Temperature Sensor, the Vrefint and
|
||||
the Vbat sources.
|
||||
|
||||
[..] A typical configuration to get the Temperature sensor and Vrefint channels
|
||||
voltages is done following these steps :
|
||||
(#) Enable the internal connection of Temperature sensor and Vrefint sources
|
||||
with the ADC channels using ADC_TempSensorVrefintCmd() function.
|
||||
(#) Select the ADC_Channel_TempSensor and/or ADC_Channel_Vrefint using
|
||||
ADC_RegularChannelConfig() or ADC_InjectedChannelConfig() functions
|
||||
(#) Get the voltage values, using ADC_GetConversionValue() or
|
||||
ADC_GetInjectedConversionValue().
|
||||
|
||||
[..] A typical configuration to get the VBAT channel voltage is done following
|
||||
these steps :
|
||||
(#) Enable the internal connection of VBAT source with the ADC channel using
|
||||
ADC_VBATCmd() function.
|
||||
(#) Select the ADC_Channel_Vbat using ADC_RegularChannelConfig() or
|
||||
ADC_InjectedChannelConfig() functions
|
||||
(#) Get the voltage value, using ADC_GetConversionValue() or
|
||||
ADC_GetInjectedConversionValue().</pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga848682e2d7d3de9f8cf03ffa4c11f0b5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ADC_TempSensorVrefintCmd </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">FunctionalState </td>
|
||||
<td class="paramname"><em>NewState</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Enables or disables the temperature sensor and Vrefint channels. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the temperature sensor and Vrefint channels. This parameter can be: ENABLE or DISABLE. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="retval"><dt>Return values</dt><dd>
|
||||
<table class="retval">
|
||||
<tr><td class="paramname">None</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga17fc58510ddc80024e65d9738ad6e98c"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ADC_VBATCmd </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">FunctionalState </td>
|
||||
<td class="paramname"><em>NewState</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Enables or disables the VBAT (Voltage Battery) channel. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>the Battery voltage measured is equal to VBAT/2 on STM32F40xx and STM32F41xx devices and equal to VBAT/4 on STM32F42xx and STM32F43xx devices</dd></dl>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the VBAT channel. This parameter can be: ENABLE or DISABLE. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="retval"><dt>Return values</dt><dd>
|
||||
<table class="retval">
|
||||
<tr><td class="paramname">None</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun May 10 2015 15:15:19 for discoverpixy by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.9.1
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user