deploy: efba273

joeycastillo · Jul 9, 2024 · ba32f2e · ba32f2e
1 parent 1390555
commit ba32f2e
Show file tree

Hide file tree

Showing 325 changed files with 5,935 additions and 4,981 deletions.
diff --git a/adc_8h.html b/adc_8h.html
@@ -3,7 +3,7 @@
 <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.5"/>
+<meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>gossamer: peripherals/adc.h File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -89,29 +89,29 @@
 <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:a2b815e6730e8723a6d1d06d9ef8f31c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0">adc_init</a> (void)</td></tr>
-<tr class="memdesc:a2b815e6730e8723a6d1d06d9ef8f31c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the ADC peripheral, but does not enable it.  <a href="adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0">More...</a><br /></td></tr>
+<tr class="memitem:a2b815e6730e8723a6d1d06d9ef8f31c0" id="r_a2b815e6730e8723a6d1d06d9ef8f31c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0">adc_init</a> (void)</td></tr>
+<tr class="memdesc:a2b815e6730e8723a6d1d06d9ef8f31c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the ADC peripheral, but does not enable it.  <br /></td></tr>
 <tr class="separator:a2b815e6730e8723a6d1d06d9ef8f31c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a3afdea3b7c9b91013c270f1a1a669782"><td class="memItemLeft" align="right" valign="top"><a id="a3afdea3b7c9b91013c270f1a1a669782" name="a3afdea3b7c9b91013c270f1a1a669782"></a>
+<tr class="memitem:a3afdea3b7c9b91013c270f1a1a669782" id="r_a3afdea3b7c9b91013c270f1a1a669782"><td class="memItemLeft" align="right" valign="top"><a id="a3afdea3b7c9b91013c270f1a1a669782" name="a3afdea3b7c9b91013c270f1a1a669782"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><b>adc_enable</b> (void)</td></tr>
 <tr class="memdesc:a3afdea3b7c9b91013c270f1a1a669782"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the ADC peripheral. <br /></td></tr>
 <tr class="separator:a3afdea3b7c9b91013c270f1a1a669782"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a1b33d0d9bd2841354f016f8c64be3e15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a1b33d0d9bd2841354f016f8c64be3e15">adc_set_sampling_length</a> (uint8_t length)</td></tr>
-<tr class="memdesc:a1b33d0d9bd2841354f016f8c64be3e15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the sampling length for the ADC.  <a href="adc_8h.html#a1b33d0d9bd2841354f016f8c64be3e15">More...</a><br /></td></tr>
+<tr class="memitem:a1b33d0d9bd2841354f016f8c64be3e15" id="r_a1b33d0d9bd2841354f016f8c64be3e15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="adc_8h.html#a1b33d0d9bd2841354f016f8c64be3e15">adc_set_sampling_length</a> (uint8_t length)</td></tr>
+<tr class="memdesc:a1b33d0d9bd2841354f016f8c64be3e15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the sampling length for the ADC.  <br /></td></tr>
 <tr class="separator:a1b33d0d9bd2841354f016f8c64be3e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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="memitem:a2c8f49eff87c1a55de3b11afe59cae37" id="r_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.  <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="memitem:a200744370e2a8505c3dead71aff1c2dc" id="r_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.  <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>
+<tr class="memitem:a3b4b977d0665b5346849f3b892ac5106" id="r_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>
 <tr class="separator:a3b4b977d0665b5346849f3b892ac5106"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p >Analog to Digital Converter. </p>
+<div class="textblock"><p>Analog to Digital Converter. </p>
 </div><h2 class="groupheader">Function Documentation</h2>
 <a id="a2c8f49eff87c1a55de3b11afe59cae37" name="a2c8f49eff87c1a55de3b11afe59cae37"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a2c8f49eff87c1a55de3b11afe59cae37">&#9670;&#160;</a></span>adc_get_analog_value()</h2>
@@ -184,7 +184,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2b815e6730e8723a6d1d06d9
 </div><div class="memdoc">
 
 <p>Initializes the ADC peripheral, but does not enable it. </p>
-<p >This function sets up some sensible defaults for basic use cases:</p><ul>
+<p>This function sets up some sensible defaults for basic use cases:</p><ul>
 <li>Clocks the ADC with the main oscillator divided down to a 500 kHz ADC clock.</li>
 <li>Sets sampling length to one clock cycle, which is appropriate for inputs with impedance up to 28 kOhm.</li>
 <li>Sets oversampling of 16 samples, resulting in a conversion time of 32 microseconds.</li>
@@ -212,14 +212,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1b33d0d9bd2841354f016f8c
 </div><div class="memdoc">
 
 <p>Sets the sampling length for the ADC. </p>
-<p >The sampling length sets the number of ADC clock cycles for which the ADC will sample the input, less 1 (so 0 represents 1 clock cycle). The default is 0, which is a good choice for inputs with impedance up to 28 kOhm. Each additional clock cycle of sampling time adds about 32 kOhm to the maximum input impedance. </p><dl class="section see"><dt>See also</dt><dd><a href="https://blog.thea.codes/getting-the-most-out-of-the-samd21-adc/">https://blog.thea.codes/getting-the-most-out-of-the-samd21-adc/</a> </dd></dl>
+<p>The sampling length sets the number of ADC clock cycles for which the ADC will sample the input, less 1 (so 0 represents 1 clock cycle). The default is 0, which is a good choice for inputs with impedance up to 28 kOhm. Each additional clock cycle of sampling time adds about 32 kOhm to the maximum input impedance. </p><dl class="section see"><dt>See also</dt><dd><a href="https://blog.thea.codes/getting-the-most-out-of-the-samd21-adc/">https://blog.thea.codes/getting-the-most-out-of-the-samd21-adc/</a> </dd></dl>
 
 </div>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
 </small></address>
 </body>
 </html>
diff --git a/adc_8h_source.html b/adc_8h_source.html
@@ -3,7 +3,7 @@
 <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.5"/>
+<meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>gossamer: peripherals/adc.h Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -47,6 +47,11 @@
 /* @license-end */
 </script>
 <div id="main-nav"></div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(document).ready(function() { init_codefold(0); });
+/* @license-end */
+</script>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
@@ -119,16 +124,16 @@
 <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_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 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_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>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
 </small></address>
 </body>
 </html>
diff --git a/annotated.html b/annotated.html
@@ -3,7 +3,7 @@
 <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.5"/>
+<meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>gossamer: Data Structures</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -118,7 +118,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
 </small></address>
 </body>
 </html>