deploy: 84a4cb1

joeycastillo · Sep 28, 2023 · d866850 · d866850
1 parent 007ee34
commit d866850
Show file tree

Hide file tree

Showing 38 changed files with 770 additions and 621 deletions.
diff --git a/adc_8h.html b/adc_8h.html
@@ -102,6 +102,9 @@
 <tr class="memitem:a2c8f49eff87c1a55de3b11afe59cae37"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37">adc_get_analog_value</a> (uint16_t pin)</td></tr>
 <tr class="memdesc:a2c8f49eff87c1a55de3b11afe59cae37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the analog value on the given ADC pin.  <a href="adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37">More...</a><br /></td></tr>
 <tr class="separator:a2c8f49eff87c1a55de3b11afe59cae37"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a200744370e2a8505c3dead71aff1c2dc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a200744370e2a8505c3dead71aff1c2dc">adc_get_analog_value_for_channel</a> (uint8_t channel)</td></tr>
+<tr class="memdesc:a200744370e2a8505c3dead71aff1c2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the analog value on the given ADC channel.  <a href="adc_8h.html#a200744370e2a8505c3dead71aff1c2dc">More...</a><br /></td></tr>
+<tr class="separator:a200744370e2a8505c3dead71aff1c2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3b4b977d0665b5346849f3b892ac5106"><td class="memItemLeft" align="right" valign="top"><a id="a3b4b977d0665b5346849f3b892ac5106" name="a3b4b977d0665b5346849f3b892ac5106"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><b>adc_disable</b> (void)</td></tr>
 <tr class="memdesc:a3b4b977d0665b5346849f3b892ac5106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the ADC peripheral. <br /></td></tr>
@@ -135,6 +138,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2c8f49eff87c1a55de3b11af
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The analog value of the given ADC pin, from 0-65535 by default. If the pin is not an ADC pin, returns 0. </dd></dl>
 
