396 lines
23 KiB
HTML
396 lines
23 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>Solar panel: mcc_generated_files/adc.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.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 id="projectrow">
|
||
|
|
<td id="projectalign">
|
||
|
|
<div id="projectname">Solar panel
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(document).ready(function(){initNavTree('adc_8h.html',''); initResizable(); });
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- 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">
|
||
|
|
<div id="MSearchResults">
|
||
|
|
<div class="SRPage">
|
||
|
|
<div id="SRIndex">
|
||
|
|
<div id="SRResults"></div>
|
||
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
||
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
||
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#nested-classes">Classes</a> |
|
||
|
|
<a href="#typedef-members">Typedefs</a> |
|
||
|
|
<a href="#enum-members">Enumerations</a> |
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">adc.h File Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><code>#include <xc.h></code><br />
|
||
|
|
<code>#include <stdint.h></code><br />
|
||
|
|
<code>#include <stdbool.h></code><br />
|
||
|
|
</div>
|
||
|
|
<p><a href="adc_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 id="nested-classes" name="nested-classes"></a>
|
||
|
|
Classes</h2></td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structadc__sync__double__result__t.html">adc_sync_double_result_t</a></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 id="typedef-members" name="typedef-members"></a>
|
||
|
|
Typedefs</h2></td></tr>
|
||
|
|
<tr class="memitem:ac5362ae65441a5027b4b9b1bf1b573aa"><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#ac5362ae65441a5027b4b9b1bf1b573aa">adc_result_t</a></td></tr>
|
||
|
|
<tr class="separator:ac5362ae65441a5027b4b9b1bf1b573aa"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
||
|
|
Enumerations</h2></td></tr>
|
||
|
|
<tr class="memitem:aafc4060027875f8fe46242b0656d7814"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814">adc_channel_t</a> { <a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814a20d31653fb88a46098aad34f773a827c">voltage</a> = 0x5
|
||
|
|
, <a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814a8225bfb34b5298eb7529ec580a4d178e">current</a> = 0x6
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:aafc4060027875f8fe46242b0656d7814"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ab0e0ea1662a8e789547210a2d33127e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize</a> (void)</td></tr>
|
||
|
|
<tr class="separator:ab0e0ea1662a8e789547210a2d33127e1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a25c0a0a9fe2bdba070f9945ca641b5e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a25c0a0a9fe2bdba070f9945ca641b5e0">ADC_SelectChannel</a> (<a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814">adc_channel_t</a> channel)</td></tr>
|
||
|
|
<tr class="separator:a25c0a0a9fe2bdba070f9945ca641b5e0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af96ee69b063edcebc656d0ca0450c12c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion</a> (void)</td></tr>
|
||
|
|
<tr class="separator:af96ee69b063edcebc656d0ca0450c12c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad5c10c1709aeacf08e783c3ea174463b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#ad5c10c1709aeacf08e783c3ea174463b">ADC_IsConversionDone</a> (void)</td></tr>
|
||
|
|
<tr class="separator:ad5c10c1709aeacf08e783c3ea174463b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9650956bd92194e1b9f0bfd5bb2d73dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="adc_8h.html#ac5362ae65441a5027b4b9b1bf1b573aa">adc_result_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult</a> (void)</td></tr>
|
||
|
|
<tr class="separator:a9650956bd92194e1b9f0bfd5bb2d73dd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a81501f9b96aa9bb8dbe63b49d0f8e909"><td class="memItemLeft" align="right" valign="top"><a class="el" href="adc_8h.html#ac5362ae65441a5027b4b9b1bf1b573aa">adc_result_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a81501f9b96aa9bb8dbe63b49d0f8e909">ADC_GetConversion</a> (<a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814">adc_channel_t</a> channel)</td></tr>
|
||
|
|
<tr class="separator:a81501f9b96aa9bb8dbe63b49d0f8e909"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a46bdd78f96c668432d4ff33115c9dcd9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a46bdd78f96c668432d4ff33115c9dcd9">ADC_TemperatureAcquisitionDelay</a> (void)</td></tr>
|
||
|
|
<tr class="separator:a46bdd78f96c668432d4ff33115c9dcd9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
||
|
|
<a id="ac5362ae65441a5027b4b9b1bf1b573aa" name="ac5362ae65441a5027b4b9b1bf1b573aa"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac5362ae65441a5027b4b9b1bf1b573aa">◆ </a></span>adc_result_t</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">typedef uint16_t <a class="el" href="adc_8h.html#ac5362ae65441a5027b4b9b1bf1b573aa">adc_result_t</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>ADC Generated Driver API Header File</p>
|
||
|
|
<p>@Company Microchip Technology Inc.</p>
|
||
|
|
<p>@File Name <a class="el" href="adc_8h.html">adc.h</a></p>
|
||
|
|
<p>@Summary This is the generated header file for the ADC driver using PIC10 / PIC12 / PIC16 / PIC18 MCUs</p>
|
||
|
|
<p>@Description This header file provides APIs for driver for ADC. Generation Information : Product Revision : PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.81.8 Device : PIC18F97J60 Driver Version : 2.02 The generated drivers are tested against the following: Compiler : XC8 2.36 and above MPLAB : MPLAB X 6.00 Section: Included Files Section: Data Types Definitions result size of an A/D conversion </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8h_source.html#l00072">72</a> of file <a class="el" href="adc_8h_source.html">adc.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
||
|
|
<a id="aafc4060027875f8fe46242b0656d7814" name="aafc4060027875f8fe46242b0656d7814"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafc4060027875f8fe46242b0656d7814">◆ </a></span>adc_channel_t</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">enum <a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814">adc_channel_t</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>ADC Channel Definition</p>
|
||
|
|
<p>@Summary Defines the channels available for conversion.</p>
|
||
|
|
<p>@Description This routine defines the channels that are available for the module to use.</p>
|
||
|
|
<p>Remarks: None </p>
|
||
|
|
<table class="fieldtable">
|
||
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aafc4060027875f8fe46242b0656d7814a20d31653fb88a46098aad34f773a827c" name="aafc4060027875f8fe46242b0656d7814a20d31653fb88a46098aad34f773a827c"></a>voltage </td><td class="fielddoc"></td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="aafc4060027875f8fe46242b0656d7814a8225bfb34b5298eb7529ec580a4d178e" name="aafc4060027875f8fe46242b0656d7814a8225bfb34b5298eb7529ec580a4d178e"></a>current </td><td class="fielddoc"></td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8h_source.html#l00095">95</a> of file <a class="el" href="adc_8h_source.html">adc.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="a81501f9b96aa9bb8dbe63b49d0f8e909" name="a81501f9b96aa9bb8dbe63b49d0f8e909"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81501f9b96aa9bb8dbe63b49d0f8e909">◆ </a></span>ADC_GetConversion()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="adc_8h.html#ac5362ae65441a5027b4b9b1bf1b573aa">adc_result_t</a> ADC_GetConversion </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814">adc_channel_t</a> </td>
|
||
|
|
<td class="paramname"><em>channel</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>@Summary Returns the ADC conversion value also allows selection of a channel for conversion.</p>
|
||
|
|
<p>@Description This routine is used to select desired channel for conversion and to get the analog to digital converted value.</p>
|
||
|
|
<p>@Preconditions <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a> function should have been called before calling this function.</p>
|
||
|
|
<p>@Returns Returns the converted value.</p>
|
||
|
|
<p>@Param Pass in required channel number. "For available channel refer to enum under adc.h file"</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>;</code></p>
|
||
|
|
<p><code> conversion = ADC_GetConversion(AN1_Channel); </code> </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00109">109</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9650956bd92194e1b9f0bfd5bb2d73dd" name="a9650956bd92194e1b9f0bfd5bb2d73dd"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9650956bd92194e1b9f0bfd5bb2d73dd">◆ </a></span>ADC_GetConversionResult()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="adc_8h.html#ac5362ae65441a5027b4b9b1bf1b573aa">adc_result_t</a> ADC_GetConversionResult </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>@Summary Returns the ADC conversion value.</p>
|
||
|
|
<p>@Description This routine is used to get the analog to digital converted value. This routine gets converted values from the channel specified.</p>
|
||
|
|
<p>@Preconditions This routine returns the conversion value only after the conversion is complete. Completion status can be checked using <a class="el" href="adc_8h.html#ad5c10c1709aeacf08e783c3ea174463b">ADC_IsConversionDone()</a> routine.</p>
|
||
|
|
<p>@Returns Returns the converted value.</p>
|
||
|
|
<p>@Param None</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>; <a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion()</a>;</code></p>
|
||
|
|
<p><code> while(ADC_IsConversionDone());</code></p>
|
||
|
|
<p><code> convertedValue = <a class="el" href="adc_8h.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult()</a>; </code> </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00103">103</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ab0e0ea1662a8e789547210a2d33127e1" name="ab0e0ea1662a8e789547210a2d33127e1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0e0ea1662a8e789547210a2d33127e1">◆ </a></span>ADC_Initialize()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ADC_Initialize </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Section: ADC Module APIs @Summary Initializes the ADC</p>
|
||
|
|
<p>@Description This routine initializes the Initializes the ADC. This routine must be called before any other ADC routine is called. This routine should only be called once during system initialization.</p>
|
||
|
|
<p>@Preconditions None</p>
|
||
|
|
<p>@Param None</p>
|
||
|
|
<p>@Returns None</p>
|
||
|
|
<p>@Comment</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8c.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>; convertedValue = <a class="el" href="adc_8c.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult()</a>; </code></p>
|
||
|
|
<p>Section: ADC Module APIs </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00061">61</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad5c10c1709aeacf08e783c3ea174463b" name="ad5c10c1709aeacf08e783c3ea174463b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5c10c1709aeacf08e783c3ea174463b">◆ </a></span>ADC_IsConversionDone()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool ADC_IsConversionDone </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>@Summary Returns true when the conversion is completed otherwise false.</p>
|
||
|
|
<p>@Description This routine is used to determine if conversion is completed. When conversion is complete routine returns true. It returns false otherwise.</p>
|
||
|
|
<p>@Preconditions <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a> and <a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion(void)</a> function should have been called before calling this function.</p>
|
||
|
|
<p>@Returns true - If conversion is complete false - If conversion is not completed</p>
|
||
|
|
<p>@Param None</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>; <a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion()</a>;</code></p>
|
||
|
|
<p><code> while(!ADC_IsConversionDone()); convertedValue = <a class="el" href="adc_8h.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult()</a>; </code> </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00097">97</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a25c0a0a9fe2bdba070f9945ca641b5e0" name="a25c0a0a9fe2bdba070f9945ca641b5e0"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25c0a0a9fe2bdba070f9945ca641b5e0">◆ </a></span>ADC_SelectChannel()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ADC_SelectChannel </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="adc_8h.html#aafc4060027875f8fe46242b0656d7814">adc_channel_t</a> </td>
|
||
|
|
<td class="paramname"><em>channel</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>@Summary Allows selection of a channel for conversion</p>
|
||
|
|
<p>@Description This routine is used to select desired channel for conversion. available</p>
|
||
|
|
<p>@Preconditions <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a> function should have been called before calling this function.</p>
|
||
|
|
<p>@Returns None</p>
|
||
|
|
<p>@Param Pass in required channel number "For available channel refer to enum under adc.h file"</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>; ADC_SelectChannel(AN1_Channel); <a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion()</a>; convertedValue = <a class="el" href="adc_8h.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult()</a>; </code> </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00082">82</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af96ee69b063edcebc656d0ca0450c12c" name="af96ee69b063edcebc656d0ca0450c12c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af96ee69b063edcebc656d0ca0450c12c">◆ </a></span>ADC_StartConversion()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ADC_StartConversion </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>@Summary Starts conversion</p>
|
||
|
|
<p>@Description This routine is used to start conversion of desired channel.</p>
|
||
|
|
<p>@Preconditions <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a> function should have been called before calling this function.</p>
|
||
|
|
<p>@Returns None</p>
|
||
|
|
<p>@Param None</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>; <br />
|
||
|
|
<a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion()</a>; convertedValue = <a class="el" href="adc_8h.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult()</a>; </code> </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00090">90</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a46bdd78f96c668432d4ff33115c9dcd9" name="a46bdd78f96c668432d4ff33115c9dcd9"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46bdd78f96c668432d4ff33115c9dcd9">◆ </a></span>ADC_TemperatureAcquisitionDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ADC_TemperatureAcquisitionDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>@Summary Acquisition Delay for temperature sensor</p>
|
||
|
|
<p>@Description This routine should be called when temperature sensor is used.</p>
|
||
|
|
<p>@Preconditions <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a> function should have been called before calling this function.</p>
|
||
|
|
<p>@Returns None</p>
|
||
|
|
<p>@Param None</p>
|
||
|
|
<p>@Example <code> uint16_t convertedValue;</code></p>
|
||
|
|
<p><code> <a class="el" href="adc_8h.html#ab0e0ea1662a8e789547210a2d33127e1">ADC_Initialize()</a>; <br />
|
||
|
|
<a class="el" href="adc_8h.html#af96ee69b063edcebc656d0ca0450c12c">ADC_StartConversion()</a>; ADC_temperatureAcquisitionDelay(); convertedValue = <a class="el" href="adc_8h.html#a9650956bd92194e1b9f0bfd5bb2d73dd">ADC_GetConversionResult()</a>; </code> </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="adc_8c_source.html#l00129">129</a> of file <a class="el" href="adc_8c_source.html">adc.c</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_0ad8aa10ae8c15a00cc43e117933779f.html">mcc_generated_files</a></li><li class="navelem"><a class="el" href="adc_8h.html">adc.h</a></li>
|
||
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|