mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-03 16:54:00 +01:00
96 lines
5.6 KiB
HTML
96 lines
5.6 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: 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="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 class="current"><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><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">API Documentation</div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="textblock"><h1>Nextion Library for Arduino</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>
|
||
<p> </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>Documentation</h1>
|
||
<p>Online API documentation can be reached at <a href="http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/">http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/</a>.</p>
|
||
<p>Offline API documentation can be found under directory <a href="https://github.com/itead/ITEADLIB_Arduino_Nextion/tree/master/doc">doc</a>.</p>
|
||
<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>Serial configuration</h1>
|
||
<p>In configuration file <code><a class="el" href="_nex_serial_config_8h.html" title="Serial configure. ">NexSerialConfig.h</a></code>, 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 file <code><a class="el" href="_nex_serial_config_8h.html" title="Serial configure. ">NexSerialConfig.h</a></code>: </p><pre class="fragment">#define dbSerial Serial ---> #define dbSerial Serialxxx
|
||
#define nexSerial Serial2 ---> #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 file <code><a class="el" href="_nex_serial_config_8h.html" title="Serial configure. ">NexSerialConfig.h</a></code>: </p><pre class="fragment">#define DEBUG_SERIAL_ENABLE ---> //#define DEBUG_SERIAL_ENABLE
|
||
</pre><h1>UNO</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>
|
||
<hr/>
|
||
<p>DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE Version 2, December 2004</p>
|
||
<p>Copyright (C) 2014 ITEAD Studio</p>
|
||
<p>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. </p><pre class="fragment"> DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||
</pre><p>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</p>
|
||
<p>0. You just DO WHAT THE FUCK YOU WANT TO.</p>
|
||
<hr/>
|
||
</div></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>
|