Skip to content

Commit a5e7a95

Browse files
author
Doxygen CI
committed
Deploy docs to GitHub Pages from commit 628e089
Commit: 628e089 GitHub Actions run: 9842280407
1 parent d13a0d3 commit a5e7a95

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1694
-324
lines changed

html/_wipper_snapper___i2_c_8h.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@
119119
<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 />
120120
<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 />
121121
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l4_c_d_8h_source.html">drivers/WipperSnapper_I2C_Driver_VL53L4CD.h</a>&quot;</code><br />
122+
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l4_c_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_VL53L4CX.h</a>&quot;</code><br />
122123
<code>#include &quot;<a class="el" href="_wipper_snapper___i2_c___driver___v_l6180_x_8h_source.html">drivers/WipperSnapper_I2C_Driver_VL6180X.h</a>&quot;</code><br />
123124
</div>
124125
<p><a href="_wipper_snapper___i2_c_8h_source.html">Go to the source code of this file.</a></p>

html/_wipper_snapper___i2_c_8h_source.html

Lines changed: 9 additions & 7 deletions
Large diffs are not rendered by default.
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_VL53L4CX.h File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Adafruit Library
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
<!-- window showing the filter options -->
46+
<div id="MSearchSelectWindow"
47+
onmouseover="return searchBox.OnSearchSelectShow()"
48+
onmouseout="return searchBox.OnSearchSelectHide()"
49+
onkeydown="return searchBox.OnSearchSelectKey(event)">
50+
</div>
51+
52+
<!-- iframe showing the search results (closed by default) -->
53+
<div id="MSearchResultsWindow">
54+
<iframe src="javascript:void(0)" frameborder="0"
55+
name="MSearchResults" id="MSearchResults">
56+
</iframe>
57+
</div>
58+
59+
<div id="nav-path" class="navpath">
60+
<ul>
61+
<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>
62+
</div>
63+
</div><!-- top -->
64+
<div class="header">
65+
<div class="summary">
66+
<a href="#nested-classes">Classes</a> &#124;
67+
<a href="#define-members">Macros</a> </div>
68+
<div class="headertitle">
69+
<div class="title">WipperSnapper_I2C_Driver_VL53L4CX.h File Reference</div> </div>
70+
</div><!--header-->
71+
<div class="contents">
72+
<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 />
73+
<code>#include &lt;vl53l4cx_class.h&gt;</code><br />
74+
<code>#include &lt;vl53l4cx_def.h&gt;</code><br />
75+
</div>
76+
<p><a href="_wipper_snapper___i2_c___driver___v_l53_l4_c_x_8h_source.html">Go to the source code of this file.</a></p>
77+
<table class="memberdecls">
78+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
79+
Classes</h2></td></tr>
80+
<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_l53_l4_c_x.html">WipperSnapper_I2C_Driver_VL53L4CX</a></td></tr>
81+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that provides a driver interface for a VL53L4CX sensor. <a href="class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#details">More...</a><br /></td></tr>
82+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
83+
</table><table class="memberdecls">
84+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
85+
Macros</h2></td></tr>
86+
<tr class="memitem:ad44fa2e77d74b31b52b223e1d689ff01"><td class="memItemLeft" align="right" valign="top"><a id="ad44fa2e77d74b31b52b223e1d689ff01"></a>
87+
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l4_c_x_8h.html#ad44fa2e77d74b31b52b223e1d689ff01">VL53_SHUTDOWN_PIN</a>&#160;&#160;&#160;-1</td></tr>
88+
<tr class="memdesc:ad44fa2e77d74b31b52b223e1d689ff01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shutdown pin for VL53L4CX sensor. <br /></td></tr>
89+
<tr class="separator:ad44fa2e77d74b31b52b223e1d689ff01"><td class="memSeparator" colspan="2">&#160;</td></tr>
90+
<tr class="memitem:a3567c0cfaa44521a605c51fb9f81b134"><td class="memItemLeft" align="right" valign="top"><a id="a3567c0cfaa44521a605c51fb9f81b134"></a>
91+
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l4_c_x_8h.html#a3567c0cfaa44521a605c51fb9f81b134">VL53_READING_DELAY</a>&#160;&#160;&#160;250</td></tr>
92+
<tr class="memdesc:a3567c0cfaa44521a605c51fb9f81b134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delay for reading data attempts. <br /></td></tr>
93+
<tr class="separator:a3567c0cfaa44521a605c51fb9f81b134"><td class="memSeparator" colspan="2">&#160;</td></tr>
94+
<tr class="memitem:ae6f58bfff01cb8a274f3b4320c91819e"><td class="memItemLeft" align="right" valign="top"><a id="ae6f58bfff01cb8a274f3b4320c91819e"></a>
95+
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_wipper_snapper___i2_c___driver___v_l53_l4_c_x_8h.html#ae6f58bfff01cb8a274f3b4320c91819e">VL53_TIMING_BUDGET_NS</a>&#160;&#160;&#160;200000</td></tr>
96+
<tr class="memdesc:ae6f58bfff01cb8a274f3b4320c91819e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timing budget for VL53L4CX sensor. <br /></td></tr>
97+
<tr class="separator:ae6f58bfff01cb8a274f3b4320c91819e"><td class="memSeparator" colspan="2">&#160;</td></tr>
98+
</table>
99+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
100+
<div class="textblock"><p>Device driver for the VL53L4CX ToF sensor.</p>
101+
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
102+
<p>Copyright (c) 2024 Tyeth Gundry for Adafruit Industries</p>
103+
<p>MIT license, all text here must be included in any redistribution. </p>
104+
</div></div><!-- contents -->
105+
<!-- start footer part -->
106+
<hr class="footer"/><address class="footer"><small>
107+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
108+
<img class="footer" src="doxygen.png" alt="doxygen"/>
109+
</a> 1.8.13
110+
</small></address>
111+
</body>
112+
</html>

