-
Notifications
You must be signed in to change notification settings - Fork 0
/
_configuration_8h.html
203 lines (197 loc) · 19.3 KB
/
_configuration_8h.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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!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>Plant Watering Sensor: src/Configuration.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="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);
</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">Plant Watering Sensor
</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>
</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('_configuration_8h.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="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Configuration.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <stdint.h></code><br />
<code>#include <stdbool.h></code><br />
</div>
<p><a href="_configuration_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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_configuration"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html">Configuration</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a064e561242ccd1db0dd9b4a1792f95de"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_configuration_8h.html#a064e561242ccd1db0dd9b4a1792f95de">LR_FIRMWARE_VERSION</a>   "1.0"</td></tr>
<tr class="memdesc:a064e561242ccd1db0dd9b4a1792f95de"><td class="mdescLeft"> </td><td class="mdescRight">The firmware version. <a href="#a064e561242ccd1db0dd9b4a1792f95de">More...</a><br /></td></tr>
<tr class="separator:a064e561242ccd1db0dd9b4a1792f95de"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aef23da168dec47bc03bc136d899c2bf4"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#aef23da168dec47bc03bc136d899c2bf4">Configuration::cMinimumVoltageValue</a> = 550u</td></tr>
<tr class="memdesc:aef23da168dec47bc03bc136d899c2bf4"><td class="mdescLeft"> </td><td class="mdescRight">The minimum voltage value. <a href="namespace_configuration.html#aef23da168dec47bc03bc136d899c2bf4">More...</a><br /></td></tr>
<tr class="separator:aef23da168dec47bc03bc136d899c2bf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac441b1a2997f4ce8efe37e770f7bf6f0"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#ac441b1a2997f4ce8efe37e770f7bf6f0">Configuration::cTestVoltageValue</a> = 900u</td></tr>
<tr class="memdesc:ac441b1a2997f4ce8efe37e770f7bf6f0"><td class="mdescLeft"> </td><td class="mdescRight">The test voltage value. <a href="namespace_configuration.html#ac441b1a2997f4ce8efe37e770f7bf6f0">More...</a><br /></td></tr>
<tr class="separator:ac441b1a2997f4ce8efe37e770f7bf6f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00ab8d52f3716e5d5b9f8bbbe2ad32ad"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a00ab8d52f3716e5d5b9f8bbbe2ad32ad">Configuration::cTestHighOscillator</a> = 160u</td></tr>
<tr class="memdesc:a00ab8d52f3716e5d5b9f8bbbe2ad32ad"><td class="mdescLeft"> </td><td class="mdescRight">Test value for air. <a href="namespace_configuration.html#a00ab8d52f3716e5d5b9f8bbbe2ad32ad">More...</a><br /></td></tr>
<tr class="separator:a00ab8d52f3716e5d5b9f8bbbe2ad32ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fcdf399b8f117e31509298e835f248a"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a8fcdf399b8f117e31509298e835f248a">Configuration::cTestLowOscillator</a> = 100u</td></tr>
<tr class="memdesc:a8fcdf399b8f117e31509298e835f248a"><td class="mdescLeft"> </td><td class="mdescRight">Test value for glass of water. <a href="namespace_configuration.html#a8fcdf399b8f117e31509298e835f248a">More...</a><br /></td></tr>
<tr class="separator:a8fcdf399b8f117e31509298e835f248a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae323c955d4c4cc8ea07f096a8bd6c196"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#ae323c955d4c4cc8ea07f096a8bd6c196">Configuration::cDisplayFlashDurationMs</a> = 40</td></tr>
<tr class="memdesc:ae323c955d4c4cc8ea07f096a8bd6c196"><td class="mdescLeft"> </td><td class="mdescRight">The flash duration. <a href="namespace_configuration.html#ae323c955d4c4cc8ea07f096a8bd6c196">More...</a><br /></td></tr>
<tr class="separator:ae323c955d4c4cc8ea07f096a8bd6c196"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e254631d5a6c3ba0e209bc59ef44c89"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a2e254631d5a6c3ba0e209bc59ef44c89">Configuration::cDisplayFlashPauseMs</a> = 100</td></tr>
<tr class="memdesc:a2e254631d5a6c3ba0e209bc59ef44c89"><td class="mdescLeft"> </td><td class="mdescRight">The pause between two flashes. <a href="namespace_configuration.html#a2e254631d5a6c3ba0e209bc59ef44c89">More...</a><br /></td></tr>
<tr class="separator:a2e254631d5a6c3ba0e209bc59ef44c89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a9f9d2b0a4cf56331bea54ddd6c696d"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a2a9f9d2b0a4cf56331bea54ddd6c696d">Configuration::cDisplayPulseMaximumPwm</a> = 60</td></tr>
<tr class="memdesc:a2a9f9d2b0a4cf56331bea54ddd6c696d"><td class="mdescLeft"> </td><td class="mdescRight">The maximum PWM for a pulse. <a href="namespace_configuration.html#a2a9f9d2b0a4cf56331bea54ddd6c696d">More...</a><br /></td></tr>
<tr class="separator:a2a9f9d2b0a4cf56331bea54ddd6c696d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07faa722b5c01f55e642fe860cb01b6c"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a07faa722b5c01f55e642fe860cb01b6c">Configuration::cDisplayPulseCyclesPerLevel</a> = 20</td></tr>
<tr class="memdesc:a07faa722b5c01f55e642fe860cb01b6c"><td class="mdescLeft"> </td><td class="mdescRight">The number of cycles for each PWM level. <a href="namespace_configuration.html#a07faa722b5c01f55e642fe860cb01b6c">More...</a><br /></td></tr>
<tr class="separator:a07faa722b5c01f55e642fe860cb01b6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf6d0fa8593143bb92a896ce0129a5de"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#adf6d0fa8593143bb92a896ce0129a5de">Configuration::cDisplayDimSignalPwm</a> = 50</td></tr>
<tr class="memdesc:adf6d0fa8593143bb92a896ce0129a5de"><td class="mdescLeft"> </td><td class="mdescRight">The PWM value for the dim signal. <a href="namespace_configuration.html#adf6d0fa8593143bb92a896ce0129a5de">More...</a><br /></td></tr>
<tr class="separator:adf6d0fa8593143bb92a896ce0129a5de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab460d63ac5617b20b30082022c6f4aac"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#ab460d63ac5617b20b30082022c6f4aac">Configuration::cDisplayDimSignalCycles</a> = 600</td></tr>
<tr class="memdesc:ab460d63ac5617b20b30082022c6f4aac"><td class="mdescLeft"> </td><td class="mdescRight">The duration of the dim signal. <a href="namespace_configuration.html#ab460d63ac5617b20b30082022c6f4aac">More...</a><br /></td></tr>
<tr class="separator:ab460d63ac5617b20b30082022c6f4aac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a78b990c56b9029f095711e22572e4c"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a6a78b990c56b9029f095711e22572e4c">Configuration::cLogicPulsesForUserAction</a> = 5</td></tr>
<tr class="memdesc:a6a78b990c56b9029f095711e22572e4c"><td class="mdescLeft"> </td><td class="mdescRight">The number of pulses for the selection of the user action. <a href="namespace_configuration.html#a6a78b990c56b9029f095711e22572e4c">More...</a><br /></td></tr>
<tr class="separator:a6a78b990c56b9029f095711e22572e4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60e1dfbae210f0d22114c20b2acfa53d"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a60e1dfbae210f0d22114c20b2acfa53d">Configuration::cDefaultSetPointFrequency</a> = 170</td></tr>
<tr class="memdesc:a60e1dfbae210f0d22114c20b2acfa53d"><td class="mdescLeft"> </td><td class="mdescRight">The default set-point value if none is set. <a href="namespace_configuration.html#a60e1dfbae210f0d22114c20b2acfa53d">More...</a><br /></td></tr>
<tr class="separator:a60e1dfbae210f0d22114c20b2acfa53d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2dad644fa10548ed4a2ad556c57ac73a"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a2dad644fa10548ed4a2ad556c57ac73a">Configuration::cDisabledSetPointFrequency</a> = 200</td></tr>
<tr class="memdesc:a2dad644fa10548ed4a2ad556c57ac73a"><td class="mdescLeft"> </td><td class="mdescRight">The set-point value if the user disabled it. <a href="namespace_configuration.html#a2dad644fa10548ed4a2ad556c57ac73a">More...</a><br /></td></tr>
<tr class="separator:a2dad644fa10548ed4a2ad556c57ac73a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42ebb5740c91dcdb2a4e94b1d0e1b7a0"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a42ebb5740c91dcdb2a4e94b1d0e1b7a0">Configuration::cSetPointCompensation</a> = 5</td></tr>
<tr class="memdesc:a42ebb5740c91dcdb2a4e94b1d0e1b7a0"><td class="mdescLeft"> </td><td class="mdescRight">Set-point compensation for human touch of the button. <a href="namespace_configuration.html#a42ebb5740c91dcdb2a4e94b1d0e1b7a0">More...</a><br /></td></tr>
<tr class="separator:a42ebb5740c91dcdb2a4e94b1d0e1b7a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Testing options.</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Options used to enable or disable various test functionality. </p>
</div></td></tr>
<tr class="memitem:a7bf5b2db20f207c607f540c10a7163d0"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a7bf5b2db20f207c607f540c10a7163d0">Configuration::cPowerSave</a> = true</td></tr>
<tr class="memdesc:a7bf5b2db20f207c607f540c10a7163d0"><td class="mdescLeft"> </td><td class="mdescRight">This flag controls if the times, etc. <a href="namespace_configuration.html#a7bf5b2db20f207c607f540c10a7163d0">More...</a><br /></td></tr>
<tr class="separator:a7bf5b2db20f207c607f540c10a7163d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a7b056781375b07952b9fd0417c980e"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a7a7b056781375b07952b9fd0417c980e">Configuration::cTestLoopEnabled</a> = false</td></tr>
<tr class="memdesc:a7a7b056781375b07952b9fd0417c980e"><td class="mdescLeft"> </td><td class="mdescRight">This flag enables the test loop, which never stops but runs the logic in a loop. <a href="namespace_configuration.html#a7a7b056781375b07952b9fd0417c980e">More...</a><br /></td></tr>
<tr class="separator:a7a7b056781375b07952b9fd0417c980e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43dbb9b69ec9a6a0209e8a098a21cd65"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a43dbb9b69ec9a6a0209e8a098a21cd65">Configuration::cTestModeEnabled</a> = true</td></tr>
<tr class="memdesc:a43dbb9b69ec9a6a0209e8a098a21cd65"><td class="mdescLeft"> </td><td class="mdescRight">This flag enables the test mode which is activated with a 4V VCC voltage. <a href="namespace_configuration.html#a43dbb9b69ec9a6a0209e8a098a21cd65">More...</a><br /></td></tr>
<tr class="separator:a43dbb9b69ec9a6a0209e8a098a21cd65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42fafe59219c7dfa0a012b5655498bcd"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a42fafe59219c7dfa0a012b5655498bcd">Configuration::cConfigurationModeEnabled</a> = true</td></tr>
<tr class="memdesc:a42fafe59219c7dfa0a012b5655498bcd"><td class="mdescLeft"> </td><td class="mdescRight">This flag enables the configuration mode. <a href="namespace_configuration.html#a42fafe59219c7dfa0a012b5655498bcd">More...</a><br /></td></tr>
<tr class="separator:a42fafe59219c7dfa0a012b5655498bcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0fa539ea0cbc3afa0d0e5f00d6e12f37"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a0fa539ea0cbc3afa0d0e5f00d6e12f37">Configuration::cLoggingEnabled</a> = false</td></tr>
<tr class="memdesc:a0fa539ea0cbc3afa0d0e5f00d6e12f37"><td class="mdescLeft"> </td><td class="mdescRight">This flag enables logging of the last 10 values into SRAM. <a href="namespace_configuration.html#a0fa539ea0cbc3afa0d0e5f00d6e12f37">More...</a><br /></td></tr>
<tr class="separator:a0fa539ea0cbc3afa0d0e5f00d6e12f37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40e76b37292c7825190b5dcbdcbc49a3"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_configuration.html#a40e76b37292c7825190b5dcbdcbc49a3">Configuration::cFirmwareSignatureEnabled</a> = true</td></tr>
<tr class="memdesc:a40e76b37292c7825190b5dcbdcbc49a3"><td class="mdescLeft"> </td><td class="mdescRight">This flag enables the firmware signature text. <a href="namespace_configuration.html#a40e76b37292c7825190b5dcbdcbc49a3">More...</a><br /></td></tr>
<tr class="separator:a40e76b37292c7825190b5dcbdcbc49a3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a064e561242ccd1db0dd9b4a1792f95de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a064e561242ccd1db0dd9b4a1792f95de">◆ </a></span>LR_FIRMWARE_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LR_FIRMWARE_VERSION   "1.0"</td>
</tr>
</table>
</div><div class="memdoc">
<p>The firmware version. </p>
<p class="definition">Definition at line <a class="el" href="_configuration_8h_source.html#l00126">126</a> of file <a class="el" href="_configuration_8h_source.html">Configuration.h</a>.</p>
</div>
</div>
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_configuration_8h.html">Configuration.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>