deploy: c9180ac

adc_8c.html

@@ -78,123 +78,129 @@
 <div class="dyncontent">
 <div class="center"><img src="adc_8c__incl.png" border="0" usemap="#asrc_2adc_8c" alt=""/></div>
 <map name="asrc_2adc_8c" id="asrc_2adc_8c">
-<area shape="rect" title=" " alt="" coords="526,5,601,32"/>
-<area shape="rect" href="adc_8h.html" title=" " alt="" coords="537,80,590,107"/>
+<area shape="rect" title=" " alt="" coords="762,5,837,32"/>
+<area shape="rect" href="adc_8h.html" title=" " alt="" coords="773,80,826,107"/>
 <area shape="rect" title=" " alt="" coords="5,155,65,181"/>
 <area shape="rect" title=" " alt="" coords="89,155,152,181"/>
-<area shape="rect" title=" " alt="" coords="176,155,265,181"/>
-<area shape="rect" title=" " alt="" coords="289,155,395,181"/>
-<area shape="rect" title=" " alt="" coords="419,155,561,181"/>
-<area shape="rect" title=" " alt="" coords="585,155,691,181"/>
-<area shape="rect" title=" " alt="" coords="715,155,873,181"/>
-<area shape="rect" title=" " alt="" coords="898,155,975,181"/>
-<area shape="rect" title=" " alt="" coords="999,155,1074,181"/>
-<area shape="rect" href="pin__defs_8h.html" title=" " alt="" coords="1099,155,1180,181"/>
+<area shape="rect" title=" " alt="" coords="176,155,335,181"/>
+<area shape="rect" title=" " alt="" coords="359,155,493,181"/>
+<area shape="rect" title=" " alt="" coords="517,155,703,181"/>
+<area shape="rect" title=" " alt="" coords="728,155,871,181"/>
+<area shape="rect" title=" " alt="" coords="895,155,1000,181"/>
+<area shape="rect" title=" " alt="" coords="1024,155,1183,181"/>
+<area shape="rect" title=" " alt="" coords="1207,155,1285,181"/>
+<area shape="rect" title=" " alt="" coords="1309,155,1383,181"/>
+<area shape="rect" href="pin__defs_8h.html" title=" " alt="" coords="1408,155,1489,181"/>
 </map>
 </div>
 </div><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:a0eb8c90dffee280b1a79d8fb16968a74"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#a0eb8c90dffee280b1a79d8fb16968a74">config_adc1</a> ()</td></tr>
