-
Notifications
You must be signed in to change notification settings - Fork 0
/
_logic_8cpp.html
196 lines (186 loc) · 12.4 KB
/
_logic_8cpp.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
<!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/Logic.cpp 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('_logic_8cpp.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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Logic.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="_logic_8h_source.html">Logic.h</a>"</code><br />
<code>#include "<a class="el" href="_configuration_8h_source.html">Configuration.h</a>"</code><br />
<code>#include "<a class="el" href="_display_8h_source.html">Display.h</a>"</code><br />
<code>#include "<a class="el" href="_hardware_8h_source.html">Hardware.h</a>"</code><br />
<code>#include "<a class="el" href="_logger_8h_source.html">Logger.h</a>"</code><br />
<code>#include "<a class="el" href="_settings_8h_source.html">Settings.h</a>"</code><br />
<code>#include "<a class="el" href="_tool_8h_source.html">Tool.h</a>"</code><br />
<code>#include <avr/cpufunc.h></code><br />
<code>#include <avr/interrupt.h></code><br />
<code>#include <avr/pgmspace.h></code><br />
<code>#include <avr/sleep.h></code><br />
</div>
<p><a href="_logic_8cpp_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_logic"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html">Logic</a></td></tr>
<tr class="memdesc:namespace_logic"><td class="mdescLeft"> </td><td class="mdescRight">This module contains the logic of the firmware. <br /></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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a60d5eb696e1c7b126bf69abb665bcda0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html#a60d5eb696e1c7b126bf69abb665bcda0">Logic::UserAction</a> : uint8_t { <a class="el" href="namespace_logic.html#a60d5eb696e1c7b126bf69abb665bcda0a095597b4573534346fb66eebf09622c6">Logic::UA_None</a>,
<a class="el" href="namespace_logic.html#a60d5eb696e1c7b126bf69abb665bcda0a1f9f63555d244e63a7dd521bfa979f37">Logic::UA_NewSetPoint</a>,
<a class="el" href="namespace_logic.html#a60d5eb696e1c7b126bf69abb665bcda0a5ff271f7393530eb2384274ce26634ff">Logic::UA_DisableFlash</a>
}<tr class="memdesc:a60d5eb696e1c7b126bf69abb665bcda0"><td class="mdescLeft"> </td><td class="mdescRight">The action the user would like to do. <a href="namespace_logic.html#a60d5eb696e1c7b126bf69abb665bcda0">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a60d5eb696e1c7b126bf69abb665bcda0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad892031f473e8f9f3f27f70bba576d87"><td class="memItemLeft" align="right" valign="top">UserAction </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html#ad892031f473e8f9f3f27f70bba576d87">Logic::getUserAction</a> ()</td></tr>
<tr class="memdesc:ad892031f473e8f9f3f27f70bba576d87"><td class="mdescLeft"> </td><td class="mdescRight">Wait for the button release to get the selected user action. <a href="namespace_logic.html#ad892031f473e8f9f3f27f70bba576d87">More...</a><br /></td></tr>
<tr class="separator:ad892031f473e8f9f3f27f70bba576d87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0661d1556f3ce4188ed7b261bfb1779e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html#a0661d1556f3ce4188ed7b261bfb1779e">Logic::configurationMode</a> ()</td></tr>
<tr class="memdesc:a0661d1556f3ce4188ed7b261bfb1779e"><td class="mdescLeft"> </td><td class="mdescRight">The configuration mode. <a href="namespace_logic.html#a0661d1556f3ce4188ed7b261bfb1779e">More...</a><br /></td></tr>
<tr class="separator:a0661d1556f3ce4188ed7b261bfb1779e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a186b85b61134b0357b9050054f09d349"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html#a186b85b61134b0357b9050054f09d349">Logic::testMode</a> ()</td></tr>
<tr class="memdesc:a186b85b61134b0357b9050054f09d349"><td class="mdescLeft"> </td><td class="mdescRight">The test mode. <a href="namespace_logic.html#a186b85b61134b0357b9050054f09d349">More...</a><br /></td></tr>
<tr class="separator:a186b85b61134b0357b9050054f09d349"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a414bdba753d4d17cb9d999eacfbf2142"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html#a414bdba753d4d17cb9d999eacfbf2142">Logic::main</a> ()</td></tr>
<tr class="memdesc:a414bdba753d4d17cb9d999eacfbf2142"><td class="mdescLeft"> </td><td class="mdescRight">The main loop of the firmware. <a href="namespace_logic.html#a414bdba753d4d17cb9d999eacfbf2142">More...</a><br /></td></tr>
<tr class="separator:a414bdba753d4d17cb9d999eacfbf2142"><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:a6d4cb5c6b4efebaf0255c1cc0aa00615"><td class="memItemLeft" align="right" valign="top">volatile uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_logic_8cpp.html#a6d4cb5c6b4efebaf0255c1cc0aa00615">currentVoltage</a> = 0</td></tr>
<tr class="memdesc:a6d4cb5c6b4efebaf0255c1cc0aa00615"><td class="mdescLeft"> </td><td class="mdescRight">The current voltage value. <a href="#a6d4cb5c6b4efebaf0255c1cc0aa00615">More...</a><br /></td></tr>
<tr class="separator:a6d4cb5c6b4efebaf0255c1cc0aa00615"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53a4dab4ade4ba46aa0ff4aea05777f4"><td class="memItemLeft" align="right" valign="top">volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_logic_8cpp.html#a53a4dab4ade4ba46aa0ff4aea05777f4">currentOscillatorFrequency</a> = 0</td></tr>
<tr class="memdesc:a53a4dab4ade4ba46aa0ff4aea05777f4"><td class="mdescLeft"> </td><td class="mdescRight">The current oscillator frequency. <a href="#a53a4dab4ade4ba46aa0ff4aea05777f4">More...</a><br /></td></tr>
<tr class="separator:a53a4dab4ade4ba46aa0ff4aea05777f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75a7f23fd444fbc4362bdcdb7c592db9"><td class="memItemLeft" align="right" valign="top">const char cFirmwareSignature [] </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_logic.html#a75a7f23fd444fbc4362bdcdb7c592db9">Logic::PROGMEM</a> = "FW" LR_FIRMWARE_VERSION ":LuckyResistor"</td></tr>
<tr class="memdesc:a75a7f23fd444fbc4362bdcdb7c592db9"><td class="mdescLeft"> </td><td class="mdescRight">A message for the release version written into the image. <a href="namespace_logic.html#a75a7f23fd444fbc4362bdcdb7c592db9">More...</a><br /></td></tr>
<tr class="separator:a75a7f23fd444fbc4362bdcdb7c592db9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a53a4dab4ade4ba46aa0ff4aea05777f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53a4dab4ade4ba46aa0ff4aea05777f4">◆ </a></span>currentOscillatorFrequency</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile uint8_t currentOscillatorFrequency = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>The current oscillator frequency. </p>
<p class="definition">Definition at line <a class="el" href="_logic_8cpp_source.html#l00045">45</a> of file <a class="el" href="_logic_8cpp_source.html">Logic.cpp</a>.</p>
</div>
</div>
<a id="a6d4cb5c6b4efebaf0255c1cc0aa00615"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d4cb5c6b4efebaf0255c1cc0aa00615">◆ </a></span>currentVoltage</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile uint16_t currentVoltage = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>The current voltage value. </p>
<p class="definition">Definition at line <a class="el" href="_logic_8cpp_source.html#l00041">41</a> of file <a class="el" href="_logic_8cpp_source.html">Logic.cpp</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="_logic_8cpp.html">Logic.cpp</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>