+</div>
+</div>
+<a id="a200744370e2a8505c3dead71aff1c2dc" name="a200744370e2a8505c3dead71aff1c2dc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a200744370e2a8505c3dead71aff1c2dc">&#9670;&#160;</a></span>adc_get_analog_value_for_channel()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t adc_get_analog_value_for_channel </td>
+          <td>(</td>
+          <td class="paramtype">uint8_t&#160;</td>
+          <td class="paramname"><em>channel</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Gets the analog value on the given ADC channel. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">channel</td><td>The ADC channel you wish to read (this will come from the datasheet) </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The analog value of the given ADC channel, from 0-65535 by default. </dd></dl>
+
 </div>
 </div>
 <a id="a2b815e6730e8723a6d1d06d9ef8f31c0" name="a2b815e6730e8723a6d1d06d9ef8f31c0"></a>

diff --git a/adc_8h_source.html b/adc_8h_source.html
@@ -116,12 +116,15 @@
 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>uint16_t <a class="code hl_function" href="adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37">adc_get_analog_value</a>(uint16_t pin);</div>
 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
-<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="keywordtype">void</span> <a class="code hl_function" href="adc_8h.html#a3b4b977d0665b5346849f3b892ac5106">adc_disable</a>(<span class="keywordtype">void</span>);</div>
+<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>uint16_t <a class="code hl_function" href="adc_8h.html#a200744370e2a8505c3dead71aff1c2dc">adc_get_analog_value_for_channel</a>(uint8_t channel);</div>
+<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span> </div>
+<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="keywordtype">void</span> <a class="code hl_function" href="adc_8h.html#a3b4b977d0665b5346849f3b892ac5106">adc_disable</a>(<span class="keywordtype">void</span>);</div>
 <div class="ttc" id="aadc_8h_html_a1b33d0d9bd2841354f016f8c64be3e15"><div class="ttname"><a href="adc_8h.html#a1b33d0d9bd2841354f016f8c64be3e15">adc_set_sampling_length</a></div><div class="ttdeci">void adc_set_sampling_length(uint8_t length)</div><div class="ttdoc">Sets the sampling length for the ADC.</div><div class="ttdef"><b>Definition:</b> adc.c:75</div></div>
-<div class="ttc" id="aadc_8h_html_a2b815e6730e8723a6d1d06d9ef8f31c0"><div class="ttname"><a href="adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0">adc_init</a></div><div class="ttdeci">void adc_init(void)</div><div class="ttdoc">Initializes the ADC peripheral, but does not enable it.</div><div class="ttdef"><b>Definition:</b> adc.c:104</div></div>
-<div class="ttc" id="aadc_8h_html_a2c8f49eff87c1a55de3b11afe59cae37"><div class="ttname"><a href="adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37">adc_get_analog_value</a></div><div class="ttdeci">uint16_t adc_get_analog_value(uint16_t pin)</div><div class="ttdoc">Gets the analog value on the given ADC pin.</div><div class="ttdef"><b>Definition:</b> adc.c:97</div></div>
-<div class="ttc" id="aadc_8h_html_a3afdea3b7c9b91013c270f1a1a669782"><div class="ttname"><a href="adc_8h.html#a3afdea3b7c9b91013c270f1a1a669782">adc_enable</a></div><div class="ttdeci">void adc_enable(void)</div><div class="ttdoc">Enables the ADC peripheral.</div><div class="ttdef"><b>Definition:</b> adc.c:185</div></div>
-<div class="ttc" id="aadc_8h_html_a3b4b977d0665b5346849f3b892ac5106"><div class="ttname"><a href="adc_8h.html#a3b4b977d0665b5346849f3b892ac5106">adc_disable</a></div><div class="ttdeci">void adc_disable(void)</div><div class="ttdoc">Disables the ADC peripheral.</div><div class="ttdef"><b>Definition:</b> adc.c:192</div></div>
+<div class="ttc" id="aadc_8h_html_a200744370e2a8505c3dead71aff1c2dc"><div class="ttname"><a href="adc_8h.html#a200744370e2a8505c3dead71aff1c2dc">adc_get_analog_value_for_channel</a></div><div class="ttdeci">uint16_t adc_get_analog_value_for_channel(uint8_t channel)</div><div class="ttdoc">Gets the analog value on the given ADC channel.</div><div class="ttdef"><b>Definition:</b> adc.c:81</div></div>
+<div class="ttc" id="aadc_8h_html_a2b815e6730e8723a6d1d06d9ef8f31c0"><div class="ttname"><a href="adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0">adc_init</a></div><div class="ttdeci">void adc_init(void)</div><div class="ttdoc">Initializes the ADC peripheral, but does not enable it.</div><div class="ttdef"><b>Definition:</b> adc.c:103</div></div>
+<div class="ttc" id="aadc_8h_html_a2c8f49eff87c1a55de3b11afe59cae37"><div class="ttname"><a href="adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37">adc_get_analog_value</a></div><div class="ttdeci">uint16_t adc_get_analog_value(uint16_t pin)</div><div class="ttdoc">Gets the analog value on the given ADC pin.</div><div class="ttdef"><b>Definition:</b> adc.c:93</div></div>
+<div class="ttc" id="aadc_8h_html_a3afdea3b7c9b91013c270f1a1a669782"><div class="ttname"><a href="adc_8h.html#a3afdea3b7c9b91013c270f1a1a669782">adc_enable</a></div><div class="ttdeci">void adc_enable(void)</div><div class="ttdoc">Enables the ADC peripheral.</div><div class="ttdef"><b>Definition:</b> adc.c:184</div></div>
+<div class="ttc" id="aadc_8h_html_a3b4b977d0665b5346849f3b892ac5106"><div class="ttname"><a href="adc_8h.html#a3b4b977d0665b5346849f3b892ac5106">adc_disable</a></div><div class="ttdeci">void adc_disable(void)</div><div class="ttdoc">Disables the ADC peripheral.</div><div class="ttdef"><b>Definition:</b> adc.c:191</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>