-<tr class="memdesc:a0eb8c90dffee280b1a79d8fb16968a74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure width and attenuation of ADC 1.  <a href="adc_8c.html#a0eb8c90dffee280b1a79d8fb16968a74">More...</a><br /></td></tr>
-<tr class="separator:a0eb8c90dffee280b1a79d8fb16968a74"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a97ba6a060bde9d47d6783e6c8c73e6fc"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#a97ba6a060bde9d47d6783e6c8c73e6fc">characterize_adc1</a> ()</td></tr>
-<tr class="memdesc:a97ba6a060bde9d47d6783e6c8c73e6fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Characterize ADC 1 using either Vref or Two Point.  <a href="adc_8c.html#a97ba6a060bde9d47d6783e6c8c73e6fc">More...</a><br /></td></tr>
-<tr class="separator:a97ba6a060bde9d47d6783e6c8c73e6fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab564ea72fa47c36b9d06977ea586cb1a"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#ab564ea72fa47c36b9d06977ea586cb1a">enable_adc1</a> ()</td></tr>
-<tr class="memdesc:ab564ea72fa47c36b9d06977ea586cb1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">call function <a class="el" href="adc_8h.html#a0eb8c90dffee280b1a79d8fb16968a74" title="Configure width and attenuation of ADC 1.">config_adc1()</a> and <a class="el" href="adc_8h.html#a97ba6a060bde9d47d6783e6c8c73e6fc" title="Characterize ADC 1 using either Vref or Two Point.">characterize_adc1()</a>.  <a href="adc_8c.html#ab564ea72fa47c36b9d06977ea586cb1a">More...</a><br /></td></tr>
-<tr class="separator:ab564ea72fa47c36b9d06977ea586cb1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5056ff0fa4f211e8cbbf6e706228d864"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#a5056ff0fa4f211e8cbbf6e706228d864">read_adc</a> (int adc_pin)</td></tr>
-<tr class="memdesc:a5056ff0fa4f211e8cbbf6e706228d864"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read raw adc value of given adc pin.  <a href="adc_8c.html#a5056ff0fa4f211e8cbbf6e706228d864">More...</a><br /></td></tr>
-<tr class="separator:a5056ff0fa4f211e8cbbf6e706228d864"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae719088fda3590b4ce5153c4ecffb859"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#ae719088fda3590b4ce5153c4ecffb859">config_adc1</a> (<a class="el" href="structadc__obj__t.html">adc_obj_t</a> *adc_obj)</td></tr>
+<tr class="separator:ae719088fda3590b4ce5153c4ecffb859"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a92b279061f360ef912815e8b0c0a1982"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#a92b279061f360ef912815e8b0c0a1982">calib_init</a> (<a class="el" href="structadc__obj__t.html">adc_obj_t</a> *adc_obj)</td></tr>
+<tr class="separator:a92b279061f360ef912815e8b0c0a1982"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a60adcc2279d178d4876c9f8f63525067"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#a60adcc2279d178d4876c9f8f63525067">enable_adc1</a> (<a class="el" href="structadc__obj__t.html">adc_obj_t</a> **adc_obj)</td></tr>
+<tr class="memdesc:a60adcc2279d178d4876c9f8f63525067"><td class="mdescLeft">&#160;</td><td class="mdescRight">call function <a class="el" href="adc_8c.html#ae719088fda3590b4ce5153c4ecffb859">config_adc1()</a> and characterize_adc1().  <a href="adc_8c.html#a60adcc2279d178d4876c9f8f63525067">More...</a><br /></td></tr>
+<tr class="separator:a60adcc2279d178d4876c9f8f63525067"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6535e5936468e64673af814623694d98"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8c.html#a6535e5936468e64673af814623694d98">read_adc</a> (<a class="el" href="adc_8h.html#a1973e31270d9eaf6f7e007b4f12d23f9">adc_handle_t</a> adc_handle, int gpio)</td></tr>
+<tr class="memdesc:a6535e5936468e64673af814623694d98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the adc value from the GPIO(channel) specified.  <a href="adc_8c.html#a6535e5936468e64673af814623694d98">More...</a><br /></td></tr>
+<tr class="separator:a6535e5936468e64673af814623694d98"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Function Documentation</h2>
-<a id="a97ba6a060bde9d47d6783e6c8c73e6fc" name="a97ba6a060bde9d47d6783e6c8c73e6fc"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a97ba6a060bde9d47d6783e6c8c73e6fc">&#9670;&nbsp;</a></span>characterize_adc1()</h2>
+<a id="a92b279061f360ef912815e8b0c0a1982" name="a92b279061f360ef912815e8b0c0a1982"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a92b279061f360ef912815e8b0c0a1982">&#9670;&nbsp;</a></span>calib_init()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">esp_err_t characterize_adc1 </td>
+          <td class="memname">esp_err_t calib_init </td>
           <td>(</td>
-          <td class="paramname"></td><td>)</td>
+          <td class="paramtype"><a class="el" href="structadc__obj__t.html">adc_obj_t</a> *&#160;</td>
+          <td class="paramname"><em>adc_obj</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 
-<p>Characterize ADC 1 using either Vref or Two Point. </p>
-<dl class="section return"><dt>Returns</dt><dd>esp_err_t </dd></dl>
-
 </div>
 </div>
-<a id="a0eb8c90dffee280b1a79d8fb16968a74" name="a0eb8c90dffee280b1a79d8fb16968a74"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a0eb8c90dffee280b1a79d8fb16968a74">&#9670;&nbsp;</a></span>config_adc1()</h2>
+<a id="ae719088fda3590b4ce5153c4ecffb859" name="ae719088fda3590b4ce5153c4ecffb859"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae719088fda3590b4ce5153c4ecffb859">&#9670;&nbsp;</a></span>config_adc1()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">esp_err_t config_adc1 </td>
           <td>(</td>
-          <td class="paramname"></td><td>)</td>
+          <td class="paramtype"><a class="el" href="structadc__obj__t.html">adc_obj_t</a> *&#160;</td>
+          <td class="paramname"><em>adc_obj</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 
-<p>Configure width and attenuation of ADC 1. </p>
-<dl class="section return"><dt>Returns</dt><dd>esp_err_t - returns ESP_OK if 11dB attenuation and 12 bit width configured to ADC 1, else it returns ESP_ERR_INVALID_ARG. <br  />
- </dd></dl>
-
 </div>
 </div>
-<a id="ab564ea72fa47c36b9d06977ea586cb1a" name="ab564ea72fa47c36b9d06977ea586cb1a"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ab564ea72fa47c36b9d06977ea586cb1a">&#9670;&nbsp;</a></span>enable_adc1()</h2>
+<a id="a60adcc2279d178d4876c9f8f63525067" name="a60adcc2279d178d4876c9f8f63525067"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a60adcc2279d178d4876c9f8f63525067">&#9670;&nbsp;</a></span>enable_adc1()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">esp_err_t enable_adc1 </td>
           <td>(</td>
-          <td class="paramname"></td><td>)</td>
+          <td class="paramtype"><a class="el" href="structadc__obj__t.html">adc_obj_t</a> **&#160;</td>
+          <td class="paramname"><em>adc_obj</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 
-<p>call function <a class="el" href="adc_8h.html#a0eb8c90dffee280b1a79d8fb16968a74" title="Configure width and attenuation of ADC 1.">config_adc1()</a> and <a class="el" href="adc_8h.html#a97ba6a060bde9d47d6783e6c8c73e6fc" title="Characterize ADC 1 using either Vref or Two Point.">characterize_adc1()</a>. </p>
+<p>call function <a class="el" href="adc_8c.html#ae719088fda3590b4ce5153c4ecffb859">config_adc1()</a> and characterize_adc1(). </p>
 <dl class="section return"><dt>Returns</dt><dd>esp_err_t - returns ESP_OK if Configuration and Characterization of adc1 is successful, else it returns ESP_ERR_INVALID_ARG. <br  />
  </dd></dl>
 
 </div>
 </div>
