Mirrors/ITEADLIB_Arduino_Nextion
2
0
Fork 0
mirror of https://github.com/itead/ITEADLIB_Arduino_Nextion.git synced 2026-03-04 09:14:01 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f8e9b4e7f0729b0224bb58971a615c32fb127a91
ITEADLIB_Arduino_Nextion/doc/API/_nex_hardware_8cpp.html
shennongmin f8e9b4e7f0 Update docs 
Signed-off-by: shennongmin <wupangfee@gmail.com>
2015-08-13 18:11:45 +08:00

249 lines
12 KiB
HTML
Raw Blame History

<!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: NexHardware.cpp File Reference</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">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&#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 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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">NexHardware.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Hardware Srial API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="_nex_hardware_8h_source.html">NexHardware.h</a>&quot;</code><br />
</div>
<p><a href="_nex_hardware_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae26fbfe1541acac85ac10398be787852"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nex_hardware_8cpp.html#ae26fbfe1541acac85ac10398be787852">recvRetNumber</a> (uint32_t *number, uint32_t timeout)</td></tr>
<tr class="memdesc:ae26fbfe1541acac85ac10398be787852"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive uint32_t data. <a href="#ae26fbfe1541acac85ac10398be787852">More...</a><br /></td></tr>
<tr class="separator:ae26fbfe1541acac85ac10398be787852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f894a77fe0b93a26137e1d790c335fb"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nex_hardware_8cpp.html#a6f894a77fe0b93a26137e1d790c335fb">recvRetString</a> (char *buffer, uint16_t len, uint32_t timeout)</td></tr>
<tr class="memdesc:a6f894a77fe0b93a26137e1d790c335fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive string data. <a href="#a6f894a77fe0b93a26137e1d790c335fb">More...</a><br /></td></tr>
<tr class="separator:a6f894a77fe0b93a26137e1d790c335fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa382dfd2890722f1891f4924d87f2f79"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nex_hardware_8cpp.html#aa382dfd2890722f1891f4924d87f2f79">sendCommand</a> (const char *cmd)</td></tr>
<tr class="memdesc:aa382dfd2890722f1891f4924d87f2f79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send command to Nextion. <a href="#aa382dfd2890722f1891f4924d87f2f79">More...</a><br /></td></tr>
<tr class="separator:aa382dfd2890722f1891f4924d87f2f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fdd8b9f8bd1ea31e38af8d854c3c63f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nex_hardware_8cpp.html#a7fdd8b9f8bd1ea31e38af8d854c3c63f">recvRetCommandFinished</a> (uint32_t timeout)</td></tr>
<tr class="memdesc:a7fdd8b9f8bd1ea31e38af8d854c3c63f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command is executed successfully. <a href="#a7fdd8b9f8bd1ea31e38af8d854c3c63f">More...</a><br /></td></tr>
<tr class="separator:a7fdd8b9f8bd1ea31e38af8d854c3c63f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab09ddba6b72334d30ae091a7b038d790"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#gab09ddba6b72334d30ae091a7b038d790">nexInit</a> (void)</td></tr>
<tr class="memdesc:gab09ddba6b72334d30ae091a7b038d790"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init Nextion's baudrate,page id. <a href="group___nextion.html#gab09ddba6b72334d30ae091a7b038d790">More...</a><br /></td></tr>
<tr class="separator:gab09ddba6b72334d30ae091a7b038d790"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4200065e323c18e6b11e91a916d8475"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#gae4200065e323c18e6b11e91a916d8475">nexLoop</a> (<a class="el" href="class_nex_touch.html">NexTouch</a> **nex_listen_list)</td></tr>
<tr class="memdesc:gae4200065e323c18e6b11e91a916d8475"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call mainEventLoop,watting for Nextion's touch event. <a href="group___nextion.html#gae4200065e323c18e6b11e91a916d8475">More...</a><br /></td></tr>
<tr class="separator:gae4200065e323c18e6b11e91a916d8475"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Hardware Srial API. </p>
<dl class="section author"><dt>Author</dt><dd>Wu Pengfei (email:<a href="#" onclick="location.href='mai'+'lto:'+'pen'+'gf'+'ei.'+'wu'+'@it'+'ea'+'d.c'+'c'; return false;">pengf<span style="display: none;">.nosp@m.</span>ei.w<span style="display: none;">.nosp@m.</span>u@ite<span style="display: none;">.nosp@m.</span>ad.c<span style="display: none;">.nosp@m.</span>c</a>) </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2015/8/11 </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2014-2015 ITEAD Intelligent Systems Co., Ltd. <br />
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. </dd></dl>
<p>Definition in file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a7fdd8b9f8bd1ea31e38af8d854c3c63f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool recvRetCommandFinished </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Command is executed successfully. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>- set timeout time.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>- success. </td></tr>
<tr><td class="paramname">false</td><td>- failed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_hardware_8cpp_source.html#l00187">187</a> of file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae26fbfe1541acac85ac10398be787852"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool recvRetNumber </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive uint32_t data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>- save uint32_t data. </td></tr>
<tr><td class="paramname">timeout</td><td>- set timeout time.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>- success. </td></tr>
<tr><td class="paramname">false</td><td>- failed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_hardware_8cpp_source.html#l00045">45</a> of file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6f894a77fe0b93a26137e1d790c335fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t recvRetString </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive string data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>- save string data. </td></tr>
<tr><td class="paramname">len</td><td>- string buffer length. </td></tr>
<tr><td class="paramname">timeout</td><td>- set timeout time.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the length of string buffer. </dd></dl>
<p>Definition at line <a class="el" href="_nex_hardware_8cpp_source.html#l00097">97</a> of file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa382dfd2890722f1891f4924d87f2f79"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sendCommand </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>cmd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send command to Nextion. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cmd</td><td>- the string of command. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_hardware_8cpp_source.html#l00164">164</a> of file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 13 2015 18:10:27 for API 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>
Reference in New Issue View Git Blame Copy Permalink