<!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: NexGpio Class 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="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><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="class_nex_gpio-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">NexGpio Class Reference</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:adbe08eb11827d75c6b2e9c935d9da19a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gpio.html#adbe08eb11827d75c6b2e9c935d9da19a">pin_mode</a> (uint32_t port, uint32_t mode, uint32_t control_id)</td></tr> <tr class="separator:adbe08eb11827d75c6b2e9c935d9da19a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaea4cb428fa0a2e26927073c20ed64ac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gpio.html#aaea4cb428fa0a2e26927073c20ed64ac">digital_write</a> (uint32_t port, uint32_t value)</td></tr> <tr class="separator:aaea4cb428fa0a2e26927073c20ed64ac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36386b97898f0960abda51c6010378eb"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gpio.html#a36386b97898f0960abda51c6010378eb">digital_read</a> (uint32_t port)</td></tr> <tr class="separator:a36386b97898f0960abda51c6010378eb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af21eb91b041d149193bc716202d4a462"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gpio.html#af21eb91b041d149193bc716202d4a462">analog_write</a> (uint32_t port, uint32_t value)</td></tr> <tr class="separator:af21eb91b041d149193bc716202d4a462"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a62c2cb633e321ef2273eb3a7af6a5b47"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gpio.html#a62c2cb633e321ef2273eb3a7af6a5b47">set_pwmfreq</a> (uint32_t value)</td></tr> <tr class="separator:a62c2cb633e321ef2273eb3a7af6a5b47"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8fca87ac0cdfbc8a62dec807b949c36d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gpio.html#a8fca87ac0cdfbc8a62dec807b949c36d">get_pwmfreq</a> (uint32_t *number)</td></tr> <tr class="separator:a8fca87ac0cdfbc8a62dec807b949c36d"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="af21eb91b041d149193bc716202d4a462"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool NexGpio::analog_write </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>value</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>writes an analog value (PWM wave) to a pin</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">port</td><td>- the gpio port number </td></tr> <tr><td class="paramname">value</td><td>- the duty cycle: between 0 (always off) and 100 (always on). </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if success, false for failure </dd></dl> </div> </div> <a class="anchor" id="a36386b97898f0960abda51c6010378eb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t NexGpio::digital_read </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>port</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read a high or a LOW value to a digital pin</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">port</td><td>- the gpio port number </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the value from a specified digital pin, either high or low </dd></dl> </div> </div> <a class="anchor" id="aaea4cb428fa0a2e26927073c20ed64ac"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool NexGpio::digital_write </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>value</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>write a high or a LOW value to a digital pin</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">port</td><td>- the gpio port number </td></tr> <tr><td class="paramname">mode</td><td>- the gpio port number </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if success, false for failure </dd></dl> </div> </div> <a class="anchor" id="a8fca87ac0cdfbc8a62dec807b949c36d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t NexGpio::get_pwmfreq </td> <td>(</td> <td class="paramtype">uint32_t * </td> <td class="paramname"><em>number</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read pwm output frequency</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">number</td><td>- the frequency </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if success, false for failure </dd></dl> </div> </div> <a class="anchor" id="adbe08eb11827d75c6b2e9c935d9da19a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool NexGpio::pin_mode </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>control_id</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set gpio mode</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">port</td><td>- the gpio port number </td></tr> <tr><td class="paramname">mode</td><td>- set gpio port mode(0–Pull on the input 1–the control input binding 2–Push-pull output 3–pwm output 4–open mode leakage) </td></tr> <tr><td class="paramname">control_id</td><td>- nextion controls id ,when the modeel is 1 to be valid </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if success, false for failure </dd></dl> </div> </div> <a class="anchor" id="a62c2cb633e321ef2273eb3a7af6a5b47"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool NexGpio::set_pwmfreq </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>writes pwm output frequency</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>- the frequency: between 1 and 65535 </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if success, false for failure </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="_nex_gpio_8h_source.html">NexGpio.h</a></li> <li><a class="el" href="_nex_gpio_8cpp.html">NexGpio.cpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Dec 1 2016 09:26:03 for My Project 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>