html/_wipper_snapper___i2_c___driver___v_l53_l4_c_x_8h_source.html

Lines changed: 95 additions & 0 deletions
Large diffs are not rendered by default.

html/_wippersnapper_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
<tr class="memdesc:a217ae461d78158c231756891179debb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints debug output. <br /></td></tr>
130130
<tr class="separator:a217ae461d78158c231756891179debb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
131131
<tr class="memitem:aea527b2900703a26fe8c38d065b4f9e7"><td class="memItemLeft" align="right" valign="top"><a id="aea527b2900703a26fe8c38d065b4f9e7"></a>
132-
#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.83&quot;</td></tr>
132+
#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.85&quot;</td></tr>
133133
<tr class="memdesc:aea527b2900703a26fe8c38d065b4f9e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">WipperSnapper app. version (semver-formatted) <br /></td></tr>
134134
<tr class="separator:aea527b2900703a26fe8c38d065b4f9e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
135135
<tr class="memitem:a51f191d073d2da08b445e665133b5452"><td class="memItemLeft" align="right" valign="top"><a id="a51f191d073d2da08b445e665133b5452"></a>

html/_wippersnapper_8h_source.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

html/annotated.html

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -124,19 +124,20 @@
124124
<tr id="row_57_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wipper_snapper___i2_c___driver___v_l53_l0_x.html" target="_self">WipperSnapper_I2C_Driver_VL53L0X</a></td><td class="desc">Class that provides a driver interface for a VL53L0X sensor </td></tr>
125125
<tr id="row_58_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wipper_snapper___i2_c___driver___v_l53_l1_x.html" target="_self">WipperSnapper_I2C_Driver_VL53L1X</a></td><td class="desc">Class that provides a driver interface for a VL53L1X sensor </td></tr>
126126
<tr id="row_59_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html" target="_self">WipperSnapper_I2C_Driver_VL53L4CD</a></td><td class="desc">Class that provides a driver interface for a VL53L4CD sensor </td></tr>
127-
<tr id="row_60_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wipper_snapper___i2_c___driver___v_l6180_x.html" target="_self">WipperSnapper_I2C_Driver_VL6180X</a></td><td class="desc">Class that provides a driver interface for a VL6180X sensor </td></tr>
128-
<tr id="row_61_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wippersnapper___w_i_f_i_n_i_n_a.html" target="_self">Wippersnapper_WIFININA</a></td><td class="desc">Class for using the AirLift Co-Processor network iface </td></tr>
129-
<tr id="row_62_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__display__driver.html" target="_self">ws_display_driver</a></td><td class="desc">Display driver for LVGL and LVGL_Glue in WipperSnapper </td></tr>
130-
<tr id="row_63_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__display__ui__helper.html" target="_self">ws_display_ui_helper</a></td><td class="desc">Helps build and manage the LVGL objects and screens for the application code </td></tr>
131-
<tr id="row_64_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__ds18x20.html" target="_self">ws_ds18x20</a></td><td class="desc">Class that provides an interface with DS18X20-compatible sensors </td></tr>
132-
<tr id="row_65_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__ledc.html" target="_self">ws_ledc</a></td><td class="desc">High-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls </td></tr>
133-
<tr id="row_66_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__ledc__servo.html" target="_self">ws_ledc_servo</a></td><td class="desc">High-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the functions within the Arduino servo library, (<a href="https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h">https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h</a>) </td></tr>
134-
<tr id="row_67_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__pixels.html" target="_self">ws_pixels</a></td><td class="desc">Friend class </td></tr>
135-
<tr id="row_68_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__pwm.html" target="_self">ws_pwm</a></td><td class="desc">Interface for WipperSnapper PWM </td></tr>
136-
<tr id="row_69_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__servo.html" target="_self">ws_servo</a></td><td class="desc">Interface for WipperSnapper servo control </td></tr>
137-
<tr id="row_70_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__uart.html" target="_self">ws_uart</a></td><td class="desc">Class that provides an interface between WipperSnapper's app and the device's UART bus </td></tr>
138-
<tr id="row_71_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__uart__drv.html" target="_self">ws_uart_drv</a></td><td class="desc">Base class for UART Device Drivers </td></tr>
139-
<tr id="row_72_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__uart__drv__pm25aqi.html" target="_self">ws_uart_drv_pm25aqi</a></td><td class="desc">Class that provides an interface for a PM25 AQI UART sensor </td></tr>
127+
<tr id="row_60_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html" target="_self">WipperSnapper_I2C_Driver_VL53L4CX</a></td><td class="desc">Class that provides a driver interface for a VL53L4CX sensor </td></tr>
128+
<tr id="row_61_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wipper_snapper___i2_c___driver___v_l6180_x.html" target="_self">WipperSnapper_I2C_Driver_VL6180X</a></td><td class="desc">Class that provides a driver interface for a VL6180X sensor </td></tr>
129+
<tr id="row_62_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_wippersnapper___w_i_f_i_n_i_n_a.html" target="_self">Wippersnapper_WIFININA</a></td><td class="desc">Class for using the AirLift Co-Processor network iface </td></tr>
130+
<tr id="row_63_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__display__driver.html" target="_self">ws_display_driver</a></td><td class="desc">Display driver for LVGL and LVGL_Glue in WipperSnapper </td></tr>
131+
<tr id="row_64_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__display__ui__helper.html" target="_self">ws_display_ui_helper</a></td><td class="desc">Helps build and manage the LVGL objects and screens for the application code </td></tr>
132+
<tr id="row_65_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__ds18x20.html" target="_self">ws_ds18x20</a></td><td class="desc">Class that provides an interface with DS18X20-compatible sensors </td></tr>
133+
<tr id="row_66_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__ledc.html" target="_self">ws_ledc</a></td><td class="desc">High-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls </td></tr>
134+
<tr id="row_67_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__ledc__servo.html" target="_self">ws_ledc_servo</a></td><td class="desc">High-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the functions within the Arduino servo library, (<a href="https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h">https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h</a>) </td></tr>
135+
<tr id="row_68_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__pixels.html" target="_self">ws_pixels</a></td><td class="desc">Friend class </td></tr>
136+
<tr id="row_69_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__pwm.html" target="_self">ws_pwm</a></td><td class="desc">Interface for WipperSnapper PWM </td></tr>
137+
<tr id="row_70_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__servo.html" target="_self">ws_servo</a></td><td class="desc">Interface for WipperSnapper servo control </td></tr>
138+
<tr id="row_71_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__uart.html" target="_self">ws_uart</a></td><td class="desc">Class that provides an interface between WipperSnapper's app and the device's UART bus </td></tr>
139+
<tr id="row_72_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__uart__drv.html" target="_self">ws_uart_drv</a></td><td class="desc">Base class for UART Device Drivers </td></tr>
140+
<tr id="row_73_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classws__uart__drv__pm25aqi.html" target="_self">ws_uart_drv_pm25aqi</a></td><td class="desc">Class that provides an interface for a PM25 AQI UART sensor </td></tr>
140141
</table>
141142
</div><!-- directory -->
142143
</div><!-- contents -->

0 commit comments

Comments
 (0)