-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_d_s3231_8hpp_source.html
86 lines (84 loc) · 18.2 KB
/
_d_s3231_8hpp_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
<!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>Portable Radio: DS3231.hpp 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="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">Portable Radio
</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_5ad7f572bbca03234e8e621e192fc099.html">Library</a></li><li class="navelem"><a class="el" href="dir_bb41d55c065784e0adf93f30d32061b1.html">DS3231</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">DS3231.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_d_s3231_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#ifndef __DS3231_HPP</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#define __DS3231_HPP</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "<a class="code" href="time_date_data_8hpp.html">timeDateData.hpp</a>"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classalarm.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="classalarm.html">alarm</a>{</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> matchConditions;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span> outputSignal;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alarmNumber;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classalarm.html#a839ff853352299aa7cecb96164cada09">alarm</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> matchConditions = 16, <span class="keyword">const</span> <span class="keywordtype">bool</span> outputSignal = 0);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classalarm.html#a839ff853352299aa7cecb96164cada09">alarm</a>(<span class="keyword">const</span> <a class="code" href="classalarm.html">alarm</a> & givenAlarm);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> <a class="code" href="classalarm.html#a4c9a71160416d883f2a23b6fd70cd0e1">setMatchConditions</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> condition = 0);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classalarm.html#a03cc1bee7c4675dee08747214b065a72">getMatchConditions</a>();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> <a class="code" href="classalarm.html#ad0c9477948028991f76f9e4539893741">enableOutputSignal</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> enable);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classtime_data.html">timeData</a> time;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classdate_data.html">dateData</a> date;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="class_d_s3231.html"> 113</a></span> <span class="keyword">class </span><a class="code" href="class_d_s3231.html">DS3231</a>{</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  hwlib::i2c_bus & bus;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">const</span> uint8_t address;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  hwlib::pin_in_out & resetPin;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  uint8_t data[13] = {};</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  uint8_t status[13] = {};</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> setData();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> getStatus();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">bool</span> firstAlarmState = <span class="keyword">false</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">bool</span> secondAlarmState = <span class="keyword">false</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classalarm.html">alarm</a> firstAlarm;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="classalarm.html">alarm</a> secondAlarm;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <a class="code" href="classtime_data.html">timeData</a> time;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classdate_data.html">dateData</a> date;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="class_d_s3231.html">DS3231</a>(hwlib::i2c_bus_bit_banged_scl_sda & bus, uint8_t address = 0x68, hwlib::pin_in_out & resetPin = hwlib::pin_in_out_dummy);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">void</span> setTime(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hours, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> minutes, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seconds = 0);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">void</span> setTime(<span class="keyword">const</span> <a class="code" href="classtime_data.html">timeData</a> & time);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">void</span> setDate(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> weekDay, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> monthDay, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> month, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> year);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">void</span> setDate(<span class="keyword">const</span> <a class="code" href="classdate_data.html">dateData</a> & date);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classtime_data.html">timeData</a> getTime();</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="classdate_data.html">dateData</a> getDate();</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">void</span> changeFirstAlarm(<span class="keyword">const</span> <a class="code" href="classtime_data.html">timeData</a> & alarmTime, <span class="keyword">const</span> <a class="code" href="classdate_data.html">dateData</a> & alarmDate);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">void</span> setFirstAlarm(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> matchConditions, <span class="keyword">const</span> <span class="keywordtype">bool</span> dateCondition = <span class="keyword">true</span>, <span class="keyword">const</span> <span class="keywordtype">bool</span> outputSignal = <span class="keyword">false</span>);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">void</span> changeSecondAlarm(<span class="keyword">const</span> <a class="code" href="classtime_data.html">timeData</a> & alarmTime, <span class="keyword">const</span> <a class="code" href="classdate_data.html">dateData</a> & alarmDate);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordtype">void</span> setSecondAlarm(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> matchConditions, <span class="keyword">const</span> <span class="keywordtype">bool</span> dateCondition = <span class="keyword">true</span>, <span class="keyword">const</span> <span class="keywordtype">bool</span> outputSignal = <span class="keyword">false</span>);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">void</span> updateAlarms();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> checkAlarms();</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">void</span> clearAlarm(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alarmNumber);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">void</span> setReset(<span class="keyword">const</span> <span class="keywordtype">bool</span> reset = <span class="keyword">true</span>);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">bool</span> getReset();</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getAddress();</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">float</span> getTemperature();</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">bool</span> testCorrectFunctioning();</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> };</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#endif //__DS3231_HPP</span></div><div class="ttc" id="classalarm_html_a839ff853352299aa7cecb96164cada09"><div class="ttname"><a href="classalarm.html#a839ff853352299aa7cecb96164cada09">alarm::alarm</a></div><div class="ttdeci">alarm(const unsigned int matchConditions=16, const bool outputSignal=0)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> DS3231.cpp:12</div></div>
<div class="ttc" id="class_d_s3231_html"><div class="ttname"><a href="class_d_s3231.html">DS3231</a></div><div class="ttdoc">DS3231 Interface. </div><div class="ttdef"><b>Definition:</b> DS3231.hpp:113</div></div>
<div class="ttc" id="classalarm_html_ad0c9477948028991f76f9e4539893741"><div class="ttname"><a href="classalarm.html#ad0c9477948028991f76f9e4539893741">alarm::enableOutputSignal</a></div><div class="ttdeci">void enableOutputSignal(const bool enable)</div><div class="ttdoc">Set Outputsignal. </div><div class="ttdef"><b>Definition:</b> DS3231.cpp:50</div></div>
<div class="ttc" id="classtime_data_html"><div class="ttname"><a href="classtime_data.html">timeData</a></div><div class="ttdoc">Time ADT. </div><div class="ttdef"><b>Definition:</b> timeDateData.hpp:48</div></div>
<div class="ttc" id="classalarm_html_a03cc1bee7c4675dee08747214b065a72"><div class="ttname"><a href="classalarm.html#a03cc1bee7c4675dee08747214b065a72">alarm::getMatchConditions</a></div><div class="ttdeci">unsigned int getMatchConditions()</div><div class="ttdoc">Get Match Conditions. </div><div class="ttdef"><b>Definition:</b> DS3231.cpp:41</div></div>
<div class="ttc" id="classalarm_html"><div class="ttname"><a href="classalarm.html">alarm</a></div><div class="ttdoc">Alarm Class. </div><div class="ttdef"><b>Definition:</b> DS3231.hpp:49</div></div>
<div class="ttc" id="classdate_data_html"><div class="ttname"><a href="classdate_data.html">dateData</a></div><div class="ttdoc">Date ADT. </div><div class="ttdef"><b>Definition:</b> timeDateData.hpp:134</div></div>
<div class="ttc" id="time_date_data_8hpp_html"><div class="ttname"><a href="time_date_data_8hpp.html">timeDateData.hpp</a></div></div>
<div class="ttc" id="classalarm_html_a4c9a71160416d883f2a23b6fd70cd0e1"><div class="ttname"><a href="classalarm.html#a4c9a71160416d883f2a23b6fd70cd0e1">alarm::setMatchConditions</a></div><div class="ttdeci">void setMatchConditions(const unsigned int condition=0)</div><div class="ttdoc">Set Match Conditions. </div><div class="ttdef"><b>Definition:</b> DS3231.cpp:33</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 4 2019 19:05:50 for Portable Radio by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>