Klagarge/Solar-Panel
Archived
1
0
Fork 0
Code Issues Pull Requests Activity

doxygen - main.c

Browse Source
This commit is contained in:
Rémi Heredero
2023-03-15 12:55:57 +01:00
parent f7102d8aa1
commit 719fdc1c14
415 changed files with 47526 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

783
html/group__ft5xx6.html Normal file
View File

@@ -0,0 +1,783 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Solar panel: FT5xx6 Touch Controllers Driver</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Solar panel
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__ft5xx6.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">FT5xx6 Touch Controllers Driver<div class="ingroups"><a class="el" href="group__middlewaregroup.html">Middleware</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>FT5xx6 Touch Controller Driver API Reference.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__ft5xx6__registers"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6__registers.html">FT5xx6 Registers</a></td></tr>
<tr class="memdesc:group__ft5xx6__registers"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Registers List. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__ft5xx6__settings"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6__settings.html">FT5xx6 Settings</a></td></tr>
<tr class="memdesc:group__ft5xx6__settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Settings List. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6fc0a86342900baa3663aba412e2e4b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga6fc0a86342900baa3663aba412e2e4b2">ft5xx6_cfg_setup</a> (<a class="el" href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a> *cfg, const <a class="el" href="structft5xx6__controller__t.html">ft5xx6_controller_t</a> *controller)</td></tr>
<tr class="memdesc:ga6fc0a86342900baa3663aba412e2e4b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Configuration Object Setup Function. <br /></td></tr>
<tr class="separator:ga6fc0a86342900baa3663aba412e2e4b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6bc20225d2c49cbddb2f167b7e59633a"><td class="memItemLeft" align="right" valign="top">tp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga6bc20225d2c49cbddb2f167b7e59633a">ft5xx6_init</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, <a class="el" href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a> *cfg, tp_drv_t *drv)</td></tr>
<tr class="memdesc:ga6bc20225d2c49cbddb2f167b7e59633a"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Initialization Function. <br /></td></tr>
<tr class="separator:ga6bc20225d2c49cbddb2f167b7e59633a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac8898b7e2f9ae2c1eef7614ba35d42a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#gac8898b7e2f9ae2c1eef7614ba35d42a2">ft5xx6_default_cfg</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx)</td></tr>
<tr class="memdesc:gac8898b7e2f9ae2c1eef7614ba35d42a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Default Configuration Function. <br /></td></tr>
<tr class="separator:gac8898b7e2f9ae2c1eef7614ba35d42a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac41bf915d507197704db9dad23977959"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#gac41bf915d507197704db9dad23977959">ft5xx6_generic_write</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, uint8_t reg_addr, uint8_t data_in)</td></tr>
<tr class="memdesc:gac41bf915d507197704db9dad23977959"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Generic Write Function. <br /></td></tr>
<tr class="separator:gac41bf915d507197704db9dad23977959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22ffcf2f7a0e4bac3fda6a0af97bf4a8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga22ffcf2f7a0e4bac3fda6a0af97bf4a8">ft5xx6_generic_read_single</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, uint8_t reg_addr)</td></tr>
<tr class="memdesc:ga22ffcf2f7a0e4bac3fda6a0af97bf4a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Generic Single Read Function. <br /></td></tr>
<tr class="separator:ga22ffcf2f7a0e4bac3fda6a0af97bf4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf98c43602d87923c5820219931906d5c"><td class="memItemLeft" align="right" valign="top">tp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#gaf98c43602d87923c5820219931906d5c">ft5xx6_generic_read_multiple</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, uint8_t reg_addr, uint8_t *data_out, uint16_t n_bytes)</td></tr>
<tr class="memdesc:gaf98c43602d87923c5820219931906d5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Generic Multiple Read Function. <br /></td></tr>
<tr class="separator:gaf98c43602d87923c5820219931906d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga806e32ed83d7f3e41a3e9084148512b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga806e32ed83d7f3e41a3e9084148512b0">ft5xx6_dev_mode_setup</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, <a class="el" href="ft5xx6_8h.html#a8ea77e4f3a5aed6d16e5b3ccc934471d">ft5xx6_dev_mode_t</a> mode)</td></tr>
<tr class="memdesc:ga806e32ed83d7f3e41a3e9084148512b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Device Mode Setup Function. <br /></td></tr>
<tr class="separator:ga806e32ed83d7f3e41a3e9084148512b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0db7f121c8041d18fd70616a74669552"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga0db7f121c8041d18fd70616a74669552">ft5xx6_run_mode_setup</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, <a class="el" href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872d">ft5xx6_run_mode_t</a> mode)</td></tr>
<tr class="memdesc:ga0db7f121c8041d18fd70616a74669552"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Run Mode Setup Function. <br /></td></tr>
<tr class="separator:ga0db7f121c8041d18fd70616a74669552"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7bec3e5973ca8b94132ea761deaadeed"><td class="memItemLeft" align="right" valign="top">tp_event_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga7bec3e5973ca8b94132ea761deaadeed">ft5xx6_press_detect</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx)</td></tr>
<tr class="memdesc:ga7bec3e5973ca8b94132ea761deaadeed"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Touch Pressure Detect Function. <br /></td></tr>
<tr class="separator:ga7bec3e5973ca8b94132ea761deaadeed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga652c22955075ea78a37bc3c0b04d03ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga652c22955075ea78a37bc3c0b04d03ce">ft5xx6_press_coordinates</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, tp_touch_item_t *touch_item)</td></tr>
<tr class="memdesc:ga652c22955075ea78a37bc3c0b04d03ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Pressure Coordinates Check Function. <br /></td></tr>
<tr class="separator:ga652c22955075ea78a37bc3c0b04d03ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95c5b63b7e75eeb71a9633205bea6a04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#ga95c5b63b7e75eeb71a9633205bea6a04">ft5xx6_gesture</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx, tp_event_t *event)</td></tr>
<tr class="memdesc:ga95c5b63b7e75eeb71a9633205bea6a04"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Gesture Check Function. <br /></td></tr>
<tr class="separator:ga95c5b63b7e75eeb71a9633205bea6a04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadcca9f3cbaca156e26894a63d8f588ee"><td class="memItemLeft" align="right" valign="top">tp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ft5xx6.html#gadcca9f3cbaca156e26894a63d8f588ee">ft5xx6_process</a> (<a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *ctx)</td></tr>
<tr class="memdesc:gadcca9f3cbaca156e26894a63d8f588ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">FT5xx6 Process Function. <br /></td></tr>
<tr class="separator:gadcca9f3cbaca156e26894a63d8f588ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>FT5xx6 Touch Controller Driver API Reference. </p>
<p>API for configuring and manipulating FT5xx6 Touch Controller driver.</p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga6fc0a86342900baa3663aba412e2e4b2" name="ga6fc0a86342900baa3663aba412e2e4b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6fc0a86342900baa3663aba412e2e4b2">&#9670;&#160;</a></span>ft5xx6_cfg_setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_cfg_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a> *&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structft5xx6__controller__t.html">ft5xx6_controller_t</a> *&#160;</td>
<td class="paramname"><em>controller</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Configuration Object Setup Function. </p>
<p>This function initializes FT5xx6 configuration structure to default values. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">cfg</td><td>: FT5xx6 configuration object. See <a class="el" href="structft5xx6__cfg__t.html" title="FT5xx6 Configuration Object.">ft5xx6_cfg_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">controller</td><td>: Touch controller selector from FT5xx6 series touch controllers. See <a class="el" href="structft5xx6__controller__t.html" title="FT5xx6 Gesture Items.">ft5xx6_controller_t</a> structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The all used pins will be set to unconnected state.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 configuration object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a> ft5xx6_cfg;</div>
<div class="line"><span class="comment">// FT5x26 series touch controllers descriptor.</span></div>
<div class="line"><span class="keyword">const</span> <a class="code hl_struct" href="structft5xx6__controller__t.html">ft5xx6_controller_t</a> <a class="code hl_variable" href="ft5xx6_8c.html#a0ac92b9acaa49529e8ea5fea04471631">FT5X26_CONTROLLER</a> =</div>
<div class="line">{</div>
<div class="line"> {</div>
<div class="line"> { 0x00, TP_EVENT_GEST_NONE },</div>
<div class="line"> { 0x1C, TP_EVENT_GEST_LEFT },</div>
<div class="line"> { 0x14, TP_EVENT_GEST_RIGHT },</div>
<div class="line"> { 0x10, TP_EVENT_GEST_UP },</div>
<div class="line"> { 0x18, TP_EVENT_GEST_DOWN },</div>
<div class="line"> { 0x48, TP_EVENT_GEST_ZOOM_IN },</div>
<div class="line"> { 0x49, TP_EVENT_GEST_ZOOM_OUT }</div>
<div class="line"> }</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// FT5xx6 configuration setup.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga6fc0a86342900baa3663aba412e2e4b2">ft5xx6_cfg_setup</a>( &amp;ft5xx6_cfg, &amp;<a class="code hl_variable" href="ft5xx6_8c.html#a0ac92b9acaa49529e8ea5fea04471631">FT5X26_CONTROLLER</a> );</div>
<div class="ttc" id="aft5xx6_8c_html_a0ac92b9acaa49529e8ea5fea04471631"><div class="ttname"><a href="ft5xx6_8c.html#a0ac92b9acaa49529e8ea5fea04471631">FT5X26_CONTROLLER</a></div><div class="ttdeci">const ft5xx6_controller_t FT5X26_CONTROLLER</div><div class="ttdoc">FT5x26 Touch Controllers Descriptor.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00079">ft5xx6.c:79</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_ga6fc0a86342900baa3663aba412e2e4b2"><div class="ttname"><a href="group__ft5xx6.html#ga6fc0a86342900baa3663aba412e2e4b2">ft5xx6_cfg_setup</a></div><div class="ttdeci">void ft5xx6_cfg_setup(ft5xx6_cfg_t *cfg, const ft5xx6_controller_t *controller)</div><div class="ttdoc">FT5xx6 Configuration Object Setup Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00129">ft5xx6.c:129</a></div></div>
<div class="ttc" id="astructft5xx6__cfg__t_html"><div class="ttname"><a href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a></div><div class="ttdoc">FT5xx6 Configuration Object.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00570">ft5xx6.h:571</a></div></div>
<div class="ttc" id="astructft5xx6__controller__t_html"><div class="ttname"><a href="structft5xx6__controller__t.html">ft5xx6_controller_t</a></div><div class="ttdoc">FT5xx6 Gesture Items.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00560">ft5xx6.h:561</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00129">129</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="gac8898b7e2f9ae2c1eef7614ba35d42a2" name="gac8898b7e2f9ae2c1eef7614ba35d42a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8898b7e2f9ae2c1eef7614ba35d42a2">&#9670;&#160;</a></span>ft5xx6_default_cfg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_default_cfg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Default Configuration Function. </p>
<p>This function puts the FT5xx6 touch controller to normal operating mode. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>It's necessary for this functon to be executed after Initialization function for properly working of entire driver.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// FT5xx6 driver default configuration.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#gac8898b7e2f9ae2c1eef7614ba35d42a2">ft5xx6_default_cfg</a>( &amp;ft5xx6 );</div>
<div class="ttc" id="agroup__ft5xx6_html_gac8898b7e2f9ae2c1eef7614ba35d42a2"><div class="ttname"><a href="group__ft5xx6.html#gac8898b7e2f9ae2c1eef7614ba35d42a2">ft5xx6_default_cfg</a></div><div class="ttdeci">void ft5xx6_default_cfg(ft5xx6_t *ctx)</div><div class="ttdoc">FT5xx6 Default Configuration Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00192">ft5xx6.c:192</a></div></div>
<div class="ttc" id="astructft5xx6__t_html"><div class="ttname"><a href="structft5xx6__t.html">ft5xx6_t</a></div><div class="ttdoc">FT5xx6 Context Object.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00584">ft5xx6.h:585</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00192">192</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga806e32ed83d7f3e41a3e9084148512b0" name="ga806e32ed83d7f3e41a3e9084148512b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga806e32ed83d7f3e41a3e9084148512b0">&#9670;&#160;</a></span>ft5xx6_dev_mode_setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_dev_mode_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ft5xx6_8h.html#a8ea77e4f3a5aed6d16e5b3ccc934471d">ft5xx6_dev_mode_t</a>&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Device Mode Setup Function. </p>
<p>This function puts the FT5xx6 series touch controllers to the selected device mode. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>: device mode of operation. See <a class="el" href="ft5xx6_8h.html#a8ea77e4f3a5aed6d16e5b3ccc934471d" title="FT5xx6 Device Mode Settings.">ft5xx6_dev_mode_t</a> for valid values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Setting device normal operating mode of FT5xx6 series touch controllers.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga806e32ed83d7f3e41a3e9084148512b0">ft5xx6_dev_mode_setup</a>( &amp;ft5xx6, <a class="code hl_enumvalue" href="ft5xx6_8h.html#a8ea77e4f3a5aed6d16e5b3ccc934471dab9617f547a5f9e5d7149a1d56d441b4b">FT5XX6_DEV_MODE_NORMAL</a> );</div>
<div class="ttc" id="aft5xx6_8h_html_a8ea77e4f3a5aed6d16e5b3ccc934471dab9617f547a5f9e5d7149a1d56d441b4b"><div class="ttname"><a href="ft5xx6_8h.html#a8ea77e4f3a5aed6d16e5b3ccc934471dab9617f547a5f9e5d7149a1d56d441b4b">FT5XX6_DEV_MODE_NORMAL</a></div><div class="ttdeci">@ FT5XX6_DEV_MODE_NORMAL</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00525">ft5xx6.h:525</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_ga806e32ed83d7f3e41a3e9084148512b0"><div class="ttname"><a href="group__ft5xx6.html#ga806e32ed83d7f3e41a3e9084148512b0">ft5xx6_dev_mode_setup</a></div><div class="ttdeci">void ft5xx6_dev_mode_setup(ft5xx6_t *ctx, ft5xx6_dev_mode_t mode)</div><div class="ttdoc">FT5xx6 Device Mode Setup Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00243">ft5xx6.c:243</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00243">243</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="gaf98c43602d87923c5820219931906d5c" name="gaf98c43602d87923c5820219931906d5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf98c43602d87923c5820219931906d5c">&#9670;&#160;</a></span>ft5xx6_generic_read_multiple()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tp_err_t ft5xx6_generic_read_multiple </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>data_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>n_bytes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Generic Multiple Read Function. </p>
<p>This function allows user to read the desired number of data bytes, starting from the selected register address. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>: Register address which from the data reading will be started. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data_out</td><td>: Memory where read data will be stored. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n_bytes</td><td>: Number of data bytes to be read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code> - OK, </li>
<li><code>6</code> - Number of transfered bytes is out of range. See #tp_err_t structure definition for detailed explanation.</li>
</ul>
<b>Example</b> <div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// Read value.</span></div>
<div class="line">uint8_t read_data[ 2 ];</div>
<div class="line"><span class="comment">// TP error code.</span></div>
<div class="line">tp_err_t error;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Reading two data bytes to get x coordinate value of touch1.</span></div>
<div class="line">error = <a class="code hl_function" href="group__ft5xx6.html#gaf98c43602d87923c5820219931906d5c">ft5xx6_generic_read_multiple</a>( &amp;ft5xx6, <a class="code hl_define" href="group__ft5xx6__registers.html#gaec80f3f0e4f4353a2aec7531a9db05ef">FT5XX6_REG_TOUCH1_XH</a>,</div>
<div class="line"> read_data, 2 );</div>
<div class="ttc" id="agroup__ft5xx6__registers_html_gaec80f3f0e4f4353a2aec7531a9db05ef"><div class="ttname"><a href="group__ft5xx6__registers.html#gaec80f3f0e4f4353a2aec7531a9db05ef">FT5XX6_REG_TOUCH1_XH</a></div><div class="ttdeci">#define FT5XX6_REG_TOUCH1_XH</div><div class="ttdoc">FT5xx6 Touch1 X-coord MSB Register.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00101">ft5xx6.h:101</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_gaf98c43602d87923c5820219931906d5c"><div class="ttname"><a href="group__ft5xx6.html#gaf98c43602d87923c5820219931906d5c">ft5xx6_generic_read_multiple</a></div><div class="ttdeci">tp_err_t ft5xx6_generic_read_multiple(ft5xx6_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint16_t n_bytes)</div><div class="ttdoc">FT5xx6 Generic Multiple Read Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00224">ft5xx6.c:224</a></div></div>
</div><!-- fragment --> </dd></dl>
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00224">224</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga22ffcf2f7a0e4bac3fda6a0af97bf4a8" name="ga22ffcf2f7a0e4bac3fda6a0af97bf4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga22ffcf2f7a0e4bac3fda6a0af97bf4a8">&#9670;&#160;</a></span>ft5xx6_generic_read_single()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ft5xx6_generic_read_single </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg_addr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Generic Single Read Function. </p>
<p>This function allows user to read any desired register of the FT5xx6 series touch controllers. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>: Register address which from data be read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>8-bit read data.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// Read value.</span></div>
<div class="line">uint8_t read_data;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Reading status of FT5xx6 controller to get number of pressed touches.</span></div>
<div class="line">read_data = <a class="code hl_function" href="group__ft5xx6.html#ga22ffcf2f7a0e4bac3fda6a0af97bf4a8">ft5xx6_generic_read_single</a>( &amp;ft5xx6, <a class="code hl_define" href="group__ft5xx6__registers.html#ga005eda4b759f90b7a1b684e39adf2b6f">FT5XX6_REG_TD_STATUS</a> );</div>
<div class="ttc" id="agroup__ft5xx6__registers_html_ga005eda4b759f90b7a1b684e39adf2b6f"><div class="ttname"><a href="group__ft5xx6__registers.html#ga005eda4b759f90b7a1b684e39adf2b6f">FT5XX6_REG_TD_STATUS</a></div><div class="ttdeci">#define FT5XX6_REG_TD_STATUS</div><div class="ttdoc">FT5xx6 Status Register.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00094">ft5xx6.h:94</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_ga22ffcf2f7a0e4bac3fda6a0af97bf4a8"><div class="ttname"><a href="group__ft5xx6.html#ga22ffcf2f7a0e4bac3fda6a0af97bf4a8">ft5xx6_generic_read_single</a></div><div class="ttdeci">uint8_t ft5xx6_generic_read_single(ft5xx6_t *ctx, uint8_t reg_addr)</div><div class="ttdoc">FT5xx6 Generic Single Read Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00212">ft5xx6.c:212</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00212">212</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="gac41bf915d507197704db9dad23977959" name="gac41bf915d507197704db9dad23977959"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac41bf915d507197704db9dad23977959">&#9670;&#160;</a></span>ft5xx6_generic_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_generic_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data_in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Generic Write Function. </p>
<p>This function allows user to write any 8-bit data to the selected register of the FT5xx6 series touch controllers. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>: Register address where data be written. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data_in</td><td>: Data to be written. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Setting FT5xx6 controller to configuration mode.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#gac41bf915d507197704db9dad23977959">ft5xx6_generic_write</a>( &amp;ft5xx6, <a class="code hl_define" href="group__ft5xx6__registers.html#gabae27c2f3c8c464b2e4a39c932ebd084">FT5XX6_REG_RUNNING_STATE</a>,</div>
<div class="line"> <a class="code hl_enumvalue" href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872dadaab43c87f17aae1b5f9b9d476b8f659">FT5XX6_RUN_MODE_CFG</a> );</div>
<div class="ttc" id="aft5xx6_8h_html_a0d658e59cb50288d2a7fdb53462b872dadaab43c87f17aae1b5f9b9d476b8f659"><div class="ttname"><a href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872dadaab43c87f17aae1b5f9b9d476b8f659">FT5XX6_RUN_MODE_CFG</a></div><div class="ttdeci">@ FT5XX6_RUN_MODE_CFG</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00537">ft5xx6.h:537</a></div></div>
<div class="ttc" id="agroup__ft5xx6__registers_html_gabae27c2f3c8c464b2e4a39c932ebd084"><div class="ttname"><a href="group__ft5xx6__registers.html#gabae27c2f3c8c464b2e4a39c932ebd084">FT5XX6_REG_RUNNING_STATE</a></div><div class="ttdeci">#define FT5XX6_REG_RUNNING_STATE</div><div class="ttdoc">FT5xx6 Running State Register.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00353">ft5xx6.h:353</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_gac41bf915d507197704db9dad23977959"><div class="ttname"><a href="group__ft5xx6.html#gac41bf915d507197704db9dad23977959">ft5xx6_generic_write</a></div><div class="ttdeci">void ft5xx6_generic_write(ft5xx6_t *ctx, uint8_t reg_addr, uint8_t data_in)</div><div class="ttdoc">FT5xx6 Generic Write Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00201">ft5xx6.c:201</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00201">201</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga95c5b63b7e75eeb71a9633205bea6a04" name="ga95c5b63b7e75eeb71a9633205bea6a04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95c5b63b7e75eeb71a9633205bea6a04">&#9670;&#160;</a></span>ft5xx6_gesture()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_gesture </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tp_event_t *&#160;</td>
<td class="paramname"><em>event</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Gesture Check Function. </p>
<p>This function allows user to get the informations about the gesture (slide direction). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>: Touch panel gesture data. See #tp_event_t structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing. </dd></dl>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="group__ft5xx6.html#gadcca9f3cbaca156e26894a63d8f588ee" title="FT5xx6 Process Function.">ft5xx6_process</a> function must be called to update all events.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// Gesture event.</span></div>
<div class="line">tp_event_t event;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Checking slide direction event of pressed touch.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga95c5b63b7e75eeb71a9633205bea6a04">ft5xx6_gesture</a>( &amp;ft5xx6, &amp;event );</div>
<div class="ttc" id="agroup__ft5xx6_html_ga95c5b63b7e75eeb71a9633205bea6a04"><div class="ttname"><a href="group__ft5xx6.html#ga95c5b63b7e75eeb71a9633205bea6a04">ft5xx6_gesture</a></div><div class="ttdeci">void ft5xx6_gesture(ft5xx6_t *ctx, tp_event_t *event)</div><div class="ttdoc">FT5xx6 Gesture Check Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00276">ft5xx6.c:276</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00276">276</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga6bc20225d2c49cbddb2f167b7e59633a" name="ga6bc20225d2c49cbddb2f167b7e59633a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bc20225d2c49cbddb2f167b7e59633a">&#9670;&#160;</a></span>ft5xx6_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tp_err_t ft5xx6_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a> *&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tp_drv_t *&#160;</td>
<td class="paramname"><em>drv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Initialization Function. </p>
<p>This function initializes FT5xx6 context object to default values and allows driver interface object to be linked with FT5xx6 driver functions. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td>: FT5xx6 configuration object. See <a class="el" href="structft5xx6__cfg__t.html" title="FT5xx6 Configuration Object.">ft5xx6_cfg_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">drv</td><td>: TP driver interface object. See #tp_drv_t structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code> - OK, </li>
<li><code>1</code> - I2C driver init error, </li>
<li><code>2</code> - Unsupported pin. See #tp_err_t structure definition for detailed explanation.</li>
</ul>
<b>Example</b> <div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// FT5xx6 configuration object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__cfg__t.html">ft5xx6_cfg_t</a> ft5xx6_cfg;</div>
<div class="line"><span class="comment">// FT5x26 series touch controllers descriptor.</span></div>
<div class="line"><span class="keyword">const</span> <a class="code hl_struct" href="structft5xx6__controller__t.html">ft5xx6_controller_t</a> <a class="code hl_variable" href="ft5xx6_8c.html#a0ac92b9acaa49529e8ea5fea04471631">FT5X26_CONTROLLER</a>;</div>
<div class="line"><span class="comment">// TP driver interface object.</span></div>
<div class="line">tp_drv_t tp_interface;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// FT5xx6 configuration setup.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga6fc0a86342900baa3663aba412e2e4b2">ft5xx6_cfg_setup</a>( &amp;ft5xx6_cfg, &amp;<a class="code hl_variable" href="ft5xx6_8c.html#a0ac92b9acaa49529e8ea5fea04471631">FT5X26_CONTROLLER</a> );</div>
<div class="line"><span class="comment">// FT5xx6 controller pin mapping.</span></div>
<div class="line"><a class="code hl_define" href="group__ft5xx6__settings.html#ga782865f91f11bdbc5712b01cc507e5b2">FT5XX6_MAP_PINS</a>( ft5xx6_cfg );</div>
<div class="line"><span class="comment">// FT5xx6 driver initialization.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga6bc20225d2c49cbddb2f167b7e59633a">ft5xx6_init</a>( &amp;ft5xx6, &amp;ft5xx6_cfg, &amp;tp_interface );</div>
<div class="ttc" id="agroup__ft5xx6__settings_html_ga782865f91f11bdbc5712b01cc507e5b2"><div class="ttname"><a href="group__ft5xx6__settings.html#ga782865f91f11bdbc5712b01cc507e5b2">FT5XX6_MAP_PINS</a></div><div class="ttdeci">#define FT5XX6_MAP_PINS(cfg)</div><div class="ttdoc">FT5xx6 Pin Mapping.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00510">ft5xx6.h:510</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_ga6bc20225d2c49cbddb2f167b7e59633a"><div class="ttname"><a href="group__ft5xx6.html#ga6bc20225d2c49cbddb2f167b7e59633a">ft5xx6_init</a></div><div class="ttdeci">tp_err_t ft5xx6_init(ft5xx6_t *ctx, ft5xx6_cfg_t *cfg, tp_drv_t *drv)</div><div class="ttdoc">FT5xx6 Initialization Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00138">ft5xx6.c:138</a></div></div>
</div><!-- fragment --> </dd></dl>
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00138">138</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga652c22955075ea78a37bc3c0b04d03ce" name="ga652c22955075ea78a37bc3c0b04d03ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga652c22955075ea78a37bc3c0b04d03ce">&#9670;&#160;</a></span>ft5xx6_press_coordinates()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_press_coordinates </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tp_touch_item_t *&#160;</td>
<td class="paramname"><em>touch_item</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Pressure Coordinates Check Function. </p>
<p>This function allows user to get the informations about the number of pressed touch points, coordinates and touch event for each pressed touch point. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">touch_item</td><td>: Touch item data. See #tp_touch_item_t structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing. </dd></dl>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="group__ft5xx6.html#gadcca9f3cbaca156e26894a63d8f588ee" title="FT5xx6 Process Function.">ft5xx6_process</a> function must be called to update all events.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// Touch pressure item.</span></div>
<div class="line">tp_touch_item_t tp_item;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// To get all necessary data information about pressed touch.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga652c22955075ea78a37bc3c0b04d03ce">ft5xx6_press_coordinates</a>( &amp;ft5xx6, &amp;tp_item );</div>
<div class="ttc" id="agroup__ft5xx6_html_ga652c22955075ea78a37bc3c0b04d03ce"><div class="ttname"><a href="group__ft5xx6.html#ga652c22955075ea78a37bc3c0b04d03ce">ft5xx6_press_coordinates</a></div><div class="ttdeci">void ft5xx6_press_coordinates(ft5xx6_t *ctx, tp_touch_item_t *touch_item)</div><div class="ttdoc">FT5xx6 Pressure Coordinates Check Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00261">ft5xx6.c:261</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00261">261</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga7bec3e5973ca8b94132ea761deaadeed" name="ga7bec3e5973ca8b94132ea761deaadeed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7bec3e5973ca8b94132ea761deaadeed">&#9670;&#160;</a></span>ft5xx6_press_detect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tp_event_t ft5xx6_press_detect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Touch Pressure Detect Function. </p>
<p>This function allows the touch pressure detection. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>3</code> - Touch pressure is not detected, </li>
<li><code>4</code> - Touch pressure is detected. See #tp_event_t structure definition for detailed explanation. </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="group__ft5xx6.html#gadcca9f3cbaca156e26894a63d8f588ee" title="FT5xx6 Process Function.">ft5xx6_process</a> function must be called to update all events.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// Touch pressure event.</span></div>
<div class="line">tp_event_t event;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Checking touch pressure event.</span></div>
<div class="line"><span class="keyword">event</span> = <a class="code hl_function" href="group__ft5xx6.html#ga7bec3e5973ca8b94132ea761deaadeed">ft5xx6_press_detect</a>( &amp;ft5xx6 );</div>
<div class="ttc" id="agroup__ft5xx6_html_ga7bec3e5973ca8b94132ea761deaadeed"><div class="ttname"><a href="group__ft5xx6.html#ga7bec3e5973ca8b94132ea761deaadeed">ft5xx6_press_detect</a></div><div class="ttdeci">tp_event_t ft5xx6_press_detect(ft5xx6_t *ctx)</div><div class="ttdoc">FT5xx6 Touch Pressure Detect Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00255">ft5xx6.c:255</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00255">255</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="gadcca9f3cbaca156e26894a63d8f588ee" name="gadcca9f3cbaca156e26894a63d8f588ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadcca9f3cbaca156e26894a63d8f588ee">&#9670;&#160;</a></span>ft5xx6_process()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tp_err_t ft5xx6_process </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Process Function. </p>
<p>This function detects a touch pressure, and if any touch pressure was detected, then collects all informations about the pressed touch and slide direction (gesture). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code> - OK, </li>
<li><code>5</code> - Number of pressed touches is out of range. See #tp_err_t structure definition for detailed explanation. </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>To update all possible events, just need to call this function before the any other function for checking events is called.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"><span class="comment">// TP error code.</span></div>
<div class="line">tp_err_t error;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Processing all data and events of the target touch controller.</span></div>
<div class="line">error = <a class="code hl_function" href="group__ft5xx6.html#gadcca9f3cbaca156e26894a63d8f588ee">ft5xx6_process</a>( &amp;ft5xx6 );</div>
<div class="ttc" id="agroup__ft5xx6_html_gadcca9f3cbaca156e26894a63d8f588ee"><div class="ttname"><a href="group__ft5xx6.html#gadcca9f3cbaca156e26894a63d8f588ee">ft5xx6_process</a></div><div class="ttdeci">tp_err_t ft5xx6_process(ft5xx6_t *ctx)</div><div class="ttdoc">FT5xx6 Process Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00282">ft5xx6.c:282</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00282">282</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
<a id="ga0db7f121c8041d18fd70616a74669552" name="ga0db7f121c8041d18fd70616a74669552"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0db7f121c8041d18fd70616a74669552">&#9670;&#160;</a></span>ft5xx6_run_mode_setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ft5xx6_run_mode_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structft5xx6__t.html">ft5xx6_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872d">ft5xx6_run_mode_t</a>&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FT5xx6 Run Mode Setup Function. </p>
<p>This function puts the FT5xx6 series touch controllers to the selected run mode. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>: FT5xx6 context object. See <a class="el" href="structft5xx6__t.html" title="FT5xx6 Context Object.">ft5xx6_t</a> structure definition for detailed explanation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>: run mode of operation. See <a class="el" href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872d" title="FT5xx6 Run Mode Settings.">ft5xx6_run_mode_t</a> for valid values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">// FT5xx6 driver object.</span></div>
<div class="line"><a class="code hl_struct" href="structft5xx6__t.html">ft5xx6_t</a> ft5xx6;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Setting run working mode of FT5xx6 series touch controllers.</span></div>
<div class="line"><a class="code hl_function" href="group__ft5xx6.html#ga0db7f121c8041d18fd70616a74669552">ft5xx6_run_mode_setup</a>( &amp;ft5xx6, <a class="code hl_enumvalue" href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872da46a0c39e02d1928889916183cb6d9607">FT5XX6_RUN_MODE_WORK</a> );</div>
<div class="ttc" id="aft5xx6_8h_html_a0d658e59cb50288d2a7fdb53462b872da46a0c39e02d1928889916183cb6d9607"><div class="ttname"><a href="ft5xx6_8h.html#a0d658e59cb50288d2a7fdb53462b872da46a0c39e02d1928889916183cb6d9607">FT5XX6_RUN_MODE_WORK</a></div><div class="ttdeci">@ FT5XX6_RUN_MODE_WORK</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8h_source.html#l00538">ft5xx6.h:538</a></div></div>
<div class="ttc" id="agroup__ft5xx6_html_ga0db7f121c8041d18fd70616a74669552"><div class="ttname"><a href="group__ft5xx6.html#ga0db7f121c8041d18fd70616a74669552">ft5xx6_run_mode_setup</a></div><div class="ttdeci">void ft5xx6_run_mode_setup(ft5xx6_t *ctx, ft5xx6_run_mode_t mode)</div><div class="ttdoc">FT5xx6 Run Mode Setup Function.</div><div class="ttdef"><b>Definition:</b> <a href="ft5xx6_8c_source.html#l00249">ft5xx6.c:249</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ft5xx6_8c_source.html#l00249">249</a> of file <a class="el" href="ft5xx6_8c_source.html">ft5xx6.c</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>
</html>