Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IoT-MBBR (masterthesis): firmware/EFM32HG222F64_iot-mbbr/inc/adc.h Source File</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>
<script type="text/javascript">
$(document).ready(initResizable);
</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">IoT-MBBR (masterthesis)
</div>
<div id="projectbrief">Masterthesis upgrading a Moving Bed BioReactor with extra sensors and cloud connectivity.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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">
$(document).ready(function(){initNavTree('adc_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">adc.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="adc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/***************************************************************************/</span><span class="comment">/**</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file adc.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief ADC functionality for reading the (battery) voltage and internal temperature.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * @version 3.0</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * @author Brecht Van Eeckhoudt</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * ******************************************************************************</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * @section License</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * **Copyright (C) 2020 - Brecht Van Eeckhoudt**</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * it under the terms of the **GNU General Public License** as published by</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * the Free Software Foundation, either **version 3** of the License, or</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * (at your option) any later version.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * *A copy of the GNU General Public License can be found in the `LICENSE`</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * file along with this source code.*</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @n</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Some methods use code obtained from examples from [Silicon Labs' GitHub](https://github.com/SiliconLabs/peripheral_examples).</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * These sections are licensed under the Silabs License Agreement. See the file</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * "Silabs_License_Agreement.txt" for details. Before using this software for</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * any purpose, you must agree to the terms of that agreement.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/* Include guards prevent multiple inclusions of the same header */</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifndef _ADC_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define _ADC_H_</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/* Includes necessary for this header file */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <stdint.h></span> <span class="comment">/* (u)intXX_t */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/** Enum type for the ADC */</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926"> 46</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926">adc_measurements</a></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a33dfae05581973af118a10481e139aba"> 48</a></span>  <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a33dfae05581973af118a10481e139aba">BATTERY_VOLTAGE</a>,</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a536d05df6092745fa011adfed26e6312"> 49</a></span>  <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a536d05df6092745fa011adfed26e6312">INTERNAL_TEMPERATURE</a>,</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a703cf81b7a9530ba8650e0ee2f29d68e"> 50</a></span>  <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a703cf81b7a9530ba8650e0ee2f29d68e">CH1</a>,</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926ae574b39c34bd88c27ea641014831e53a"> 51</a></span>  <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926ae574b39c34bd88c27ea641014831e53a">CH2</a>,</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926aaee6d12bf63ae430250764aa97e9e429"> 52</a></span>  <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926aaee6d12bf63ae430250764aa97e9e429">CH3</a>,</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926aad6a6b3e7230ebcbbb5a26385b11ade7"> 53</a></span>  <a class="code" href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926aad6a6b3e7230ebcbbb5a26385b11ade7">CH4</a></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> } <a class="code" href="adc_8h.html#a276c7770f520a2b96109d71d140ba4a5">ADC_Measurement_t</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/* Public prototypes */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">void</span> <a class="code" href="adc_8h.html#ab8a50016236d402e27a7e1b7f0f4cf52">initADC</a> (<a class="code" href="adc_8h.html#a276c7770f520a2b96109d71d140ba4a5">ADC_Measurement_t</a> peripheral);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="vl53l1__types_8h.html#a32f2e37ee053cf2ce8ca28d1f74630e5">int32_t</a> <a class="code" href="adc_8h.html#ac6cece90b77d0ba6c1afaf17f57bb790">readADC</a> (<a class="code" href="adc_8h.html#a276c7770f520a2b96109d71d140ba4a5">ADC_Measurement_t</a> peripheral);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#endif </span><span class="comment">/* _ADC_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="adc_8h_html_ab8a50016236d402e27a7e1b7f0f4cf52"><div class="ttname"><a href="adc_8h.html#ab8a50016236d402e27a7e1b7f0f4cf52">initADC</a></div><div class="ttdeci">void initADC(ADC_Measurement_t peripheral)</div><div class="ttdoc">Method to initialize the ADC to later check the battery voltage or internal temperature. </div><div class="ttdef"><b>Definition:</b> <a href="adc_8c_source.html#l00087">adc.c:87</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926aad6a6b3e7230ebcbbb5a26385b11ade7"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926aad6a6b3e7230ebcbbb5a26385b11ade7">CH4</a></div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00053">adc.h:53</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926a703cf81b7a9530ba8650e0ee2f29d68e"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a703cf81b7a9530ba8650e0ee2f29d68e">CH1</a></div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00050">adc.h:50</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926">adc_measurements</a></div><div class="ttdeci">adc_measurements</div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00046">adc.h:46</a></div></div>
<div class="ttc" id="vl53l1__types_8h_html_a32f2e37ee053cf2ce8ca28d1f74630e5"><div class="ttname"><a href="vl53l1__types_8h.html#a32f2e37ee053cf2ce8ca28d1f74630e5">int32_t</a></div><div class="ttdeci">int int32_t</div><div class="ttdoc">Typedef defining 32 bit int type. The developer should modify this to suit the platform being deploye...</div><div class="ttdef"><b>Definition:</b> <a href="vl53l1__types_8h_source.html#l00083">vl53l1_types.h:83</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926a33dfae05581973af118a10481e139aba"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a33dfae05581973af118a10481e139aba">BATTERY_VOLTAGE</a></div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00048">adc.h:48</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926a536d05df6092745fa011adfed26e6312"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926a536d05df6092745fa011adfed26e6312">INTERNAL_TEMPERATURE</a></div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00049">adc.h:49</a></div></div>
<div class="ttc" id="adc_8h_html_ac6cece90b77d0ba6c1afaf17f57bb790"><div class="ttname"><a href="adc_8h.html#ac6cece90b77d0ba6c1afaf17f57bb790">readADC</a></div><div class="ttdeci">int32_t readADC(ADC_Measurement_t peripheral)</div><div class="ttdoc">Method to read the battery voltage or internal temperature. </div><div class="ttdef"><b>Definition:</b> <a href="adc_8c_source.html#l00189">adc.c:189</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926ae574b39c34bd88c27ea641014831e53a"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926ae574b39c34bd88c27ea641014831e53a">CH2</a></div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00051">adc.h:51</a></div></div>
<div class="ttc" id="adc_8h_html_a8d24200decb8cc61e4c749c435e80926aaee6d12bf63ae430250764aa97e9e429"><div class="ttname"><a href="adc_8h.html#a8d24200decb8cc61e4c749c435e80926aaee6d12bf63ae430250764aa97e9e429">CH3</a></div><div class="ttdef"><b>Definition:</b> <a href="adc_8h_source.html#l00052">adc.h:52</a></div></div>
<div class="ttc" id="adc_8h_html_a276c7770f520a2b96109d71d140ba4a5"><div class="ttname"><a href="adc_8h.html#a276c7770f520a2b96109d71d140ba4a5">ADC_Measurement_t</a></div><div class="ttdeci">enum adc_measurements ADC_Measurement_t</div></div>
</div><!-- fragment --></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_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="dir_9a5a365c58dea0dc152d55f461feaba5.html">EFM32HG222F64_iot-mbbr</a></li><li class="navelem"><a class="el" href="dir_50f1611db0d8b6d18176211c614d1122.html">inc</a></li><li class="navelem"><a class="el" href="adc_8h.html">adc.h</a></li>
<li class="footer">Generated on Thu Sep 3 2020 04:44:25 for IoT-MBBR (masterthesis) by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
48241ad08This file is pinned to the selected release. Download the original to open it in your design tool.