Skip to content

Commit 580c996

Browse files
PaulZCPaulZC
committed
Updates after testing on hardware. Add Doxygen docs.
1 parent c52cb53 commit 580c996

File tree

94 files changed

+10121
-75
lines changed

Some content is hidden

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

94 files changed

+10121
-75
lines changed

‎Doxyfile

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

‎README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ This library handles the initialization and configuration of the sensor, and mon
1919

2020
## Documentation
2121

22-
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
22+
- **/docs** - HTML documentation generated with [Doxygen](https://www.doxygen.nl/index.html). Open [**GitHub Pages**](https://sparkfun.github.io/SparkFun_VEML7700_Arduino_Library/) to view the documentation.
23+
- **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
2324

2425
## Products That Use This Library
2526

‎docs/_spark_fun___v_e_m_l7700___arduino___library_8h.html

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

‎docs/_spark_fun___v_e_m_l7700___arduino___library_8h_source.html

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

‎docs/annotated.html

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>SparkFun_VEML7700_Arduino_Library: Class List</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">SparkFun_VEML7700_Arduino_Library
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
</div><!-- top -->
49+
<!-- window showing the filter options -->
50+
<div id="MSearchSelectWindow"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
onkeydown="return searchBox.OnSearchSelectKey(event)">
54+
</div>
55+
56+
<!-- iframe showing the search results (closed by default) -->
57+
<div id="MSearchResultsWindow">
58+
<iframe src="javascript:void(0)" frameborder="0"
59+
name="MSearchResults" id="MSearchResults">
60+
</iframe>
61+
</div>
62+
63+
<div class="header">
64+
<div class="headertitle">
65+
<div class="title">Class List</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
69+
<table class="directory">
70+
<tr id="row_0_" 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_v_e_m_l7700.html" target="_self">VEML7700</a></td><td class="desc"></td></tr>
71+
</table>
72+
</div><!-- directory -->
73+
</div><!-- contents -->
74+
<!-- start footer part -->
75+
<hr class="footer"/><address class="footer"><small>
76+
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.1
77+
</small></address>
78+
</body>
79+
</html>

‎docs/bc_s.png

676 Bytes
Loading

‎docs/bdwn.png

147 Bytes
Loading

‎docs/class_v_e_m_l7700-members.html

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>SparkFun_VEML7700_Arduino_Library: Member List</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">SparkFun_VEML7700_Arduino_Library
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
</div><!-- top -->
63+
<div class="header">
64+
<div class="headertitle">
65+
<div class="title">VEML7700 Member List</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
69+
<p>This is the complete list of members for <a class="el" href="class_v_e_m_l7700.html">VEML7700</a>, including all inherited members.</p>
70+
<table class="directory">
71+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#af40c061e72722295c3b31f27006055d7">begin</a>(TwoWire &amp;wirePort=Wire)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
72+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ad0925d35229ca65e98ad79a6c54c528f">disableDebugging</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
73+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a257e7d2a70bb940ce89d5c41bbbeeed5">enableDebugging</a>(Stream &amp;debugPort=Serial)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
74+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ae95aba5a71a08dff4f83aafb43a4515c">getAmbientLight</a>(uint16_t *ambient)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
75+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a93257c7adaa80864434bc6d41ad5c2d9">getAmbientLight</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
76+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a527b11af4d2816894e1db4ba710128b5">getHighThreshold</a>(uint16_t *threshold)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
77+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ad7d4ee449edfe1b6ccbe5ae677e2284a">getHighThreshold</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
78+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#abdfee8e09a34d9d7d965107147bf0ccc">getIntegrationTime</a>(VEML7700_integration_time_t *it)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
79+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#aa471e0f323c352295c653555de7c70b4">getIntegrationTime</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
80+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#aa83b00355c032ff3325c88187b74df40">getIntegrationTimeStr</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
81+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a6c48807c2f8168b8399a51bcfc3a14d4">getInterruptEnable</a>(VEML7700_interrupt_enable_t *ie)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
82+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a0e105e71ef9ee97f9ad88f44473dfd7d">getInterruptEnable</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
83+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a6fe90efe56ba98524b24bf35949b0cfc">getInterruptStatus</a>(VEML7700_interrupt_status_t *status)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
84+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a8249c59c8e66542ee002eaed2e29ed2e">getInterruptStatus</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
85+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a2dd309f78a3dca06c355286ec2c9d691">getLowThreshold</a>(uint16_t *threshold)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
86+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a3b2a4fae6441bd66bd282f17beaaadef">getLowThreshold</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
87+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a1719f02916aa332b6f38e79f2d312405">getLux</a>(float *lux)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
88+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ae0e25719d1dbd6165b39ab8693f963a1">getLux</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
89+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#afc21b11579aacde3eff53844b3f467b1">getPersistenceProtect</a>(VEML7700_persistence_protect_t *pp)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
90+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ae771283dd0ae800bf7194269d54963ea">getPersistenceProtect</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
91+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a056fc278531b54f0de0b5537c2e800ba">getPersistenceProtectStr</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
92+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a842bda613a4ec10da7e581e50c0b6563">getSensitivityMode</a>(VEML7700_sensitivity_mode_t *sm)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
93+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#aceb451c7600bf509bdd8b12381c4e35e">getSensitivityMode</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
94+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#abe744baacfb5483399820e479571aa9b">getSensitivityModeStr</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
95+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#aeb9f3b00c0ebd1297582f1e246007d94">getShutdown</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
96+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a6a0894ae44f1c43828e8a7bdd36822b2">getWhiteLevel</a>(uint16_t *whiteLevel)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
97+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ad172929df5518eec27201fce0b17a763">getWhiteLevel</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
98+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ac42b5cbc866aa31ba3e2ed1330c68559">isConnected</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
99+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>powerOn</b>() (defined in <a class="el" href="class_v_e_m_l7700.html">VEML7700</a>)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
100+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a5a81f9bf4cf77922723819e406c7b107">setHighThreshold</a>(uint16_t threshold)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
101+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a8b65876ae4dc75c61831ca4e40beec7e">setIntegrationTime</a>(VEML7700_integration_time_t it)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
102+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a0aba999e5b3fd5b6e7658b2a27c06874">setInterruptEnable</a>(VEML7700_interrupt_enable_t ie)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
103+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a2dff042bdb48ee0524133a7f69e59613">setLowThreshold</a>(uint16_t threshold)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
104+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ae3b8c92425867e0dccc8c0393a3f7b95">setPersistenceProtect</a>(VEML7700_persistence_protect_t pp)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
105+
<tr class="even"><td class="entry"><a class="el" href="class_v_e_m_l7700.html#ae7146ad656795a542e5c489aef9a12f5">setSensitivityMode</a>(VEML7700_sensitivity_mode_t sm)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
106+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a116075e77dfc702e40f282d8281f51e8">setShutdown</a>(VEML7700_shutdown_t)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
107+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>shutdown</b>() (defined in <a class="el" href="class_v_e_m_l7700.html">VEML7700</a>)</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
108+
<tr><td class="entry"><a class="el" href="class_v_e_m_l7700.html#a4f782190e7b6d4e8467f30c36dc27070">VEML7700</a>()</td><td class="entry"><a class="el" href="class_v_e_m_l7700.html">VEML7700</a></td><td class="entry"></td></tr>
109+
</table></div><!-- contents -->
110+
<!-- start footer part -->
111+
<hr class="footer"/><address class="footer"><small>
112+
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.1
113+
</small></address>
114+
</body>
115+
</html>

0 commit comments

Comments
 (0)