Skip to content

Commit

Permalink
Deploy docs to GitHub Pages from commit a0c8c75
Browse files Browse the repository at this point in the history
Commit: a0c8c75
GitHub Actions run: 12915052328
  • Loading branch information
Doxygen CI committed Jan 22, 2025
1 parent 660a12e commit 3cd1f88
Show file tree
Hide file tree
Showing 114 changed files with 3,138 additions and 1,998 deletions.
2 changes: 2 additions & 0 deletions html/_wipper_snapper___i2_c_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___s_c_d30_8h_source.html">drivers/WipperSnapper_I2C_Driver_SCD30.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___s_c_d4_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_SCD4X.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___s_e_n5_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_SEN5X.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___s_e_n6_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_SEN6X.h</a>&quot;</code><br />
<code>#include &quot;drivers/WipperSnapper_I2C_Driver_SGP30.h&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___s_g_p40_8h_source.html">drivers/WipperSnapper_I2C_Driver_SGP40.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___s_h_t3_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_SHT3X.h</a>&quot;</code><br />
Expand All @@ -117,6 +118,7 @@
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___t_s_l2591_8h_source.html">drivers/WipperSnapper_I2C_Driver_TSL2591.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_c_n_l4020_8h_source.html">drivers/WipperSnapper_I2C_Driver_VCNL4020.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_c_n_l4040_8h_source.html">drivers/WipperSnapper_I2C_Driver_VCNL4040.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_c_n_l4200_8h_source.html">drivers/WipperSnapper_I2C_Driver_VCNL4200.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_e_m_l7700_8h_source.html">drivers/WipperSnapper_I2C_Driver_VEML7700.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l0_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_VL53L0X.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l1_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_VL53L1X.h</a>&quot;</code><br />
Expand Down
24 changes: 14 additions & 10 deletions html/_wipper_snapper___i2_c_8h_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion html/_wipper_snapper___i2_c___driver_8h_source.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
<tr class="separator:"><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>Device driver for the SEN5X CO2, Temperature, and Humidity sensor. TEMPORARY HACK</p>
<div class="textblock"><p>Device driver for the SEN5X air quality sensors.</p>
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
<p>Copyright (c) Marni Brewster 2022 for Adafruit Industries.</p>
<p>Copyright (c) Tyeth Gundry 2022 for Adafruit Industries.</p>
<p>MIT license, all text here must be included in any redistribution. </p>
</div></div><!-- contents -->
<!-- start footer part -->
Expand Down
24 changes: 12 additions & 12 deletions html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h_source.html

Large diffs are not rendered by default.

96 changes: 96 additions & 0 deletions html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<!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>Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_SEN6X.h File Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">Adafruit Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_3c4c7c1a85608ccd561c026bec818e51.html">components</a></li><li class="navelem"><a class="el" href="dir_4fafa5166706850f4166bb4839b0f809.html">i2c</a></li><li class="navelem"><a class="el" href="dir_fcb6e4fbca5bd9aa8323205978345f78.html">drivers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle">
<div class="title">WipperSnapper_I2C_Driver_SEN6X.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver_8h_source.html">WipperSnapper_I2C_Driver.h</a>&quot;</code><br />
<code>#include &lt;SensirionI2cSen66.h&gt;</code><br />
<code>#include &lt;Wire.h&gt;</code><br />
</div>
<p><a href="_wipper_snapper___i2_c___driver___s_e_n6_x_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<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_wipper_snapper___i2_c___driver___s_e_n6_x.html">WipperSnapper_I2C_Driver_SEN6X</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that provides a driver interface for the SEN6X sensor. <a href="class_wipper_snapper___i2_c___driver___s_e_n6_x.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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>Device driver for the SEN66 Particulate Matter, Temperature, Humidity, VOC, NOX, and CO2 sensor.</p>
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
<p>Copyright (c) Tyeth Gundry 2022 for Adafruit Industries. Modified (c) by Martin Ebner 2024 <a href="https://github.com/MartinEbnerSensirion">https://github.com/MartinEbnerSensirion</a></p>
<p>MIT license, all text here must be included in any redistribution. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
102 changes: 102 additions & 0 deletions html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h_source.html

Large diffs are not rendered by default.

