Files
ITEADLIB_Arduino_Nextion/doc/UserManual/index.html
shennongmin 9f7679c89b Update README.md
Signed-off-by: shennongmin <wupangfee@gmail.com>
2015-08-14 18:25:11 +08:00

111 lines
6.0 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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>Nextion User Manual: Main Page</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="Logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Nextion User Manual
</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 class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Nextion User Manual Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1>Nextion</h1>
<hr/>
<h1>Introduction</h1>
<p>Nextion Arduino library provides an easy-to-use way to manipulate Nextion serial displays. Users can use the libarry freely, either in commerical projects or open-source prjects, without any additional condiitons.</p>
<p>For more information about the Nextion display project, please visit <a href="http://wiki.iteadstudio.com/Nextion_HMI_Solution">the wiki。</a> The wiki provdies all the necessary technical documnets, quick start guide, tutorials, demos, as well as some useful resources.</p>
<p>To get your Nextion display, please visit <a href="http://imall.itead.cc/display/nextion.html">iMall.</a></p>
<p>To discuss the project? Request new features? Report a BUG? please visit the <a href="http://support.iteadstudio.com/discussions/1000058038">Forums</a></p>
<h1>Documentation</h1>
<p>Documentation includes <a href="http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/modules.html">Configuration</a>, <a href="http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/modules.html">Get Started</a> and <a href="http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/modules.html">Reference of Core API</a> , etc.</p>
<p>Online documentation: <a href="http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/index.html">http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/index.html</a>.</p>
<p>Offline documentation: <code>doc/UserManual/index.html</code> can be open in your browser.(For example, Chrome or the fucking one you like). </p><h1>Source</h1>
<p>Latest source code can be download at <a href="https://github.com/itead/ITEADLIB_Arduino_Nextion">https://github.com/itead/ITEADLIB_Arduino_Nextion</a>.</p>
<p>You can clone it by: </p><pre class="fragment">git clone https://github.com/itead/ITEADLIB_Arduino_Nextion
</pre><h1>Suppported Mainboards</h1>
<p><b>All boards, which has one or more hardware serial, can be supported.</b></p>
<p>For example:</p>
<ul>
<li>Iteaduino MEGA2560</li>
<li>Iteaduino UNO</li>
<li>Arduino MEGA2560</li>
<li>Arduino UNO</li>
</ul>
<h1>Configuration</h1>
<p>In configuration file <a class="el" href="_nex_config_8h.html" title="Options for user can be found here. ">NexConfig.h</a>, you can find two macros below:</p>
<ul>
<li>dbSerial: Debug Serial (baudrate:9600), needed by beginners for debug your nextion applications or sketches. If your complete your work, it will be a wise choice to disable Debug Serial.</li>
<li>nexSerial: Nextion Serial, the bridge of Nextion and your mainboard.</li>
</ul>
<p><b>Note:</b> the default configuration is for MEGA2560.</p>
<h2>Redirect dbSerial and nexSerial</h2>
<p>If you want to change the default serial to debug or communicate with Nextion , you need to modify the line in configuration file: </p><pre class="fragment">#define dbSerial Serial ---&gt; #define dbSerial Serialxxx
#define nexSerial Serial2 ---&gt; #define nexSeria Serialxxx
</pre><h2>Disable Debug Serial</h2>
<p>If you want to disable the debug information,you need to modify the line in configuration file: </p><pre class="fragment">#define DEBUG_SERIAL_ENABLE ---&gt; //#define DEBUG_SERIAL_ENABLE
</pre><h1>UNO-like Mainboards</h1>
<p>If your board has only one hardware serial, such as UNO, you should disable dbSerial and redirect nexSerial to Serial(Refer to section:<code>Serial configuration</code>).</p>
<h1>Useful Links</h1>
<p><a href="http://blog.iteadstudio.com/nextion-tutorial-based-on-nextion-arduino-library/">http://blog.iteadstudio.com/nextion-tutorial-based-on-nextion-arduino-library/</a></p>
<h1>License</h1>
<hr/>
<pre class="fragment">DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2014 ITEAD Studio
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
</pre><hr/>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 14 2015 18:24:34 for Nextion User Manual by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>