-
Notifications
You must be signed in to change notification settings - Fork 0
/
_settings_8h_source.html
103 lines (101 loc) · 10.9 KB
/
_settings_8h_source.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
<!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/Settings.h Source File</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('_settings_8h_source.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="headertitle">
<div class="title">Settings.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_settings_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Plant Watering Sensor Project</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// ---------------------------------------------------------------------------</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// (c)2017 by Lucky Resistor. See LICENSE for details.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// https://luckyresistor.me</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This program is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// (at your option) any later version.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// GNU General Public License for more details.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">//</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// You should have received a copy of the GNU General Public License along</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// with this program; if not, write to the Free Software Foundation, Inc.,</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespace_settings.html">Settings</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> <a class="code" href="namespace_settings.html#ac0f3ec889ab03b807e937580704a3ee9">read</a>();</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> <a class="code" href="namespace_settings.html#a99ce176e86cfab03e4f783670ccd1b84">write</a>();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> uint8_t <a class="code" href="namespace_settings.html#ac6abd5b438e4b4e3f072c8d261794f64">getSetPointFrequency</a>();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">void</span> <a class="code" href="namespace_settings.html#a96147af823e9489d87f95e636b1324e1">setSetPointFrequency</a>(uint8_t frequency);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div><div class="ttc" id="namespace_settings_html_ac6abd5b438e4b4e3f072c8d261794f64"><div class="ttname"><a href="namespace_settings.html#ac6abd5b438e4b4e3f072c8d261794f64">Settings::getSetPointFrequency</a></div><div class="ttdeci">uint8_t getSetPointFrequency()</div><div class="ttdoc">Read the set-point value. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00112">Settings.cpp:112</a></div></div>
<div class="ttc" id="namespace_settings_html_ac0f3ec889ab03b807e937580704a3ee9"><div class="ttname"><a href="namespace_settings.html#ac0f3ec889ab03b807e937580704a3ee9">Settings::read</a></div><div class="ttdeci">void read()</div><div class="ttdoc">Read all settings into SRAM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00085">Settings.cpp:85</a></div></div>
<div class="ttc" id="namespace_settings_html_a99ce176e86cfab03e4f783670ccd1b84"><div class="ttname"><a href="namespace_settings.html#a99ce176e86cfab03e4f783670ccd1b84">Settings::write</a></div><div class="ttdeci">void write()</div><div class="ttdoc">Write all settings back to EEPROM. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00103">Settings.cpp:103</a></div></div>
<div class="ttc" id="namespace_settings_html_a96147af823e9489d87f95e636b1324e1"><div class="ttname"><a href="namespace_settings.html#a96147af823e9489d87f95e636b1324e1">Settings::setSetPointFrequency</a></div><div class="ttdeci">void setSetPointFrequency(uint8_t frequency)</div><div class="ttdoc">Write a new set-point value. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00118">Settings.cpp:118</a></div></div>
<div class="ttc" id="namespace_settings_html"><div class="ttname"><a href="namespace_settings.html">Settings</a></div><div class="ttdoc">This module contains access to the permanent settings of the device. </div><div class="ttdef"><b>Definition:</b> <a href="_settings_8cpp_source.html#l00032">Settings.cpp:32</a></div></div>
</div><!-- fragment --></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="_settings_8h.html">Settings.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>