-
Notifications
You must be signed in to change notification settings - Fork 8
/
ccs811_8c.html
189 lines (186 loc) · 15.7 KB
/
ccs811_8c.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<!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.10"/>
<title>EFM32 Wonder Gecko Software Documentation: D:/jenkins-slave/workspaces/Executor-0/super/hardware/kit/common/bsp/thunderboard/ccs811.c 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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">EFM32 Wonder Gecko Software Documentation
 <span id="projectnumber">efm32wg-doc-5.1.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="../../index.html"><span>Documentation Home</span></a></li>
<li><a href="http://www.silabs.com"><span>silabs.com</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ccs811_8c.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ccs811.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Driver for the Cambridge CMOS Sensors CCS811 gas and indoor air quality sensor. </p>
<dl class="section version"><dt>Version</dt><dd>5.1.1</dd></dl>
<h1><a class="anchor" id="License"></a>
License</h1>
<p><b>Copyright 2016 Silicon Laboratories, Inc. <a href="http://www.silabs.com">http://www.silabs.com</a></b></p>
<p>This file is licensed under the Silicon Labs License Agreement. See the file "Silabs_License_Agreement.txt" for details. Before using this software for any purpose, you must agree to the terms of that agreement. </p>
<p>Definition in file <a class="el" href="ccs811_8c_source.html">ccs811.c</a>.</p>
</div><div class="textblock"><code>#include <stddef.h></code><br />
<code>#include <stdio.h></code><br />
<code>#include <string.h></code><br />
<code>#include <stdarg.h></code><br />
<code>#include "<a class="el" href="i2cspm_8h_source.html">i2cspm.h</a>"</code><br />
<code>#include "<a class="el" href="board_8h_source.html">thunderboard/board.h</a>"</code><br />
<code>#include "<a class="el" href="ccs811_8h_source.html">thunderboard/ccs811.h</a>"</code><br />
<code>#include "<a class="el" href="util_8h_source.html">thunderboard/util.h</a>"</code><br />
<code>#include "<a class="el" href="rfs_8h_source.html">thunderboard/rfs/rfs.h</a>"</code><br />
</div>
<p><a href="ccs811_8c_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabc37b116104161902f935506645b6abd"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#gabc37b116104161902f935506645b6abd">CCS811_deInit</a> (void)</td></tr>
<tr class="memdesc:gabc37b116104161902f935506645b6abd"><td class="mdescLeft"> </td><td class="mdescRight">De-initializes the chip. <a href="group__CCS811__Functions.html#gabc37b116104161902f935506645b6abd">More...</a><br /></td></tr>
<tr class="separator:gabc37b116104161902f935506645b6abd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab41b4edcd37aae35f18a39fc18e8fcb8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#gab41b4edcd37aae35f18a39fc18e8fcb8">CCS811_dumpRegisters</a> (void)</td></tr>
<tr class="memdesc:gab41b4edcd37aae35f18a39fc18e8fcb8"><td class="mdescLeft"> </td><td class="mdescRight">Dumps the registers of the CSS811. <a href="group__CCS811__Functions.html#gab41b4edcd37aae35f18a39fc18e8fcb8">More...</a><br /></td></tr>
<tr class="separator:gab41b4edcd37aae35f18a39fc18e8fcb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f73eaf705f252dfbf403dad92c43273"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga3f73eaf705f252dfbf403dad92c43273">CCS811_getHardwareID</a> (uint8_t *hardwareID)</td></tr>
<tr class="memdesc:ga3f73eaf705f252dfbf403dad92c43273"><td class="mdescLeft"> </td><td class="mdescRight">Reads Hardware ID from the CSS811 sensor. <a href="group__CCS811__Functions.html#ga3f73eaf705f252dfbf403dad92c43273">More...</a><br /></td></tr>
<tr class="separator:ga3f73eaf705f252dfbf403dad92c43273"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8893332e901677821d2d8c34e363456"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#gad8893332e901677821d2d8c34e363456">CCS811_getMeasurement</a> (uint16_t *eco2, uint16_t *tvoc)</td></tr>
<tr class="memdesc:gad8893332e901677821d2d8c34e363456"><td class="mdescLeft"> </td><td class="mdescRight">Reads measurement data (eCO2 and TVOC) from the CSS811 sensor. <a href="group__CCS811__Functions.html#gad8893332e901677821d2d8c34e363456">More...</a><br /></td></tr>
<tr class="separator:gad8893332e901677821d2d8c34e363456"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4707986e7a01d2d7007a026e481ecce9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga4707986e7a01d2d7007a026e481ecce9">CCS811_getRawData</a> (uint16_t *current, uint16_t *rawData)</td></tr>
<tr class="memdesc:ga4707986e7a01d2d7007a026e481ecce9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the latest readings from the sense resistor of the CSS811 sensor. <a href="group__CCS811__Functions.html#ga4707986e7a01d2d7007a026e481ecce9">More...</a><br /></td></tr>
<tr class="separator:ga4707986e7a01d2d7007a026e481ecce9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b11cbe45c7c485896543cd52eceeb70"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga2b11cbe45c7c485896543cd52eceeb70">CCS811_getStatus</a> (uint8_t *status)</td></tr>
<tr class="memdesc:ga2b11cbe45c7c485896543cd52eceeb70"><td class="mdescLeft"> </td><td class="mdescRight">Reads the status of the CSS811 sensor. <a href="group__CCS811__Functions.html#ga2b11cbe45c7c485896543cd52eceeb70">More...</a><br /></td></tr>
<tr class="separator:ga2b11cbe45c7c485896543cd52eceeb70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga71c64281890a3912cd8a385da2b7a5f3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga71c64281890a3912cd8a385da2b7a5f3">CCS811_init</a> (void)</td></tr>
<tr class="memdesc:ga71c64281890a3912cd8a385da2b7a5f3"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the chip and performs firmware upgrade if required. <a href="group__CCS811__Functions.html#ga71c64281890a3912cd8a385da2b7a5f3">More...</a><br /></td></tr>
<tr class="separator:ga71c64281890a3912cd8a385da2b7a5f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d568895235caabc7e65ba72ba8c212f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga8d568895235caabc7e65ba72ba8c212f">CCS811_isDataAvailable</a> (void)</td></tr>
<tr class="memdesc:ga8d568895235caabc7e65ba72ba8c212f"><td class="mdescLeft"> </td><td class="mdescRight">Checks if new measurement data available. <a href="group__CCS811__Functions.html#ga8d568895235caabc7e65ba72ba8c212f">More...</a><br /></td></tr>
<tr class="separator:ga8d568895235caabc7e65ba72ba8c212f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2856a529c8e7ee8f9e4801a9e8ba5da"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#gac2856a529c8e7ee8f9e4801a9e8ba5da">CCS811_readMailbox</a> (uint8_t id, uint8_t length, uint8_t *data)</td></tr>
<tr class="memdesc:gac2856a529c8e7ee8f9e4801a9e8ba5da"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from a specific Mailbox address. <a href="group__CCS811__Functions.html#gac2856a529c8e7ee8f9e4801a9e8ba5da">More...</a><br /></td></tr>
<tr class="separator:gac2856a529c8e7ee8f9e4801a9e8ba5da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad24d4432c2086e66e94b657bce181dc6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#gad24d4432c2086e66e94b657bce181dc6">CCS811_setEnvData</a> (int32_t tempData, uint32_t rhData)</td></tr>
<tr class="memdesc:gad24d4432c2086e66e94b657bce181dc6"><td class="mdescLeft"> </td><td class="mdescRight">Writes temperature and humidity values to the environmental data regs. <a href="group__CCS811__Functions.html#gad24d4432c2086e66e94b657bce181dc6">More...</a><br /></td></tr>
<tr class="separator:gad24d4432c2086e66e94b657bce181dc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga34d79d2e5e1fbfae0fdeef4cf915dc13"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga34d79d2e5e1fbfae0fdeef4cf915dc13">CCS811_setMeasureMode</a> (uint8_t measMode)</td></tr>
<tr class="memdesc:ga34d79d2e5e1fbfae0fdeef4cf915dc13"><td class="mdescLeft"> </td><td class="mdescRight">Sets the measurement mode of the CSS811 sensor. <a href="group__CCS811__Functions.html#ga34d79d2e5e1fbfae0fdeef4cf915dc13">More...</a><br /></td></tr>
<tr class="separator:ga34d79d2e5e1fbfae0fdeef4cf915dc13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga93e74f1737c119efa48169e8125ad987"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#ga93e74f1737c119efa48169e8125ad987">CCS811_softwareReset</a> (void)</td></tr>
<tr class="memdesc:ga93e74f1737c119efa48169e8125ad987"><td class="mdescLeft"> </td><td class="mdescRight">Performs software reset on the CCS811. <a href="group__CCS811__Functions.html#ga93e74f1737c119efa48169e8125ad987">More...</a><br /></td></tr>
<tr class="separator:ga93e74f1737c119efa48169e8125ad987"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3073e2377ca3bc8dd9ee596529b345d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CCS811__Functions.html#gab3073e2377ca3bc8dd9ee596529b345d">CCS811_startApplication</a> (void)</td></tr>
<tr class="memdesc:gab3073e2377ca3bc8dd9ee596529b345d"><td class="mdescLeft"> </td><td class="mdescRight">Switches the CSS811 chip from boot to application mode. <a href="group__CCS811__Functions.html#gab3073e2377ca3bc8dd9ee596529b345d">More...</a><br /></td></tr>
<tr class="separator:gab3073e2377ca3bc8dd9ee596529b345d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_47b141814df81f488c4f7eaff9a67e18.html">hardware</a></li><li class="navelem"><a class="el" href="dir_af96359f81902c5c0c02a782680fb1d9.html">kit</a></li><li class="navelem"><a class="el" href="dir_5d4a48348b1da31968333dd38c7667cf.html">common</a></li><li class="navelem"><a class="el" href="dir_3e04ba8f218ed53a3ee016a950b479cb.html">bsp</a></li><li class="navelem"><a class="el" href="dir_5cc8de40f40a2d288158d80f3858cae7.html">thunderboard</a></li><li class="navelem"><a class="el" href="ccs811_8c.html">ccs811.c</a></li>
<li class="footer">Generated on Thu Mar 9 2017 20:38:50 for EFM32 Wonder Gecko Software Documentation by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
</ul>
</div>
</body>
</html>