mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
211 lines
28 KiB
HTML
211 lines
28 KiB
HTML
<!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.6"/>
|
|
<title>ArduinoLibs: LCD.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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_48f64e79f12bd77ba047e9e436ec978c.html">LCD</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">LCD.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</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"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</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> <span class="preprocessor">#ifndef LCD_h</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_h</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Extended version of the LiquidCrystal library that works specifically</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// with Freetronics' 16x2 LCD display, including support for the back</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// light and the Up/Down/Left/Right/Select buttons. More info:</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// http://www.freetronics.com/pages/16x2-lcd-shield-quickstart-guide</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Include a copy of the standard LiquidCrystal library so we can extend it.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "utility/LiquidCrystal.h"</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Button event codes.</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define LCD_BUTTON_NONE 0</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_LEFT 1</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_RIGHT 2</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_UP 3</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_DOWN 4</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_SELECT 5</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_LEFT_RELEASED -1</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_RIGHT_RELEASED -2</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_UP_RELEASED -3</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_DOWN_RELEASED -4</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span><span class="preprocessor">#define LCD_BUTTON_SELECT_RELEASED -5</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classLCD.html"> 48</a></span> <span class="keyword">class </span><a class="code" href="classLCD.html">LCD</a> : <span class="keyword">public</span> LiquidCrystal {</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classLCD.html#a00bb2db1390721abc7b24ac4b8c276c8"> 50</a></span>  <a class="code" href="classLCD.html#a00bb2db1390721abc7b24ac4b8c276c8">LCD</a>() : LiquidCrystal(8, 9, 4, 5, 6, 7) { init(); }</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classLCD.html#a067bc741cf27f143aba5d9f147908401"> 51</a></span>  <a class="code" href="classLCD.html#a067bc741cf27f143aba5d9f147908401">LCD</a>(uint8_t pin9) : LiquidCrystal(8, pin9, 4, 5, 6, 7) { init(); }</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classLCD.html#a203d268bef6c61fa293562dbb0e9f51e"> 52</a></span>  <a class="code" href="classLCD.html#a203d268bef6c61fa293562dbb0e9f51e">LCD</a>(uint8_t rs, uint8_t enable,</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3)</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  : LiquidCrystal(rs, enable, d0, d1, d2, d3) { init(); }</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classLCD.html#a171f59ba80e7775ebd3a399f56482a9c"> 56</a></span>  uint8_t <a class="code" href="classLCD.html#a171f59ba80e7775ebd3a399f56482a9c">backlightPin</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _backlightPin; }</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> <a class="code" href="classLCD.html#a0b9b3b954290e7a3d94cdc829582b0a8">setBacklightPin</a>(uint8_t pin);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> <a class="code" href="classLCD.html#a5b07cf05e8e5e7c53654f5ca0cf58b89">display</a>();</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> <a class="code" href="classLCD.html#af3974da6d988ba2d21c25135ada12108">noDisplay</a>();</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28"> 62</a></span>  <span class="keyword">enum</span> <a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28">ScreenSaverMode</a></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a3f1e62d5fcd314d6ff067d3e74c4bf5f"> 64</a></span>  <a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a3f1e62d5fcd314d6ff067d3e74c4bf5f">DisplayOff</a>,</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a9931c078cfd1023c69f1da431f9a656c"> 65</a></span>  <a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a9931c078cfd1023c69f1da431f9a656c">BacklightOff</a>,</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a781f3c5e42506bf4f86ba06d69b23d35"> 66</a></span>  <a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a781f3c5e42506bf4f86ba06d69b23d35">BacklightOnSelect</a></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  };</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classLCD.html#a1917fa285f81f476b4c7cc20d15456b8"> 69</a></span>  <a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28">ScreenSaverMode</a> <a class="code" href="classLCD.html#a1917fa285f81f476b4c7cc20d15456b8">screenSaverMode</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mode; }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> <a class="code" href="classLCD.html#a56d1f68532c779c65fbbd071fb444801">setScreenSaverMode</a>(<a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28">ScreenSaverMode</a> mode);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="classLCD.html#af9a2326d034fa159d384ec16223c924f">enableScreenSaver</a>(<span class="keywordtype">int</span> timeoutSecs = 10);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> <a class="code" href="classLCD.html#a85c3a4694b105731404df36e35e5b26e">disableScreenSaver</a>();</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classLCD.html#af5d5ca618a3161aa352027b58fe09d0e"> 74</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classLCD.html#af5d5ca618a3161aa352027b58fe09d0e">isScreenSaved</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> screenSaved; }</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> <a class="code" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292">getButton</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> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint8_t _backlightPin;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> backlightInit;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> prevButton;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">int</span> debounceButton;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> lastRestore;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> lastDebounce;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">bool</span> screenSaved;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> eatRelease;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28">ScreenSaverMode</a> mode;</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> init();</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="classLCD_html_a56d1f68532c779c65fbbd071fb444801"><div class="ttname"><a href="classLCD.html#a56d1f68532c779c65fbbd071fb444801">LCD::setScreenSaverMode</a></div><div class="ttdeci">void setScreenSaverMode(ScreenSaverMode mode)</div><div class="ttdoc">Sets the current screen saver mode. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00283">LCD.cpp:283</a></div></div>
|
|
<div class="ttc" id="classLCD_html_ac1e80e2603bd1cf0276c36092c416292"><div class="ttname"><a href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292">LCD::getButton</a></div><div class="ttdeci">int getButton()</div><div class="ttdoc">Gets the next button press, release, or idle event. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00368">LCD.cpp:368</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a264bf94308c95d8598426e13dc8cdb28a781f3c5e42506bf4f86ba06d69b23d35"><div class="ttname"><a href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a781f3c5e42506bf4f86ba06d69b23d35">LCD::BacklightOnSelect</a></div><div class="ttdoc">Same as BacklightOff but the screen saver is only deactivated when Select is pressed; other buttons h...</div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00066">LCD.h:66</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a264bf94308c95d8598426e13dc8cdb28"><div class="ttname"><a href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28">LCD::ScreenSaverMode</a></div><div class="ttdeci">ScreenSaverMode</div><div class="ttdoc">Screen saver mode that controls the display and back light. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00062">LCD.h:62</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a203d268bef6c61fa293562dbb0e9f51e"><div class="ttname"><a href="classLCD.html#a203d268bef6c61fa293562dbb0e9f51e">LCD::LCD</a></div><div class="ttdeci">LCD(uint8_t rs, uint8_t enable, uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3)</div><div class="ttdoc">Initialize the Freetronics LCD display with custom pins. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00052">LCD.h:52</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a264bf94308c95d8598426e13dc8cdb28a9931c078cfd1023c69f1da431f9a656c"><div class="ttname"><a href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a9931c078cfd1023c69f1da431f9a656c">LCD::BacklightOff</a></div><div class="ttdoc">Turn off the back light but leave the display on when the screen saver is activated. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00065">LCD.h:65</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a0b9b3b954290e7a3d94cdc829582b0a8"><div class="ttname"><a href="classLCD.html#a0b9b3b954290e7a3d94cdc829582b0a8">LCD::setBacklightPin</a></div><div class="ttdeci">void setBacklightPin(uint8_t pin)</div><div class="ttdoc">Sets the back light pin for the LCD shield. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00197">LCD.cpp:197</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a00bb2db1390721abc7b24ac4b8c276c8"><div class="ttname"><a href="classLCD.html#a00bb2db1390721abc7b24ac4b8c276c8">LCD::LCD</a></div><div class="ttdeci">LCD()</div><div class="ttdoc">Initialize the Freetronics LCD display with the default pin assignment. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00050">LCD.h:50</a></div></div>
|
|
<div class="ttc" id="classLCD_html_af9a2326d034fa159d384ec16223c924f"><div class="ttname"><a href="classLCD.html#af9a2326d034fa159d384ec16223c924f">LCD::enableScreenSaver</a></div><div class="ttdeci">void enableScreenSaver(int timeoutSecs=10)</div><div class="ttdoc">Enables the screen saver and causes it to activate after timeoutSecs of inactivity on the buttons...</div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00309">LCD.cpp:309</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a067bc741cf27f143aba5d9f147908401"><div class="ttname"><a href="classLCD.html#a067bc741cf27f143aba5d9f147908401">LCD::LCD</a></div><div class="ttdeci">LCD(uint8_t pin9)</div><div class="ttdoc">Initialize the Freetronics LCD display for USBDroid. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00051">LCD.h:51</a></div></div>
|
|
<div class="ttc" id="classLCD_html_af3974da6d988ba2d21c25135ada12108"><div class="ttname"><a href="classLCD.html#af3974da6d988ba2d21c25135ada12108">LCD::noDisplay</a></div><div class="ttdeci">void noDisplay()</div><div class="ttdoc">Turns off the display of text on the LCD and the back light. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00238">LCD.cpp:238</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a264bf94308c95d8598426e13dc8cdb28a3f1e62d5fcd314d6ff067d3e74c4bf5f"><div class="ttname"><a href="classLCD.html#a264bf94308c95d8598426e13dc8cdb28a3f1e62d5fcd314d6ff067d3e74c4bf5f">LCD::DisplayOff</a></div><div class="ttdoc">Turn off both the display and the backlight when the screen saver is activated. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00064">LCD.h:64</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a85c3a4694b105731404df36e35e5b26e"><div class="ttname"><a href="classLCD.html#a85c3a4694b105731404df36e35e5b26e">LCD::disableScreenSaver</a></div><div class="ttdeci">void disableScreenSaver()</div><div class="ttdoc">Disables the screen saver. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00323">LCD.cpp:323</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a5b07cf05e8e5e7c53654f5ca0cf58b89"><div class="ttname"><a href="classLCD.html#a5b07cf05e8e5e7c53654f5ca0cf58b89">LCD::display</a></div><div class="ttdeci">void display()</div><div class="ttdoc">Turns on the display of text on the LCD and the back light. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8cpp_source.html#l00221">LCD.cpp:221</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a171f59ba80e7775ebd3a399f56482a9c"><div class="ttname"><a href="classLCD.html#a171f59ba80e7775ebd3a399f56482a9c">LCD::backlightPin</a></div><div class="ttdeci">uint8_t backlightPin() const </div><div class="ttdoc">Returns the pin that is being used to control the back light. The default is 3. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00056">LCD.h:56</a></div></div>
|
|
<div class="ttc" id="classLCD_html"><div class="ttname"><a href="classLCD.html">LCD</a></div><div class="ttdoc">Enhanced library for Freetronics 16x2 LCD shields. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00048">LCD.h:48</a></div></div>
|
|
<div class="ttc" id="classLCD_html_af5d5ca618a3161aa352027b58fe09d0e"><div class="ttname"><a href="classLCD.html#af5d5ca618a3161aa352027b58fe09d0e">LCD::isScreenSaved</a></div><div class="ttdeci">bool isScreenSaved() const </div><div class="ttdoc">Returns true if the screen has been saved; false otherwise. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00074">LCD.h:74</a></div></div>
|
|
<div class="ttc" id="classLCD_html_a1917fa285f81f476b4c7cc20d15456b8"><div class="ttname"><a href="classLCD.html#a1917fa285f81f476b4c7cc20d15456b8">LCD::screenSaverMode</a></div><div class="ttdeci">ScreenSaverMode screenSaverMode() const </div><div class="ttdoc">Returns the current screen saver mode; default is DisplayOff. </div><div class="ttdef"><b>Definition:</b> <a href="LCD_8h_source.html#l00069">LCD.h:69</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Nov 3 2017 10:48:53 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|