Skip to content

Commit

Permalink
Merge pull request #351 from joelkoz/doxygen-update-1.0.1
Browse files Browse the repository at this point in the history 
Doxygen update 1.0.1
  • Loading branch information
@joelkoz
joelkoz authored Dec 31, 2020
2 parents ca6eaa9 + b7aec1c commit 8ba83eb
Show file tree
Hide file tree
Showing 1,577 changed files with 15,231 additions and 51,746 deletions.
4 changes: 2 additions & 2 deletions Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = SensESP
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 1.0.0
PROJECT_NUMBER = 1.0.1

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down Expand Up @@ -2338,7 +2338,7 @@ CLASS_GRAPH = YES
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.

COLLABORATION_GRAPH = YES
COLLABORATION_GRAPH = NO

# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/ads1x15_8cpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SensESP
&#160;<span id="projectnumber">1.0.0</span>
&#160;<span id="projectnumber">1.0.1</span>
</div>
<div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
</td>
Expand Down
41 changes: 20 additions & 21 deletions docs/generated/docs/ads1x15_8cpp_source.html
View file

Large diffs are not rendered by default.

47 changes: 16 additions & 31 deletions docs/generated/docs/ads1x15_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SensESP
&#160;<span id="projectnumber">1.0.0</span>
&#160;<span id="projectnumber">1.0.1</span>
</div>
<div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
</td>
Expand Down Expand Up @@ -122,12 +122,13 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1x15.html">ADS1x15&lt; T_Ada_1x15 &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> represents an ADS1015 or ADS1115 Analog to Digital Converter. <a href="class_a_d_s1x15.html#details">More...</a><br /></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an ADS1015 or ADS1115 Analog to Digital Converter. Values are read with <a class="el" href="class_a_d_s1x15_raw_value.html" title="Used to read the raw output of the ADS1x15, which is an integer between 0 and 32,768....">ADS1x15RawValue</a> or <a class="el" href="class_a_d_s1x15_voltage.html" title="Reads the raw output of the ADS1x15 (an integer between 0 and 32,768) and converts it back into the v...">ADS1x15Voltage</a>. <a href="class_a_d_s1x15.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1x15_raw_value.html">ADS1x15RawValue&lt; T_ads_1x15 &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to read the raw output of the <a class="el" href="class_a_d_s1x15.html" title="Represents an ADS1015 or ADS1115 Analog to Digital Converter. Values are read with ADS1x15RawValue or...">ADS1x15</a>, which is an integer between 0 and 32,768. If you want the voltage that was the input to the <a class="el" href="class_a_d_s1x15.html" title="Represents an ADS1015 or ADS1115 Analog to Digital Converter. Values are read with ADS1x15RawValue or...">ADS1x15</a> (because voltage is what the <a class="el" href="class_a_d_s1x15.html" title="Represents an ADS1015 or ADS1115 Analog to Digital Converter. Values are read with ADS1x15RawValue or...">ADS1x15</a> actually reads), use <a class="el" href="class_a_d_s1x15_voltage.html" title="Reads the raw output of the ADS1x15 (an integer between 0 and 32,768) and converts it back into the v...">ADS1x15Voltage</a> instead. <a href="class_a_d_s1x15_raw_value.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1x15_voltage.html">ADS1x15Voltage&lt; T_ads_1x15, chip &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_a_d_s1x15_voltage.html" title="ADS1x15Voltage reads the raw output of the ADS1x15 (an integer between 0 and 32,768) and converts it ...">ADS1x15Voltage</a> reads the raw output of the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> (an integer between 0 and 32,768) and converts it back into the voltage that was actually read by the chip. If you want the raw output itself, use <a class="el" href="class_a_d_s1x15_raw_value.html">ADS1x15RawValue</a> instead. <a href="class_a_d_s1x15_voltage.html#details">More...</a><br /></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the raw output of the <a class="el" href="class_a_d_s1x15.html" title="Represents an ADS1015 or ADS1115 Analog to Digital Converter. Values are read with ADS1x15RawValue or...">ADS1x15</a> (an integer between 0 and 32,768) and converts it back into the voltage that was actually read by the chip. If you want the raw output itself, use <a class="el" href="class_a_d_s1x15_raw_value.html" title="Used to read the raw output of the ADS1x15, which is an integer between 0 and 32,768....">ADS1x15RawValue</a> instead. <a href="class_a_d_s1x15_voltage.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Expand Down Expand Up @@ -165,7 +166,6 @@
<a class="el" href="ads1x15_8h.html#a622b3e2ec3ddaaca3ab4c36719a0ed27a54c0bd8abeca70d8b990d006d08ef252">channels_2_3</a>
<br />
}</td></tr>
<tr class="memdesc:a622b3e2ec3ddaaca3ab4c36719a0ed27"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_a_d_s1x15_raw_value.html">ADS1x15RawValue</a> is used to read the raw output of the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a>, which is an integer between 0 and 32,768. If you want the voltage that was the input to the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> (because voltage is what the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> actually reads), use <a class="el" href="class_a_d_s1x15_voltage.html" title="ADS1x15Voltage reads the raw output of the ADS1x15 (an integer between 0 and 32,768) and converts it ...">ADS1x15Voltage</a> instead. <a href="ads1x15_8h.html#a622b3e2ec3ddaaca3ab4c36719a0ed27">More...</a><br /></td></tr>
<tr class="separator:a622b3e2ec3ddaaca3ab4c36719a0ed27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a287de91a50d45b83ad2b999a32f96846"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ads1x15_8h.html#a287de91a50d45b83ad2b999a32f96846">ADS1x15CHIP_t</a> { <a class="el" href="ads1x15_8h.html#a287de91a50d45b83ad2b999a32f96846a1efc5b453be0b8efe9d2827c22c94669">ADS1015chip</a>,
<a class="el" href="ads1x15_8h.html#a287de91a50d45b83ad2b999a32f96846a8d7ed005368ca618b3f7022dc1cb5c32">ADS1115chip</a>,
Expand All @@ -187,7 +187,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6f6b131100a4dd4ca22e4152
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00037">37</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00032">32</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -203,7 +203,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a78c9be62b1660901fedd3db0
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00085">85</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00080">80</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -219,7 +219,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab2547b60408d5ce2ad6faf2c
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00090">90</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00085">85</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -235,7 +235,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1f010f96ffd4e7beab3c2a33
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00093">93</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00088">88</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -251,7 +251,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af01c0b961b00a891294ad80f
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00144">144</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00137">137</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -267,7 +267,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aff5c694cee53802680653a7a
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00038">38</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00033">33</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -283,7 +283,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a743fdef8f11174acd7711a3b
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00086">86</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00081">81</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -299,7 +299,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5953e6ad92b9f37e021c2faa
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00096">96</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00091">91</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -315,7 +315,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac74ed9a15eabc15bb5c655cd
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00099">99</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00094">94</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -331,7 +331,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad9a274de1efec3a9ffb43a3d
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00145">145</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00138">138</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -347,21 +347,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a622b3e2ec3ddaaca3ab4c367
</tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="class_a_d_s1x15_raw_value.html">ADS1x15RawValue</a> is used to read the raw output of the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a>, which is an integer between 0 and 32,768. If you want the voltage that was the input to the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> (because voltage is what the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> actually reads), use <a class="el" href="class_a_d_s1x15_voltage.html" title="ADS1x15Voltage reads the raw output of the ADS1x15 (an integer between 0 and 32,768) and converts it ...">ADS1x15Voltage</a> instead. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ads1x15</td><td>A pointer to the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> object.</td></tr>
<tr><td class="paramname">channel</td><td>The channel of the <a class="el" href="class_a_d_s1x15.html" title="ADS1x15 represents an ADS1015 or ADS1115 Analog to Digital Converter.">ADS1x15</a> that you want to read. For a single channel, use channel_0, channel_1, channel_2, or channel_3, and readADC_SingleEnded() will be used. If you want to read the difference between two channels, this parameter should be:<ul>
<li>channels_0_1 to use readADC_Differential_0_1()</li>
<li>channels_2_3 to use readADC_Differential_2_3()</li>
</ul>
</td></tr>
<tr><td class="paramname">read_delay</td><td>How often to read the value, in ms.</td></tr>
<tr><td class="paramname">config_path</td><td>The path to configuring read_delay in the Config UI. </td></tr>
</table>
</dd>
</dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a622b3e2ec3ddaaca3ab4c36719a0ed27a9c2b0338a4f47253d627c1d18bf17a70"></a>channel_0&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a622b3e2ec3ddaaca3ab4c36719a0ed27ad054e06749b443bbe86d5a0c4a5617aa"></a>channel_1&#160;</td><td class="fielddoc"></td></tr>
Expand All @@ -371,7 +356,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a622b3e2ec3ddaaca3ab4c367
<tr><td class="fieldname"><a id="a622b3e2ec3ddaaca3ab4c36719a0ed27a54c0bd8abeca70d8b990d006d08ef252"></a>channels_2_3&#160;</td><td class="fielddoc"></td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00062">62</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00037">37</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand All @@ -393,7 +378,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a287de91a50d45b83ad2b999a
<tr><td class="fieldname"><a id="a287de91a50d45b83ad2b999a32f96846a8d7ed005368ca618b3f7022dc1cb5c32"></a>ADS1115chip&#160;</td><td class="fielddoc"></td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00103">103</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ads1x15_8h_source.html#l00098">98</a> of file <a class="el" href="ads1x15_8h_source.html">ads1x15.h</a>.</p>

</div>
</div>
Expand Down
76 changes: 37 additions & 39 deletions docs/generated/docs/ads1x15_8h_source.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/generated/docs/ads1x15__voltage_8cpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SensESP
&#160;<span id="projectnumber">1.0.0</span>
&#160;<span id="projectnumber">1.0.1</span>
</div>
<div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
</td>
Expand Down
Loading

0 comments on commit 8ba83eb

Please sign in to comment.