mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-05 01:34:01 +01:00
216 lines
21 KiB
HTML
216 lines
21 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.7"/>
|
|
<title>Documentation: readme.md 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="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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="projectlogo"><img alt="Logo" src="Logo.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Documentation
|
|
</div>
|
|
<div id="projectbrief">For Arduino users</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.7 -->
|
|
<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><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</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('readme_8md.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">readme.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> @mainpage Home Page</div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"># Nextion</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</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> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"># Introduction</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> Nextion Arduino library provides an easy-to-use way to manipulate Nextion serial</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> displays. Users can use the libarry freely, either in commerical projects or </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> open-source prjects, without any additional condiitons. </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> For more information about the Nextion display project, please visit </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> [the wiki。](http:<span class="comment">//wiki.iteadstudio.com/Nextion_HMI_Solution) </span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> The wiki provdies all the necessary technical documnets, quick start guide, </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> tutorials, demos, as well as some useful resources.</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> To <span class="keyword">get</span> your Nextion display, please visit </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> [iMall.](http:<span class="comment">//imall.itead.cc/display/nextion.html)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> To discuss the project? Request <span class="keyword">new</span> features? Report a BUG? please visit the </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> [Forums](http:<span class="comment">//support.iteadstudio.com/discussions/1000058038)</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"># Download Source Code </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> Latest version is unstable and a mass of change may be applied in a <span class="keywordtype">short</span> time </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> without any notification <span class="keywordflow">for</span> users. Commonly, it is <span class="keywordflow">for</span> developers of <span class="keyword">this</span> </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> library. </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> **Release version is recommanded <span class="keywordflow">for</span> you, unless you are one of developers of <span class="keyword">this</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> library.**</div>
|
|
<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> **Release notes** is at</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion/blob/master/release_notes.md>.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">## Latest(unstable)</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> Latest source code(master branch) can be downloaded:</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion/archive/master.zip>. </span></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> You can also clone it via git:</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  git clone https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">## Releases(stable)</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  - https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.zip</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  - https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.tar.gz</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> All releases can be available from:</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion/releases>.</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"># Documentation</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> [Latest Online Documentation](http:<span class="comment">//docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/index.html)</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> contains Configuration, Get Started, Reference of API and Examples, etc.</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> Offline Documentation<span class="stringliteral">'s entry `doc/Documentation/index.html` shiped with source code</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="stringliteral">can be open in your browser such as Chrome, Firefox or any one you like. </span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="stringliteral"># Suppported Mainboards</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="stringliteral">**All boards, which has one or more hardware serial, can be supported.**</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="stringliteral">For example:</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="stringliteral"> - Iteaduino MEGA2560</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="stringliteral"> - Iteaduino UNO</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="stringliteral"> - Arduino MEGA2560</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="stringliteral"> - Arduino UNO</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="stringliteral"># Configuration</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="stringliteral">In configuration file NexConfig.h, you can find two macros below:</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="stringliteral"> - dbSerial: Debug Serial (baudrate:9600), needed by beginners for debug your </span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="stringliteral"> nextion applications or sketches. If your complete your work, it will be a </span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="stringliteral"> wise choice to disable Debug Serial.</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="stringliteral"> - nexSerial: Nextion Serial, the bridge of Nextion and your mainboard.</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="stringliteral">**Note:** the default configuration is for MEGA2560.</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="stringliteral">## Redirect dbSerial and nexSerial</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="stringliteral">If you want to change the default serial to debug or communicate with Nextion ,</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="stringliteral">you need to modify the line in configuration file:</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="stringliteral"> #define dbSerial Serial ---> #define dbSerial Serialxxx</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="stringliteral"> #define nexSerial Serial2 ---> #define nexSeria Serialxxx</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="stringliteral">## Disable Debug Serial</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="stringliteral">If you want to disable the debug information,you need to modify the line in </span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="stringliteral">configuration file:</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="stringliteral"> #define DEBUG_SERIAL_ENABLE ---> //#define DEBUG_SERIAL_ENABLE</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="stringliteral"># UNO-like Mainboards</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="stringliteral">If your board has only one hardware serial, such as UNO, you should disable </span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="stringliteral">dbSerial and redirect nexSerial to Serial(Refer to section:`Serial configuration`). </span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="stringliteral"># Useful Links</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="stringliteral"><http://blog.iteadstudio.com/nextion-tutorial-based-on-nextion-arduino-library/></span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="stringliteral"># License</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="stringliteral">-------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="stringliteral"> DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE </span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="stringliteral"> Version 2, December 2004 </span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="stringliteral"> Copyright (C) 2014 ITEAD Studio</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="stringliteral"> Everyone is permitted to copy and distribute verbatim or modified </span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="stringliteral"> copies of this license document, and changing it is allowed as long </span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="stringliteral"> as the name is changed. </span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="stringliteral"> DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE </span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="stringliteral"> TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION </span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="stringliteral"> 0. You just DO WHAT THE FUCK YOU WANT TO.</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="stringliteral">-------------------------------------------------------------------------------</span></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"><b>readme.md</b></li>
|
|
<li class="footer">Generated on Wed Nov 11 2015 15:49:30 for Documentation by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|