-
Notifications
You must be signed in to change notification settings - Fork 0
/
namespace_display.html
308 lines (290 loc) · 28.6 KB
/
namespace_display.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
<!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: Display 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_display.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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Display Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The display module controls the visual signals to the user.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae90342f85dd0312c91e6c79041f8a577"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> : uint8_t { <a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577a136f1deeb1377e23c957f3cba7448854">Red</a> = Hardware::LED_Red,
<a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577a04e133a795e123a442574bff653f88b6">Green</a> = Hardware::LED_Green
}<tr class="memdesc:ae90342f85dd0312c91e6c79041f8a577"><td class="mdescLeft"> </td><td class="mdescRight">The color for the display. <a href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ae90342f85dd0312c91e6c79041f8a577"><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:a9bafff031c379fdca400266542ff9090"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_display.html#a9bafff031c379fdca400266542ff9090">flash</a> (<a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> color, uint8_t flashCount)</td></tr>
<tr class="memdesc:a9bafff031c379fdca400266542ff9090"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="namespace_display.html" title="The display module controls the visual signals to the user. ">Display</a> a number of flashes. <a href="#a9bafff031c379fdca400266542ff9090">More...</a><br /></td></tr>
<tr class="separator:a9bafff031c379fdca400266542ff9090"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6567b49e0c69f59ab36809eb013f948b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_display.html#a6567b49e0c69f59ab36809eb013f948b">modulateLed</a> (<a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> color, uint8_t pwmValue)</td></tr>
<tr class="memdesc:a6567b49e0c69f59ab36809eb013f948b"><td class="mdescLeft"> </td><td class="mdescRight">One cycle of a modulated LED. <a href="#a6567b49e0c69f59ab36809eb013f948b">More...</a><br /></td></tr>
<tr class="separator:a6567b49e0c69f59ab36809eb013f948b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16173933e3fed9fd3de4c25c82ee9074"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_display.html#a16173933e3fed9fd3de4c25c82ee9074">pulse</a> (<a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> color)</td></tr>
<tr class="memdesc:a16173933e3fed9fd3de4c25c82ee9074"><td class="mdescLeft"> </td><td class="mdescRight">Smooth Pulse one time. <a href="#a16173933e3fed9fd3de4c25c82ee9074">More...</a><br /></td></tr>
<tr class="separator:a16173933e3fed9fd3de4c25c82ee9074"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae407713ef5a2c380a2643cdc0c2b35cd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_display.html#ae407713ef5a2c380a2643cdc0c2b35cd">dimSignal</a> (<a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> color)</td></tr>
<tr class="memdesc:ae407713ef5a2c380a2643cdc0c2b35cd"><td class="mdescLeft"> </td><td class="mdescRight">Very short dim signal. <a href="#ae407713ef5a2c380a2643cdc0c2b35cd">More...</a><br /></td></tr>
<tr class="separator:ae407713ef5a2c380a2643cdc0c2b35cd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The display module controls the visual signals to the user. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ae90342f85dd0312c91e6c79041f8a577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90342f85dd0312c91e6c79041f8a577">◆ </a></span>Color</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Display::Color</a> : uint8_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>The color for the display. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae90342f85dd0312c91e6c79041f8a577a136f1deeb1377e23c957f3cba7448854"></a>Red </td><td class="fielddoc"><p><a class="el" href="namespace_display.html" title="The display module controls the visual signals to the user. ">Display</a> a red color. </p>
</td></tr>
<tr><td class="fieldname"><a id="ae90342f85dd0312c91e6c79041f8a577a04e133a795e123a442574bff653f88b6"></a>Green </td><td class="fielddoc"><p><a class="el" href="namespace_display.html" title="The display module controls the visual signals to the user. ">Display</a> a green color. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="_display_8h_source.html#l00034">34</a> of file <a class="el" href="_display_8h_source.html">Display.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  : uint8_t {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577a136f1deeb1377e23c957f3cba7448854">Red</a> = <a class="code" href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848a68aa56446e2947fe770776a6bbc81af9">Hardware::LED_Red</a>, </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577a04e133a795e123a442574bff653f88b6">Green</a> = <a class="code" href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848ae479ae184faf3012957bffb6cfe780b1">Hardware::LED_Green</a>, </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> };</div><div class="ttc" id="namespace_hardware_html_acc409c97181a985b78dd4881c8656848ae479ae184faf3012957bffb6cfe780b1"><div class="ttname"><a href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848ae479ae184faf3012957bffb6cfe780b1">Hardware::LED_Green</a></div><div class="ttdoc">The green LED is on. </div><div class="ttdef"><b>Definition:</b> <a href="_hardware_8h_source.html#l00036">Hardware.h:36</a></div></div>
<div class="ttc" id="namespace_display_html_ae90342f85dd0312c91e6c79041f8a577a136f1deeb1377e23c957f3cba7448854"><div class="ttname"><a href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577a136f1deeb1377e23c957f3cba7448854">Display::Red</a></div><div class="ttdoc">Display a red color. </div><div class="ttdef"><b>Definition:</b> <a href="_display_8h_source.html#l00035">Display.h:35</a></div></div>
<div class="ttc" id="namespace_display_html_ae90342f85dd0312c91e6c79041f8a577a04e133a795e123a442574bff653f88b6"><div class="ttname"><a href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577a04e133a795e123a442574bff653f88b6">Display::Green</a></div><div class="ttdoc">Display a green color. </div><div class="ttdef"><b>Definition:</b> <a href="_display_8h_source.html#l00036">Display.h:36</a></div></div>
<div class="ttc" id="namespace_hardware_html_acc409c97181a985b78dd4881c8656848a68aa56446e2947fe770776a6bbc81af9"><div class="ttname"><a href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848a68aa56446e2947fe770776a6bbc81af9">Hardware::LED_Red</a></div><div class="ttdoc">The red LED is on. </div><div class="ttdef"><b>Definition:</b> <a href="_hardware_8h_source.html#l00037">Hardware.h:37</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae407713ef5a2c380a2643cdc0c2b35cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae407713ef5a2c380a2643cdc0c2b35cd">◆ </a></span>dimSignal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Display::dimSignal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> </td>
<td class="paramname"><em>color</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Very short dim signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">color</td><td>The color for the signal. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_display_8cpp_source.html#l00073">73</a> of file <a class="el" href="_display_8cpp_source.html">Display.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>  <span class="keywordflow">for</span> (uint16_t i = 0; i < <a class="code" href="namespace_configuration.html#ab460d63ac5617b20b30082022c6f4aac">Configuration::cDisplayDimSignalCycles</a>; ++i) {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="namespace_display.html#a6567b49e0c69f59ab36809eb013f948b">modulateLed</a>(color, <a class="code" href="namespace_configuration.html#adf6d0fa8593143bb92a896ce0129a5de">Configuration::cDisplayDimSignalPwm</a>);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> }</div><div class="ttc" id="namespace_configuration_html_adf6d0fa8593143bb92a896ce0129a5de"><div class="ttname"><a href="namespace_configuration.html#adf6d0fa8593143bb92a896ce0129a5de">Configuration::cDisplayDimSignalPwm</a></div><div class="ttdeci">const uint8_t cDisplayDimSignalPwm</div><div class="ttdoc">The PWM value for the dim signal. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00069">Configuration.h:69</a></div></div>
<div class="ttc" id="namespace_configuration_html_ab460d63ac5617b20b30082022c6f4aac"><div class="ttname"><a href="namespace_configuration.html#ab460d63ac5617b20b30082022c6f4aac">Configuration::cDisplayDimSignalCycles</a></div><div class="ttdeci">const uint16_t cDisplayDimSignalCycles</div><div class="ttdoc">The duration of the dim signal. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00073">Configuration.h:73</a></div></div>
<div class="ttc" id="namespace_display_html_a6567b49e0c69f59ab36809eb013f948b"><div class="ttname"><a href="namespace_display.html#a6567b49e0c69f59ab36809eb013f948b">Display::modulateLed</a></div><div class="ttdeci">void modulateLed(Color color, uint8_t pwmValue)</div><div class="ttdoc">One cycle of a modulated LED. </div><div class="ttdef"><b>Definition:</b> <a href="_display_8cpp_source.html#l00049">Display.cpp:49</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a9bafff031c379fdca400266542ff9090"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bafff031c379fdca400266542ff9090">◆ </a></span>flash()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Display::flash </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>flashCount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="namespace_display.html" title="The display module controls the visual signals to the user. ">Display</a> a number of flashes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">color</td><td>The color for the flash. </td></tr>
<tr><td class="paramname">flashCount</td><td>The number of flashes to show. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_display_8cpp_source.html#l00031">31</a> of file <a class="el" href="_display_8cpp_source.html">Display.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">for</span> (uint8_t i = 0; i < flashCount; ++i) {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">if</span> (i > 0) {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="namespace_tool.html#a403edfe54b1b8a2cddae03feac5715aa">Tool::delayMs</a>(<a class="code" href="namespace_configuration.html#a2e254631d5a6c3ba0e209bc59ef44c89">Configuration::cDisplayFlashPauseMs</a>);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="namespace_hardware.html#a4bf62531670f7ce338200505ebfed3db">Hardware::setLedState</a>(static_cast<Hardware::LedState>(color));</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="namespace_tool.html#a403edfe54b1b8a2cddae03feac5715aa">Tool::delayMs</a>(<a class="code" href="namespace_configuration.html#ae323c955d4c4cc8ea07f096a8bd6c196">Configuration::cDisplayFlashDurationMs</a>);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="namespace_hardware.html#a4bf62531670f7ce338200505ebfed3db">Hardware::setLedState</a>(<a class="code" href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848ad4f123e7f67cd625e2a3422d21001441">Hardware::LED_Off</a>);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div><div class="ttc" id="namespace_configuration_html_ae323c955d4c4cc8ea07f096a8bd6c196"><div class="ttname"><a href="namespace_configuration.html#ae323c955d4c4cc8ea07f096a8bd6c196">Configuration::cDisplayFlashDurationMs</a></div><div class="ttdeci">const uint16_t cDisplayFlashDurationMs</div><div class="ttdoc">The flash duration. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00053">Configuration.h:53</a></div></div>
<div class="ttc" id="namespace_configuration_html_a2e254631d5a6c3ba0e209bc59ef44c89"><div class="ttname"><a href="namespace_configuration.html#a2e254631d5a6c3ba0e209bc59ef44c89">Configuration::cDisplayFlashPauseMs</a></div><div class="ttdeci">const uint16_t cDisplayFlashPauseMs</div><div class="ttdoc">The pause between two flashes. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00057">Configuration.h:57</a></div></div>
<div class="ttc" id="namespace_hardware_html_acc409c97181a985b78dd4881c8656848ad4f123e7f67cd625e2a3422d21001441"><div class="ttname"><a href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848ad4f123e7f67cd625e2a3422d21001441">Hardware::LED_Off</a></div><div class="ttdoc">The LED is off. </div><div class="ttdef"><b>Definition:</b> <a href="_hardware_8h_source.html#l00035">Hardware.h:35</a></div></div>
<div class="ttc" id="namespace_hardware_html_a4bf62531670f7ce338200505ebfed3db"><div class="ttname"><a href="namespace_hardware.html#a4bf62531670f7ce338200505ebfed3db">Hardware::setLedState</a></div><div class="ttdeci">void setLedState(LedState ledState)</div><div class="ttdoc">Enable or disable the status LEDs. </div><div class="ttdef"><b>Definition:</b> <a href="_hardware_8cpp_source.html#l00069">Hardware.cpp:69</a></div></div>
<div class="ttc" id="namespace_tool_html_a403edfe54b1b8a2cddae03feac5715aa"><div class="ttname"><a href="namespace_tool.html#a403edfe54b1b8a2cddae03feac5715aa">Tool::delayMs</a></div><div class="ttdeci">void delayMs(uint16_t delay)</div><div class="ttdoc">Wait approximate the given number of milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="_tool_8cpp_source.html#l00031">Tool.cpp:31</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a6567b49e0c69f59ab36809eb013f948b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6567b49e0c69f59ab36809eb013f948b">◆ </a></span>modulateLed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Display::modulateLed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>pwmValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>One cycle of a modulated LED. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">color</td><td>The color for the cycle. </td></tr>
<tr><td class="paramname">pwmValue</td><td>The PWM value for the on state of the cycle. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_display_8cpp_source.html#l00049">49</a> of file <a class="el" href="_display_8cpp_source.html">Display.cpp</a>.</p>
<div class="fragment"><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>  <a class="code" href="namespace_hardware.html#a4bf62531670f7ce338200505ebfed3db">Hardware::setLedState</a>(static_cast<Hardware::LedState>(color));</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="namespace_tool.html#ad79aba50032180c22d50cfc0467cae61">Tool::delayCycles</a>(pwmValue);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="namespace_hardware.html#a4bf62531670f7ce338200505ebfed3db">Hardware::setLedState</a>(<a class="code" href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848ad4f123e7f67cd625e2a3422d21001441">Hardware::LED_Off</a>);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="namespace_tool.html#ad79aba50032180c22d50cfc0467cae61">Tool::delayCycles</a>(0xffu-pwmValue);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div><div class="ttc" id="namespace_tool_html_ad79aba50032180c22d50cfc0467cae61"><div class="ttname"><a href="namespace_tool.html#ad79aba50032180c22d50cfc0467cae61">Tool::delayCycles</a></div><div class="ttdeci">void delayCycles(uint8_t delay)</div><div class="ttdoc">Wait a very short time (CPU frequency depended). </div><div class="ttdef"><b>Definition:</b> <a href="_tool_8cpp_source.html#l00039">Tool.cpp:39</a></div></div>
<div class="ttc" id="namespace_hardware_html_acc409c97181a985b78dd4881c8656848ad4f123e7f67cd625e2a3422d21001441"><div class="ttname"><a href="namespace_hardware.html#acc409c97181a985b78dd4881c8656848ad4f123e7f67cd625e2a3422d21001441">Hardware::LED_Off</a></div><div class="ttdoc">The LED is off. </div><div class="ttdef"><b>Definition:</b> <a href="_hardware_8h_source.html#l00035">Hardware.h:35</a></div></div>
<div class="ttc" id="namespace_hardware_html_a4bf62531670f7ce338200505ebfed3db"><div class="ttname"><a href="namespace_hardware.html#a4bf62531670f7ce338200505ebfed3db">Hardware::setLedState</a></div><div class="ttdeci">void setLedState(LedState ledState)</div><div class="ttdoc">Enable or disable the status LEDs. </div><div class="ttdef"><b>Definition:</b> <a href="_hardware_8cpp_source.html#l00069">Hardware.cpp:69</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a16173933e3fed9fd3de4c25c82ee9074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16173933e3fed9fd3de4c25c82ee9074">◆ </a></span>pulse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Display::pulse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespace_display.html#ae90342f85dd0312c91e6c79041f8a577">Color</a> </td>
<td class="paramname"><em>color</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Smooth Pulse one time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">color</td><td>The color for the pulse. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_display_8cpp_source.html#l00058">58</a> of file <a class="el" href="_display_8cpp_source.html">Display.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">for</span> (uint8_t i = 1; i < <a class="code" href="namespace_configuration.html#a2a9f9d2b0a4cf56331bea54ddd6c696d">Configuration::cDisplayPulseMaximumPwm</a>; ++i) {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">for</span> (uint8_t j = 0; j < <a class="code" href="namespace_configuration.html#a07faa722b5c01f55e642fe860cb01b6c">Configuration::cDisplayPulseCyclesPerLevel</a>; ++j) {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="namespace_display.html#a6567b49e0c69f59ab36809eb013f948b">modulateLed</a>(color, i);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">for</span> (uint8_t i = Configuration::cDisplayPulseMaximumPwm; i > 1; --i) {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">for</span> (uint8_t j = 0; j < <a class="code" href="namespace_configuration.html#a07faa722b5c01f55e642fe860cb01b6c">Configuration::cDisplayPulseCyclesPerLevel</a>; ++j) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="namespace_display.html#a6567b49e0c69f59ab36809eb013f948b">modulateLed</a>(color, i);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</div><div class="ttc" id="namespace_display_html_a6567b49e0c69f59ab36809eb013f948b"><div class="ttname"><a href="namespace_display.html#a6567b49e0c69f59ab36809eb013f948b">Display::modulateLed</a></div><div class="ttdeci">void modulateLed(Color color, uint8_t pwmValue)</div><div class="ttdoc">One cycle of a modulated LED. </div><div class="ttdef"><b>Definition:</b> <a href="_display_8cpp_source.html#l00049">Display.cpp:49</a></div></div>
<div class="ttc" id="namespace_configuration_html_a07faa722b5c01f55e642fe860cb01b6c"><div class="ttname"><a href="namespace_configuration.html#a07faa722b5c01f55e642fe860cb01b6c">Configuration::cDisplayPulseCyclesPerLevel</a></div><div class="ttdeci">const uint8_t cDisplayPulseCyclesPerLevel</div><div class="ttdoc">The number of cycles for each PWM level. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00065">Configuration.h:65</a></div></div>
<div class="ttc" id="namespace_configuration_html_a2a9f9d2b0a4cf56331bea54ddd6c696d"><div class="ttname"><a href="namespace_configuration.html#a2a9f9d2b0a4cf56331bea54ddd6c696d">Configuration::cDisplayPulseMaximumPwm</a></div><div class="ttdeci">const uint8_t cDisplayPulseMaximumPwm</div><div class="ttdoc">The maximum PWM for a pulse. </div><div class="ttdef"><b>Definition:</b> <a href="_configuration_8h_source.html#l00061">Configuration.h:61</a></div></div>
</div><!-- fragment -->
</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_display.html">Display</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>