m5/M5Unit-FINGER
0
0
Fork 0
mirror of https://github.com/m5stack/M5Unit-FINGER.git synced 2026-05-20 11:42:13 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
M5Unit-FINGER/unit___faces_finger_8hpp_source.html
T

187 lines
19 KiB
HTML
Raw Permalink Blame History

<!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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>M5Unit-FINGER: src/unit/unit_FacesFinger.hpp Source File</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">M5Unit-FINGER<span id="projectnumber">&#160;0.1.0 git rev:4cebcb2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(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 */
$(function(){initNavTree('unit___faces_finger_8hpp_source.html',''); initResizable(true); });
/* @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="headertitle"><div class="title">unit_FacesFinger.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="unit___faces_finger_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifndef M5_UNIT_FINGER_UNIT_FACES_FINGER_HPP</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define M5_UNIT_FINGER_UNIT_FACES_FINGER_HPP</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;<a class="code" href="unit___f_p_c1xxx_8hpp.html">unit_FPC1xxx.hpp</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacem5.html">m5</a> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceunit.html">unit</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classm5_1_1unit_1_1_unit_faces_finger.html"> 23</a></span><span class="keyword">class </span><a class="code hl_class" href="classm5_1_1unit_1_1_unit_faces_finger.html">UnitFacesFinger</a> : <span class="keyword">public</span> <a class="code hl_class" href="classm5_1_1unit_1_1_unit_f_p_c1020_a.html">UnitFPC1020A</a> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> M5_UNIT_COMPONENT_HPP_BUILDER(<a class="code hl_class" href="classm5_1_1unit_1_1_unit_faces_finger.html">UnitFacesFinger</a>, 0x00);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00031" data-start="{" data-end="};">
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html"> 31</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html">config_t</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a9d835c528637c0be87135d6ca6bb66f0"> 32</a></span> uint32_t <a class="code hl_variable" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a9d835c528637c0be87135d6ca6bb66f0">timeout_ms</a>{1000 * 4}; </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a0232f83365110f03b219d6d3b069cc86"> 33</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a0232f83365110f03b219d6d3b069cc86">panel_power_pin</a>{-1}; </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#aea3ace18beaa8459df0b163b118aa92c"> 34</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#aea3ace18beaa8459df0b163b118aa92c">touch_power_pin</a>{-1}; </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> };</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_class" href="classm5_1_1unit_1_1_unit_faces_finger.html">UnitFacesFinger</a>() : <a class="code hl_class" href="classm5_1_1unit_1_1_unit_f_p_c1020_a.html">UnitFPC1020A</a>()</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">virtual</span> ~UnitFacesFinger() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classm5_1_1unit_1_1_unit_faces_finger.html#afd46dccff363d2797013fcc3b29931d8">begin</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="foldopen" id="foldopen00048" data-start="{" data-end="}">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classm5_1_1unit_1_1_unit_faces_finger.html#a3f39d9bcb3f66b3be2ff944229789845"> 48</a></span> <span class="keyword">inline</span> <a class="code hl_struct" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html">config_t</a> <a class="code hl_function" href="classm5_1_1unit_1_1_unit_faces_finger.html#a3f39d9bcb3f66b3be2ff944229789845">config</a>()</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> {</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">return</span> _faces_cfg;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> }</div>
</div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="}">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classm5_1_1unit_1_1_unit_faces_finger.html#ae375d014535d239137d65d677709bda5"> 53</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classm5_1_1unit_1_1_unit_faces_finger.html#ae375d014535d239137d65d677709bda5">config</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html">config_t</a>&amp; cfg)</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> _faces_cfg = cfg;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_struct" href="structm5_1_1unit_1_1_unit_f_p_c1_x_x_x_1_1config__t.html">UnitFPC1XXX::config_t</a> base_cfg;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> base_cfg.<a class="code hl_variable" href="structm5_1_1unit_1_1_unit_f_p_c1_x_x_x_1_1config__t.html#a668ca435792dc4b3f50ccd4db38bce4f">timeout_ms</a> = cfg.<a class="code hl_variable" href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a9d835c528637c0be87135d6ca6bb66f0">timeout_ms</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_function" href="classm5_1_1unit_1_1_unit_f_p_c1_x_x_x.html#ab989eb5e96b808bbad73923ec678f865">UnitFPC1XXX::config</a>(base_cfg);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> }</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> config_t _faces_cfg{};</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>};</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>} <span class="comment">// namespace unit</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>} <span class="comment">// namespace m5</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_unit_f_p_c1020_a_html"><div class="ttname"><a href="classm5_1_1unit_1_1_unit_f_p_c1020_a.html">m5::unit::UnitFPC1020A</a></div><div class="ttdoc">For FPC1020A.</div><div class="ttdef"><b>Definition</b> unit_FPC1xxx.hpp:383</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_unit_f_p_c1_x_x_x_html_ab989eb5e96b808bbad73923ec678f865"><div class="ttname"><a href="classm5_1_1unit_1_1_unit_f_p_c1_x_x_x.html#ab989eb5e96b808bbad73923ec678f865">m5::unit::UnitFPC1XXX::config</a></div><div class="ttdeci">config_t config()</div><div class="ttdoc">Gets the configuration.</div><div class="ttdef"><b>Definition</b> unit_FPC1xxx.hpp:121</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_unit_faces_finger_html"><div class="ttname"><a href="classm5_1_1unit_1_1_unit_faces_finger.html">m5::unit::UnitFacesFinger</a></div><div class="ttdoc">For Faces Finger Module (FPC1020A via M-Bus)</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:23</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_unit_faces_finger_html_a3f39d9bcb3f66b3be2ff944229789845"><div class="ttname"><a href="classm5_1_1unit_1_1_unit_faces_finger.html#a3f39d9bcb3f66b3be2ff944229789845">m5::unit::UnitFacesFinger::config</a></div><div class="ttdeci">config_t config()</div><div class="ttdoc">Gets the configuration.</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:48</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_unit_faces_finger_html_ae375d014535d239137d65d677709bda5"><div class="ttname"><a href="classm5_1_1unit_1_1_unit_faces_finger.html#ae375d014535d239137d65d677709bda5">m5::unit::UnitFacesFinger::config</a></div><div class="ttdeci">void config(const config_t &amp;cfg)</div><div class="ttdoc">Set the configuration.</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:53</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_unit_faces_finger_html_afd46dccff363d2797013fcc3b29931d8"><div class="ttname"><a href="classm5_1_1unit_1_1_unit_faces_finger.html#afd46dccff363d2797013fcc3b29931d8">m5::unit::UnitFacesFinger::begin</a></div><div class="ttdeci">virtual bool begin() override</div><div class="ttdoc">Begin communication with the unit.</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.cpp:24</div></div>
<div class="ttc" id="anamespacem5_html"><div class="ttname"><a href="namespacem5.html">m5</a></div><div class="ttdoc">Top level namespace of M5stack.</div></div>
<div class="ttc" id="anamespaceunit_html"><div class="ttname"><a href="namespaceunit.html">unit</a></div><div class="ttdoc">Unit-related namespace.</div></div>
<div class="ttc" id="astructm5_1_1unit_1_1_unit_f_p_c1_x_x_x_1_1config__t_html"><div class="ttname"><a href="structm5_1_1unit_1_1_unit_f_p_c1_x_x_x_1_1config__t.html">m5::unit::UnitFPC1XXX::config_t</a></div><div class="ttdoc">Settings for begin.</div><div class="ttdef"><b>Definition</b> unit_FPC1xxx.hpp:114</div></div>
<div class="ttc" id="astructm5_1_1unit_1_1_unit_f_p_c1_x_x_x_1_1config__t_html_a668ca435792dc4b3f50ccd4db38bce4f"><div class="ttname"><a href="structm5_1_1unit_1_1_unit_f_p_c1_x_x_x_1_1config__t.html#a668ca435792dc4b3f50ccd4db38bce4f">m5::unit::UnitFPC1XXX::config_t::timeout_ms</a></div><div class="ttdeci">uint32_t timeout_ms</div><div class="ttdoc">Serial I/O timeout (ms)</div><div class="ttdef"><b>Definition</b> unit_FPC1xxx.hpp:115</div></div>
<div class="ttc" id="astructm5_1_1unit_1_1_unit_faces_finger_1_1config__t_html"><div class="ttname"><a href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html">m5::unit::UnitFacesFinger::config_t</a></div><div class="ttdoc">Settings for begin.</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:31</div></div>
<div class="ttc" id="astructm5_1_1unit_1_1_unit_faces_finger_1_1config__t_html_a0232f83365110f03b219d6d3b069cc86"><div class="ttname"><a href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a0232f83365110f03b219d6d3b069cc86">m5::unit::UnitFacesFinger::config_t::panel_power_pin</a></div><div class="ttdeci">int panel_power_pin</div><div class="ttdoc">Finger panel power pin (mbus_pin10)</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:33</div></div>
<div class="ttc" id="astructm5_1_1unit_1_1_unit_faces_finger_1_1config__t_html_a9d835c528637c0be87135d6ca6bb66f0"><div class="ttname"><a href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#a9d835c528637c0be87135d6ca6bb66f0">m5::unit::UnitFacesFinger::config_t::timeout_ms</a></div><div class="ttdeci">uint32_t timeout_ms</div><div class="ttdoc">Serial I/O timeout (ms)</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:32</div></div>
<div class="ttc" id="astructm5_1_1unit_1_1_unit_faces_finger_1_1config__t_html_aea3ace18beaa8459df0b163b118aa92c"><div class="ttname"><a href="structm5_1_1unit_1_1_unit_faces_finger_1_1config__t.html#aea3ace18beaa8459df0b163b118aa92c">m5::unit::UnitFacesFinger::config_t::touch_power_pin</a></div><div class="ttdeci">int touch_power_pin</div><div class="ttdoc">Touch IC power pin (mbus_pin20)</div><div class="ttdef"><b>Definition</b> unit_FacesFinger.hpp:34</div></div>
<div class="ttc" id="aunit___f_p_c1xxx_8hpp_html"><div class="ttname"><a href="unit___f_p_c1xxx_8hpp.html">unit_FPC1xxx.hpp</a></div><div class="ttdoc">FPC1xxx family with DSP unit for M5UnitUnified.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b9225a18e54a15d8544a67849bf5de50.html">unit</a></li><li class="navelem"><a class="el" href="unit___faces_finger_8hpp.html">unit_FacesFinger.hpp</a></li>
<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.11.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink