taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-29 08:32:07 +10:00
parent 64da24bbf6
commit 100a18a956
931 changed files with 1212 additions and 75896 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
LCD_8h_source.html
View File

@@ -139,7 +139,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<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>&#160; <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>&#160; <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"> 52</span>&#160; <a class="code" href="classLCD.html#a00bb2db1390721abc7b24ac4b8c276c8">LCD</a>(uint8_t rs, uint8_t enable,</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classLCD.html#a203d268bef6c61fa293562dbb0e9f51e"> 52</a></span>&#160; <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>&#160; 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>&#160; : LiquidCrystal(rs, enable, d0, d1, d2, d3) { init(); }</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
@@ -181,19 +181,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;};</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<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#l00268">LCD.cpp:268</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#l00353">LCD.cpp:353</a></div></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#l00182">LCD.cpp:182</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#l00294">LCD.cpp:294</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#l00223">LCD.cpp:223</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#l00308">LCD.cpp:308</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#l00206">LCD.cpp:206</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>
@@ -201,7 +202,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 25 2015 19:36:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Mar 29 2015 08:30:13 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>