iot-firmware/lib/ITEADLIB_Arduino_Nextion-ma.../html/index.html

156 lines
9.1 KiB
HTML
Raw Permalink Normal View History

2023-09-30 08:42:44 +00:00
<!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>My Project: Home 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Home Page </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>Download Source Code</h1>
<p>Latest version is unstable and a mass of change may be applied in a short time without any notification for users. Commonly, it is for developers of this library.</p>
<p><b>Release version is recommanded for you, unless you are one of developers of this library.</b></p>
<p><b>Release notes</b> is at <a href="https://github.com/itead/ITEADLIB_Arduino_Nextion/blob/master/release_notes.md">https://github.com/itead/ITEADLIB_Arduino_Nextion/blob/master/release_notes.md</a>.</p>
<h2>Latest(unstable)</h2>
<p>Latest source code(master branch) can be downloaded: <a href="https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/master.zip">https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/master.zip</a>.</p>
<p>You can also clone it via git: </p><pre class="fragment">git clone https://github.com/itead/ITEADLIB_Arduino_Nextion
</pre><h2>Releases(stable)</h2>
<ul>
<li><a href="https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.zip">https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.zip</a></li>
<li><a href="https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.tar.gz">https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.tar.gz</a></li>
</ul>
<p>All releases can be available from: <a href="https://github.com/itead/ITEADLIB_Arduino_Nextion/releases">https://github.com/itead/ITEADLIB_Arduino_Nextion/releases</a>.</p>
<h1>Documentation</h1>
<p><a href="http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/index.html">Latest Online Documentation</a> contains Configuration, Get Started, Reference of API and Examples, etc.</p>
<p>Offline Documentation's entry <code>doc/Documentation/index.html</code> shiped with source code can be open in your browser such as Chrome, Firefox or any one you like.</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>Configuration</h1>
<p>In configuration file <a class="el" href="_nex_config_8h.html">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 Thu Dec 1 2016 09:26:04 for My Project 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>