-<a id="a5056ff0fa4f211e8cbbf6e706228d864" name="a5056ff0fa4f211e8cbbf6e706228d864"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a5056ff0fa4f211e8cbbf6e706228d864">&#9670;&nbsp;</a></span>read_adc()</h2>
+<a id="a6535e5936468e64673af814623694d98" name="a6535e5936468e64673af814623694d98"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6535e5936468e64673af814623694d98">&#9670;&nbsp;</a></span>read_adc()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int read_adc </td>
           <td>(</td>
+          <td class="paramtype"><a class="el" href="adc_8h.html#a1973e31270d9eaf6f7e007b4f12d23f9">adc_handle_t</a>&#160;</td>
+          <td class="paramname"><em>adc_handle</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
           <td class="paramtype">int&#160;</td>
-          <td class="paramname"><em>adc_pin</em></td><td>)</td>
+          <td class="paramname"><em>gpio</em>&#160;</td>
+        </tr>
+        <tr>
           <td></td>
+          <td>)</td>
+          <td></td><td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 
-<p>Read raw adc value of given adc pin. </p>
+<p>Reads the adc value from the GPIO(channel) specified. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">adc_pin</td><td>One of the GPIO pin to which LSA is connected (36/39/35/34)</td></tr>
+    <tr><td class="paramname">adc_handle_t</td><td>adc_handle - pointer to adc object. </td></tr>
+    <tr><td class="paramname">int</td><td>gpio - gpio pin number of the channel to be read. </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>esp_err_t -returns raw reading of adc pin if lsa pin is passed to function, else it returns ESP_ERR_INVALID_ARG. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>int - returns the adc value read from the channel. </dd></dl>
 
 </div>
 </div>

adc_8c__incl.map

@@ -1,14 +1,15 @@
 <map id="src/adc.c" name="src/adc.c">
-<area shape="rect" id="node1" title=" " alt="" coords="526,5,601,32"/>
-<area shape="rect" id="node2" href="$adc_8h.html" title=" " alt="" coords="537,80,590,107"/>
+<area shape="rect" id="node1" title=" " alt="" coords="762,5,837,32"/>
+<area shape="rect" id="node2" href="$adc_8h.html" title=" " alt="" coords="773,80,826,107"/>
 <area shape="rect" id="node3" title=" " alt="" coords="5,155,65,181"/>
 <area shape="rect" id="node4" title=" " alt="" coords="89,155,152,181"/>
-<area shape="rect" id="node5" title=" " alt="" coords="176,155,265,181"/>
-<area shape="rect" id="node6" title=" " alt="" coords="289,155,395,181"/>
-<area shape="rect" id="node7" title=" " alt="" coords="419,155,561,181"/>
-<area shape="rect" id="node8" title=" " alt="" coords="585,155,691,181"/>
-<area shape="rect" id="node9" title=" " alt="" coords="715,155,873,181"/>
-<area shape="rect" id="node10" title=" " alt="" coords="898,155,975,181"/>
-<area shape="rect" id="node11" title=" " alt="" coords="999,155,1074,181"/>
-<area shape="rect" id="node12" href="$pin__defs_8h.html" title=" " alt="" coords="1099,155,1180,181"/>
+<area shape="rect" id="node5" title=" " alt="" coords="176,155,335,181"/>
+<area shape="rect" id="node6" title=" " alt="" coords="359,155,493,181"/>
+<area shape="rect" id="node7" title=" " alt="" coords="517,155,703,181"/>
+<area shape="rect" id="node8" title=" " alt="" coords="728,155,871,181"/>
+<area shape="rect" id="node9" title=" " alt="" coords="895,155,1000,181"/>
+<area shape="rect" id="node10" title=" " alt="" coords="1024,155,1183,181"/>
+<area shape="rect" id="node11" title=" " alt="" coords="1207,155,1285,181"/>
+<area shape="rect" id="node12" title=" " alt="" coords="1309,155,1383,181"/>
+<area shape="rect" id="node13" href="$pin__defs_8h.html" title=" " alt="" coords="1408,155,1489,181"/>
 </map>

adc_8c__incl.md5

@@ -1 +1 @@
-2b9b578584b566393e4912894a34bdcc
+66d925ab145eb39e6b06efd038ce1f16