mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-03 16:54:00 +01:00
152 lines
14 KiB
HTML
152 lines
14 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>API: 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="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="ITEAD-logo.JPG"/></td>
|
||
<td style="padding-left: 0.5em;">
|
||
<div id="projectname">API
|
||
</div>
|
||
<div id="projectbrief">For Arduino developers</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="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 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</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 Library for Arduino </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> Nextion Arduino library provides an easy-to-use way to manipulate Nextion serial displays. </div>
|
||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> Users can use the libarry freely, either in commerical projects or open-source prjects, without any additional condiitons. </div>
|
||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
|
||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> For more information about the Nextion display project, please visit [the wiki。](http:<span class="comment">//wiki.iteadstudio.com/Nextion_HMI_Solution) </span></div>
|
||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> The wiki provdies all the necessary technical documnets, quick start guide, tutorials, demos, as well as some useful resources.</div>
|
||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
|
||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> To <span class="keyword">get</span> your Nextion display, please visit [iMall.](http:<span class="comment">//imall.itead.cc/display/nextion.html)</span></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> To discuss the project? Request <span class="keyword">new</span> features? Report a BUG? please visit the [Forums](http:<span class="comment">//support.iteadstudio.com/discussions/1000058038)</span></div>
|
||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"># Source </span></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> Latest source code can be download at https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion.</span></div>
|
||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> You can clone it by:</div>
|
||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  git clone https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion</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"># Documentation</span></div>
|
||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> Online API documentation can be reached at <http:<span class="comment">//docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/>.</span></div>
|
||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> Offline API documentation can be found under directory </div>
|
||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> [doc](https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_Nextion/tree/master/doc).</span></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> <span class="preprocessor"># Suppported Mainboards:</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> **All boards, which has one or more hardware serial, can be supported.**</div>
|
||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> For example:</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>  - Iteaduino MEGA2560</div>
|
||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  - Iteaduino UNO</div>
|
||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  - Arduino MEGA2560</div>
|
||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  - Arduino UNO</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> <span class="preprocessor"># Serial configuration</span></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> In configuration file `NexSerialConfig.h`, you can find two macros below:</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>  - dbSerial: Debug Serial (baudrate:9600), needed by beginners <span class="keywordflow">for</span> debug your nextion applications or sketches. If</div>
|
||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  your complete your work, it will be a wise choice to disable Debug Serial.</div>
|
||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  - nexSerial: Nextion Serial, the bridge of Nextion and your mainboard.</div>
|
||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> **Note:** the <span class="keywordflow">default</span> configuration is <span class="keywordflow">for</span> MEGA2560.</div>
|
||
<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> ## Redirect dbSerial and nexSerial</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> If you want to change the <span class="keywordflow">default</span> serial to debug or communicate with Nextion ,</div>
|
||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> you need to modify the line in file `NexSerialConfig.h`:</div>
|
||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"> #define dbSerial Serial ---> #define dbSerial Serialxxx</span></div>
|
||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"> #define nexSerial Serial2 ---> #define nexSeria Serialxxx</span></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="preprocessor">## Disable Debug Serial</span></div>
|
||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> If you want to disable the debug information,you need to modify the line in file </div>
|
||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> `NexSerialConfig.h`:</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> <span class="preprocessor"> #define DEBUG_SERIAL_ENABLE ---> //#define DEBUG_SERIAL_ENABLE</span></div>
|
||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"># UNO</span></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> If your board has only one hardware serial, such as UNO, you should disable </div>
|
||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> dbSerial and redirect nexSerial to Serial(Refer to section:`Serial configuration`). </div>
|
||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </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> -------------------------------------------------------------------------------</div>
|
||
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
||
<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>  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE </div>
|
||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  Version 2, December 2004 </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>  Copyright (C) 2014 ITEAD Studio</div>
|
||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
||
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  Everyone is permitted to copy and distribute verbatim or modified </div>
|
||
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  copies of <span class="keyword">this</span> license document, and changing it is allowed as <span class="keywordtype">long</span> </div>
|
||
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  as the name is changed. </div>
|
||
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
|
||
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE </div>
|
||
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
||
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION </div>
|
||
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
|
||
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  0. You just DO WHAT THE FUCK YOU WANT TO.</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> </div>
|
||
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> -------------------------------------------------------------------------------</div>
|
||
</div><!-- fragment --></div><!-- contents -->
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer"><small>
|
||
Generated on Thu Jul 30 2015 11:21:33 for API by  <a href="http://www.doxygen.org/index.html">
|
||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
</a> 1.8.7
|
||
</small></address>
|
||
</body>
|
||
</html>
|