-
Notifications
You must be signed in to change notification settings - Fork 0
/
namespace_settings.html
375 lines (338 loc) · 33.2 KB
/
namespace_settings.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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<!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: Settings Namespace 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('namespace_settings.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="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Settings Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This module contains access to the permanent settings of the device.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_settings_1_1_data.html">Data</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The internal structure of the data. <a href="struct_settings_1_1_data.html#details">More...</a><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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a63e157ddc42dfacb82c2c9159325fbf2"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#a63e157ddc42dfacb82c2c9159325fbf2">calculateCrc</a> ()</td></tr>
<tr class="memdesc:a63e157ddc42dfacb82c2c9159325fbf2"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the CRC of the current SRAM data. <a href="#a63e157ddc42dfacb82c2c9159325fbf2">More...</a><br /></td></tr>
<tr class="separator:a63e157ddc42dfacb82c2c9159325fbf2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0f3ec889ab03b807e937580704a3ee9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#ac0f3ec889ab03b807e937580704a3ee9">read</a> ()</td></tr>
<tr class="memdesc:ac0f3ec889ab03b807e937580704a3ee9"><td class="mdescLeft"> </td><td class="mdescRight">Read all settings into SRAM. <a href="#ac0f3ec889ab03b807e937580704a3ee9">More...</a><br /></td></tr>
<tr class="separator:ac0f3ec889ab03b807e937580704a3ee9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99ce176e86cfab03e4f783670ccd1b84"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#a99ce176e86cfab03e4f783670ccd1b84">write</a> ()</td></tr>
<tr class="memdesc:a99ce176e86cfab03e4f783670ccd1b84"><td class="mdescLeft"> </td><td class="mdescRight">Write all settings back to EEPROM. <a href="#a99ce176e86cfab03e4f783670ccd1b84">More...</a><br /></td></tr>
<tr class="separator:a99ce176e86cfab03e4f783670ccd1b84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6abd5b438e4b4e3f072c8d261794f64"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#ac6abd5b438e4b4e3f072c8d261794f64">getSetPointFrequency</a> ()</td></tr>
<tr class="memdesc:ac6abd5b438e4b4e3f072c8d261794f64"><td class="mdescLeft"> </td><td class="mdescRight">Read the set-point value. <a href="#ac6abd5b438e4b4e3f072c8d261794f64">More...</a><br /></td></tr>
<tr class="separator:ac6abd5b438e4b4e3f072c8d261794f64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96147af823e9489d87f95e636b1324e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#a96147af823e9489d87f95e636b1324e1">setSetPointFrequency</a> (uint8_t frequency)</td></tr>
<tr class="memdesc:a96147af823e9489d87f95e636b1324e1"><td class="mdescLeft"> </td><td class="mdescRight">Write a new set-point value. <a href="#a96147af823e9489d87f95e636b1324e1">More...</a><br /></td></tr>
<tr class="separator:a96147af823e9489d87f95e636b1324e1"><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:a47a13a77c0dcc955e00b73746f2720b0"><td class="memItemLeft" align="right" valign="top">const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#a47a13a77c0dcc955e00b73746f2720b0">cCrcStartMagic</a> = 0xa004u</td></tr>
<tr class="memdesc:a47a13a77c0dcc955e00b73746f2720b0"><td class="mdescLeft"> </td><td class="mdescRight">The CRC start magic. <a href="#a47a13a77c0dcc955e00b73746f2720b0">More...</a><br /></td></tr>
<tr class="separator:a47a13a77c0dcc955e00b73746f2720b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6fe8c5f5de0f3b203d6debbf3e04e4d"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#ae6fe8c5f5de0f3b203d6debbf3e04e4d">cMagicSize</a> = 4</td></tr>
<tr class="memdesc:ae6fe8c5f5de0f3b203d6debbf3e04e4d"><td class="mdescLeft"> </td><td class="mdescRight">The size of the magic. <a href="#ae6fe8c5f5de0f3b203d6debbf3e04e4d">More...</a><br /></td></tr>
<tr class="separator:ae6fe8c5f5de0f3b203d6debbf3e04e4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7159db8cffb7dae2cbc56bdef670da5e"><td class="memItemLeft" align="right" valign="top">EEMEM <a class="el" href="struct_settings_1_1_data.html">Data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#a7159db8cffb7dae2cbc56bdef670da5e">eData</a></td></tr>
<tr class="memdesc:a7159db8cffb7dae2cbc56bdef670da5e"><td class="mdescLeft"> </td><td class="mdescRight">Allocate the data in the EEPROM memory. <a href="#a7159db8cffb7dae2cbc56bdef670da5e">More...</a><br /></td></tr>
<tr class="separator:a7159db8cffb7dae2cbc56bdef670da5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd7aede6580b7b487ae52acdf3ebd4a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_settings_1_1_data.html">Data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a></td></tr>
<tr class="memdesc:afd7aede6580b7b487ae52acdf3ebd4a7"><td class="mdescLeft"> </td><td class="mdescRight">Allocate the data in SRAM. <a href="#afd7aede6580b7b487ae52acdf3ebd4a7">More...</a><br /></td></tr>
<tr class="separator:afd7aede6580b7b487ae52acdf3ebd4a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1377cc485dabc1a34d03ef0a299424cc"><td class="memItemLeft" align="right" valign="top">PROGMEM const <a class="el" href="struct_settings_1_1_data.html">Data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_settings.html#a1377cc485dabc1a34d03ef0a299424cc">cDefaultData</a></td></tr>
<tr class="memdesc:a1377cc485dabc1a34d03ef0a299424cc"><td class="mdescLeft"> </td><td class="mdescRight">Allocate default data in Flash memory. <a href="#a1377cc485dabc1a34d03ef0a299424cc">More...</a><br /></td></tr>
<tr class="separator:a1377cc485dabc1a34d03ef0a299424cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This module contains access to the permanent settings of the device. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a63e157ddc42dfacb82c2c9159325fbf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63e157ddc42dfacb82c2c9159325fbf2">◆ </a></span>calculateCrc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t Settings::calculateCrc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the CRC of the current SRAM data. </p>
<p>The CRC is calculated using the cCrcStartMagic as start point over the whole data structure with the CRC in the structure set to zero. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00073">73</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  uint16_t crc = <a class="code" href="namespace_settings.html#a47a13a77c0dcc955e00b73746f2720b0">cCrcStartMagic</a>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  uint16_t originalCrc = <a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">crc</a>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">for</span> (uint8_t i = 0; i < (<span class="keyword">sizeof</span>(Data)-2); ++i) {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  crc = _crc16_update(crc, reinterpret_cast<uint8_t*>(&<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>)[i]);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">crc</a> = originalCrc;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> crc;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> }</div><div class="ttc" id="namespace_settings_html_a47a13a77c0dcc955e00b73746f2720b0"><div class="ttname"><a href="namespace_settings.html#a47a13a77c0dcc955e00b73746f2720b0">Settings::cCrcStartMagic</a></div><div class="ttdeci">const uint16_t cCrcStartMagic</div><div class="ttdoc">The CRC start magic. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00037">Settings.cpp:37</a></div></div>
<div class="ttc" id="struct_settings_1_1_data_html_a65269f788037d35da3200c8547c5928a"><div class="ttname"><a href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">Settings::Data::crc</a></div><div class="ttdeci">uint16_t crc</div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00048">Settings.cpp:48</a></div></div>
<div class="ttc" id="namespace_settings_html_afd7aede6580b7b487ae52acdf3ebd4a7"><div class="ttname"><a href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">Settings::gData</a></div><div class="ttdeci">Data gData</div><div class="ttdoc">Allocate the data in SRAM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00057">Settings.cpp:57</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ac6abd5b438e4b4e3f072c8d261794f64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6abd5b438e4b4e3f072c8d261794f64">◆ </a></span>getSetPointFrequency()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Settings::getSetPointFrequency </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the set-point value. </p>
<dl class="section return"><dt>Returns</dt><dd>The set-point value as oscillator frequency. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00112">112</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#a6f0b75d216bb00c75944df0d63bfb841">setPoint</a>);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> }</div><div class="ttc" id="namespace_settings_html_afd7aede6580b7b487ae52acdf3ebd4a7"><div class="ttname"><a href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">Settings::gData</a></div><div class="ttdeci">Data gData</div><div class="ttdoc">Allocate the data in SRAM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00057">Settings.cpp:57</a></div></div>
<div class="ttc" id="struct_settings_1_1_data_html_a6f0b75d216bb00c75944df0d63bfb841"><div class="ttname"><a href="struct_settings_1_1_data.html#a6f0b75d216bb00c75944df0d63bfb841">Settings::Data::setPoint</a></div><div class="ttdeci">uint16_t setPoint</div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00047">Settings.cpp:47</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ac0f3ec889ab03b807e937580704a3ee9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0f3ec889ab03b807e937580704a3ee9">◆ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Settings::read </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read all settings into SRAM. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00085">85</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// Read Data structure from EEPROM.</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  eeprom_read_block(&<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>, &<a class="code" href="namespace_settings.html#a7159db8cffb7dae2cbc56bdef670da5e">eData</a>, <span class="keyword">sizeof</span>(Data));</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// Check the magic in the structure.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">if</span> (memcmp_P(<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#aae153b0ba3d3f67ba49a85f37ae01fdd">magic</a>, <a class="code" href="namespace_settings.html#a1377cc485dabc1a34d03ef0a299424cc">cDefaultData</a>.<a class="code" href="struct_settings_1_1_data.html#aae153b0ba3d3f67ba49a85f37ae01fdd">magic</a>, <a class="code" href="namespace_settings.html#ae6fe8c5f5de0f3b203d6debbf3e04e4d">cMagicSize</a>) == 0) {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// Check the CRC of the buffer.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">const</span> uint16_t calculatedCrc = <a class="code" href="namespace_settings.html#a63e157ddc42dfacb82c2c9159325fbf2">calculateCrc</a>();</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// Check if the CRC of the buffer is correct.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">if</span> (<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">crc</a> == calculatedCrc) {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// Copy the default settings into SRAM.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  memcpy_P(&<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>, &<a class="code" href="namespace_settings.html#a1377cc485dabc1a34d03ef0a299424cc">cDefaultData</a>, <span class="keyword">sizeof</span>(Data));</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> }</div><div class="ttc" id="namespace_settings_html_ae6fe8c5f5de0f3b203d6debbf3e04e4d"><div class="ttname"><a href="namespace_settings.html#ae6fe8c5f5de0f3b203d6debbf3e04e4d">Settings::cMagicSize</a></div><div class="ttdeci">const uint8_t cMagicSize</div><div class="ttdoc">The size of the magic. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00041">Settings.cpp:41</a></div></div>
<div class="ttc" id="namespace_settings_html_a7159db8cffb7dae2cbc56bdef670da5e"><div class="ttname"><a href="namespace_settings.html#a7159db8cffb7dae2cbc56bdef670da5e">Settings::eData</a></div><div class="ttdeci">EEMEM Data eData</div><div class="ttdoc">Allocate the data in the EEPROM memory. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00053">Settings.cpp:53</a></div></div>
<div class="ttc" id="struct_settings_1_1_data_html_a65269f788037d35da3200c8547c5928a"><div class="ttname"><a href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">Settings::Data::crc</a></div><div class="ttdeci">uint16_t crc</div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00048">Settings.cpp:48</a></div></div>
<div class="ttc" id="namespace_settings_html_a63e157ddc42dfacb82c2c9159325fbf2"><div class="ttname"><a href="namespace_settings.html#a63e157ddc42dfacb82c2c9159325fbf2">Settings::calculateCrc</a></div><div class="ttdeci">uint16_t calculateCrc()</div><div class="ttdoc">Calculate the CRC of the current SRAM data. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00073">Settings.cpp:73</a></div></div>
<div class="ttc" id="namespace_settings_html_a1377cc485dabc1a34d03ef0a299424cc"><div class="ttname"><a href="namespace_settings.html#a1377cc485dabc1a34d03ef0a299424cc">Settings::cDefaultData</a></div><div class="ttdeci">PROGMEM const Data cDefaultData</div><div class="ttdoc">Allocate default data in Flash memory. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00061">Settings.cpp:61</a></div></div>
<div class="ttc" id="struct_settings_1_1_data_html_aae153b0ba3d3f67ba49a85f37ae01fdd"><div class="ttname"><a href="struct_settings_1_1_data.html#aae153b0ba3d3f67ba49a85f37ae01fdd">Settings::Data::magic</a></div><div class="ttdeci">uint8_t magic[cMagicSize]</div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00046">Settings.cpp:46</a></div></div>
<div class="ttc" id="namespace_settings_html_afd7aede6580b7b487ae52acdf3ebd4a7"><div class="ttname"><a href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">Settings::gData</a></div><div class="ttdeci">Data gData</div><div class="ttdoc">Allocate the data in SRAM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00057">Settings.cpp:57</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a96147af823e9489d87f95e636b1324e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96147af823e9489d87f95e636b1324e1">◆ </a></span>setSetPointFrequency()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Settings::setSetPointFrequency </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>frequency</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a new set-point value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frequency</td><td>The new oscillator frequency. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00118">118</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> {</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#a6f0b75d216bb00c75944df0d63bfb841">setPoint</a> = frequency;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }</div><div class="ttc" id="namespace_settings_html_afd7aede6580b7b487ae52acdf3ebd4a7"><div class="ttname"><a href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">Settings::gData</a></div><div class="ttdeci">Data gData</div><div class="ttdoc">Allocate the data in SRAM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00057">Settings.cpp:57</a></div></div>
<div class="ttc" id="struct_settings_1_1_data_html_a6f0b75d216bb00c75944df0d63bfb841"><div class="ttname"><a href="struct_settings_1_1_data.html#a6f0b75d216bb00c75944df0d63bfb841">Settings::Data::setPoint</a></div><div class="ttdeci">uint16_t setPoint</div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00047">Settings.cpp:47</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a99ce176e86cfab03e4f783670ccd1b84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99ce176e86cfab03e4f783670ccd1b84">◆ </a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Settings::write </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write all settings back to EEPROM. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00103">103</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// Calculate the CRC of the current data values.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>.<a class="code" href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">crc</a> = <a class="code" href="namespace_settings.html#a63e157ddc42dfacb82c2c9159325fbf2">calculateCrc</a>();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// Write the whole data structure into the EEPROM.</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  eeprom_update_block(&<a class="code" href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">gData</a>, &<a class="code" href="namespace_settings.html#a7159db8cffb7dae2cbc56bdef670da5e">eData</a>, <span class="keyword">sizeof</span>(Data));</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> }</div><div class="ttc" id="namespace_settings_html_a7159db8cffb7dae2cbc56bdef670da5e"><div class="ttname"><a href="namespace_settings.html#a7159db8cffb7dae2cbc56bdef670da5e">Settings::eData</a></div><div class="ttdeci">EEMEM Data eData</div><div class="ttdoc">Allocate the data in the EEPROM memory. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00053">Settings.cpp:53</a></div></div>
<div class="ttc" id="struct_settings_1_1_data_html_a65269f788037d35da3200c8547c5928a"><div class="ttname"><a href="struct_settings_1_1_data.html#a65269f788037d35da3200c8547c5928a">Settings::Data::crc</a></div><div class="ttdeci">uint16_t crc</div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00048">Settings.cpp:48</a></div></div>
<div class="ttc" id="namespace_settings_html_a63e157ddc42dfacb82c2c9159325fbf2"><div class="ttname"><a href="namespace_settings.html#a63e157ddc42dfacb82c2c9159325fbf2">Settings::calculateCrc</a></div><div class="ttdeci">uint16_t calculateCrc()</div><div class="ttdoc">Calculate the CRC of the current SRAM data. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00073">Settings.cpp:73</a></div></div>
<div class="ttc" id="namespace_settings_html_afd7aede6580b7b487ae52acdf3ebd4a7"><div class="ttname"><a href="namespace_settings.html#afd7aede6580b7b487ae52acdf3ebd4a7">Settings::gData</a></div><div class="ttdeci">Data gData</div><div class="ttdoc">Allocate the data in SRAM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00057">Settings.cpp:57</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a47a13a77c0dcc955e00b73746f2720b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47a13a77c0dcc955e00b73746f2720b0">◆ </a></span>cCrcStartMagic</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint16_t Settings::cCrcStartMagic = 0xa004u</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CRC start magic. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00037">37</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
</div>
</div>
<a id="a1377cc485dabc1a34d03ef0a299424cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1377cc485dabc1a34d03ef0a299424cc">◆ </a></span>cDefaultData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PROGMEM const <a class="el" href="struct_settings_1_1_data.html">Data</a> Settings::cDefaultData</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div><div class="line"> {<span class="charliteral">'L'</span>,<span class="charliteral">'R'</span>,<span class="charliteral">'p'</span>,<span class="charliteral">'s'</span>}, </div><div class="line"> <a class="code" href="namespace_configuration.html#a60e1dfbae210f0d22114c20b2acfa53d">Configuration::cDefaultSetPointFrequency</a>, </div><div class="line"> 0, </div><div class="line">}</div><div class="ttc" id="namespace_configuration_html_a60e1dfbae210f0d22114c20b2acfa53d"><div class="ttname"><a href="namespace_configuration.html#a60e1dfbae210f0d22114c20b2acfa53d">Configuration::cDefaultSetPointFrequency</a></div><div class="ttdeci">const uint8_t cDefaultSetPointFrequency</div><div class="ttdoc">The default set-point value if none is set. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00081">Configuration.h:81</a></div></div>
</div><!-- fragment -->
<p>Allocate default data in Flash memory. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00061">61</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
</div>
</div>
<a id="ae6fe8c5f5de0f3b203d6debbf3e04e4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6fe8c5f5de0f3b203d6debbf3e04e4d">◆ </a></span>cMagicSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t Settings::cMagicSize = 4</td>
</tr>
</table>
</div><div class="memdoc">
<p>The size of the magic. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00041">41</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
</div>
</div>
<a id="a7159db8cffb7dae2cbc56bdef670da5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7159db8cffb7dae2cbc56bdef670da5e">◆ </a></span>eData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EEMEM <a class="el" href="struct_settings_1_1_data.html">Data</a> Settings::eData</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate the data in the EEPROM memory. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00053">53</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.cpp</a>.</p>
</div>
</div>
<a id="afd7aede6580b7b487ae52acdf3ebd4a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd7aede6580b7b487ae52acdf3ebd4a7">◆ </a></span>gData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_settings_1_1_data.html">Data</a> Settings::gData</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate the data in SRAM. </p>
<p class="definition">Definition at line <a class="el" href="_settings_8cpp_source.html#l00057">57</a> of file <a class="el" href="_settings_8cpp_source.html">Settings.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="namespace_settings.html">Settings</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>