95 changes: 95 additions & 0 deletions html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<!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>Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_VCNL4200.h File Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">Adafruit Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_3c4c7c1a85608ccd561c026bec818e51.html">components</a></li><li class="navelem"><a class="el" href="dir_4fafa5166706850f4166bb4839b0f809.html">i2c</a></li><li class="navelem"><a class="el" href="dir_fcb6e4fbca5bd9aa8323205978345f78.html">drivers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle">
<div class="title">WipperSnapper_I2C_Driver_VCNL4200.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver_8h_source.html">WipperSnapper_I2C_Driver.h</a>&quot;</code><br />
<code>#include &lt;Adafruit_VCNL4200.h&gt;</code><br />
</div>
<p><a href="_wipper_snapper___i2_c___driver___v_c_n_l4200_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<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_wipper_snapper___i2_c___driver___v_c_n_l4200.html">WipperSnapper_I2C_Driver_VCNL4200</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that provides a driver interface for a VCNL4200 sensor. <a href="class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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>Device driver for the VCNL4200 light + proximity sensor.</p>
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
<p>Copyright (c) Tyeth Gundry 2024 for Adafruit Industries.</p>
<p>MIT license, all text here must be included in any redistribution. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
88 changes: 88 additions & 0 deletions html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion html/_wippersnapper_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
<tr class="memdesc:a9a217c765d21043a2ca0fb1260ff6de1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retry a function until a condition is met or a timeout is reached. <a href="#a9a217c765d21043a2ca0fb1260ff6de1">More...</a><br /></td></tr>
<tr class="separator:a9a217c765d21043a2ca0fb1260ff6de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea527b2900703a26fe8c38d065b4f9e7"><td class="memItemLeft" align="right" valign="top"><a id="aea527b2900703a26fe8c38d065b4f9e7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_wippersnapper_8h.html#aea527b2900703a26fe8c38d065b4f9e7">WS_VERSION</a>&#160;&#160;&#160;&quot;1.0.0-beta.92&quot;</td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_wippersnapper_8h.html#aea527b2900703a26fe8c38d065b4f9e7">WS_VERSION</a>&#160;&#160;&#160;&quot;1.0.0-beta.95&quot;</td></tr>
<tr class="memdesc:aea527b2900703a26fe8c38d065b4f9e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">WipperSnapper app. version (semver-formatted) <br /></td></tr>
<tr class="separator:aea527b2900703a26fe8c38d065b4f9e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51f191d073d2da08b445e665133b5452"><td class="memItemLeft" align="right" valign="top"><a id="a51f191d073d2da08b445e665133b5452"></a>
Expand Down
192 changes: 96 additions & 96 deletions html/_wippersnapper_8h_source.html

Large diffs are not rendered by default.

58 changes: 30 additions & 28 deletions html/_wippersnapper___a_i_r_l_i_f_t_8h_source.html

Large diffs are not rendered by default.

65 changes: 63 additions & 2 deletions html/_wippersnapper___analog_i_o_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,78 @@
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Wippersnapper_AnalogIO.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_wippersnapper___analog_i_o_8h_source.html">Wippersnapper_AnalogIO.h</a>&quot;</code><br />
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a090ac9aa22bca6965e84a97ea3048bc1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_wippersnapper___analog_i_o_8cpp.html#a090ac9aa22bca6965e84a97ea3048bc1">calculateHysteresis</a> (<a class="el" href="structanalog_input_pin.html">analogInputPin</a> pin, uint16_t pinValRaw, uint16_t &amp;pinValThreshHi, uint16_t &amp;pinValThreshLow)</td></tr>
<tr class="memdesc:a090ac9aa22bca6965e84a97ea3048bc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the hysteresis for the pin value. <a href="#a090ac9aa22bca6965e84a97ea3048bc1">More...</a><br /></td></tr>
<tr class="separator:a090ac9aa22bca6965e84a97ea3048bc1"><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>This file provides an API for interacting with a board's analog IO pins.</p>
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
<p>Copyright (c) Brent Rubell 2020-2023 for Adafruit Industries.</p>
<p>BSD license, all text here must be included in any redistribution. </p>
</div></div><!-- contents -->
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a090ac9aa22bca6965e84a97ea3048bc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a090ac9aa22bca6965e84a97ea3048bc1">&#9670;&nbsp;</a></span>calculateHysteresis()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void calculateHysteresis </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structanalog_input_pin.html">analogInputPin</a>&#160;</td>
<td class="paramname"><em>pin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>pinValRaw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t &amp;&#160;</td>
<td class="paramname"><em>pinValThreshHi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t &amp;&#160;</td>
<td class="paramname"><em>pinValThreshLow</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Calculates the hysteresis for the pin value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>The desired analog pin to calculate hysteresis for. </td></tr>
<tr><td class="paramname">pinValRaw</td><td>The pin's raw value. </td></tr>
<tr><td class="paramname">pinValThreshHi</td><td>The pin's high threshold value. </td></tr>
<tr><td class="paramname">pinValThreshLow</td><td>The pin's low threshold value. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
Expand Down
Loading

0 comments on commit 3cd1f88

Please sign in to comment.