m5/M5UnitUnified
0
0
Fork 0
mirror of https://github.com/m5stack/M5UnitUnified.git synced 2026-05-20 11:24:51 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
M5UnitUnified/adapter__uart_8hpp_source.html
T

217 lines
21 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>M5UnitUnified: src/m5_unit_component/adapter_uart.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">M5UnitUnified<span id="projectnumber">&#160;0.4.6 git rev:c61a63c</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('adapter__uart_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">adapter_uart.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="adapter__uart_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="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifndef M5_UNIT_COMPONENT_ADAPTER_UART_HPP</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define M5_UNIT_COMPONENT_ADAPTER_UART_HPP</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;<a class="code" href="adapter__base_8hpp.html">adapter_base.hpp</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">class </span>HardwareSerial;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacem5.html">m5</a> {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceunit.html">unit</a> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">class </span>AdapterUART : <span class="keyword">public</span> Adapter {</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="foldopen00027" data-start="{" data-end="};">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl.html"> 27</a></span> <span class="keyword">class </span><a class="code hl_class" href="classm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl.html">UARTImpl</a> : <span class="keyword">public</span> <a class="code hl_class" href="classm5_1_1unit_1_1_adapter_1_1_impl.html">Adapter::Impl</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_class" href="classm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl.html">UARTImpl</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl.html">~UARTImpl</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">inline</span> <span class="keyword">virtual</span> HardwareSerial* getSerial()</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush()</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> }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> flushRX()</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> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTimeout(<span class="keyword">const</span> uint32_t)</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> };</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">//</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#if defined(ARDUINO)</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">class </span>SerialImpl : <span class="keyword">public</span> <a class="code hl_class" href="classm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl.html">UARTImpl</a> {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">explicit</span> SerialImpl(HardwareSerial&amp; serial);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">inline</span> <span class="keyword">virtual</span> HardwareSerial* getSerial()<span class="keyword"> override</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> _serial;</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> <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> flushRX() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTimeout(<span class="keyword">const</span> uint32_t ms) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">virtual</span> m5::hal::error::error_t readWithTransaction(uint8_t* data, <span class="keyword">const</span> <span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">virtual</span> m5::hal::error::error_t writeWithTransaction(<span class="keyword">const</span> uint8_t* data, <span class="keyword">const</span> <span class="keywordtype">size_t</span> len,</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">const</span> uint32_t stop) <span class="keyword">override</span>;</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">protected</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> HardwareSerial* _serial{};</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> };</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#if defined(ARDUINO)</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">explicit</span> AdapterUART(HardwareSerial&amp; serial);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> flush()</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> impl()-&gt;flush();</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> flushRX()</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> {</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> impl()-&gt;flushRX();</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> }</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> setTimeout(<span class="keyword">const</span> uint32_t ms)</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> impl()-&gt;setTimeout(ms);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> }</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">inline</span> UARTImpl* impl()</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> {</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>UARTImpl*<span class="keyword">&gt;</span>(_impl.get());</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> }</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">inline</span> <span class="keyword">const</span> UARTImpl* impl()<span class="keyword"> const</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>UARTImpl*<span class="keyword">&gt;</span>(_impl.get());</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> }</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> AdapterUART() : <a class="code hl_function" href="classm5_1_1unit_1_1_adapter.html#a3ef68d3ebd48c5d8fb37c9b3ff603e94">Adapter</a>(<a class="code hl_function" href="classm5_1_1unit_1_1_adapter.html#a3ef68d3ebd48c5d8fb37c9b3ff603e94">Adapter</a>::<a class="code hl_enumeration" href="classm5_1_1unit_1_1_adapter.html#a6d3797f5be198a03cd4699e63dbbafce">Type</a>::<a class="code hl_enumvalue" href="classm5_1_1unit_1_1_adapter.html#a6d3797f5be198a03cd4699e63dbbafceacec5769b01fb096efaf0d6186823c78f">UART</a>, new UARTImpl())</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> }</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>};</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>} <span class="comment">// namespace unit</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>} <span class="comment">// namespace m5</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aadapter__base_8hpp_html"><div class="ttname"><a href="adapter__base_8hpp.html">adapter_base.hpp</a></div><div class="ttdoc">Adapter base.</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_adapter_1_1_impl_html"><div class="ttname"><a href="classm5_1_1unit_1_1_adapter_1_1_impl.html">m5::unit::Adapter::Impl</a></div><div class="ttdoc">Implementation base class (Pimpl pattern)</div><div class="ttdef"><b>Definition</b> adapter_base.hpp:37</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_adapter_html_a3ef68d3ebd48c5d8fb37c9b3ff603e94"><div class="ttname"><a href="classm5_1_1unit_1_1_adapter.html#a3ef68d3ebd48c5d8fb37c9b3ff603e94">m5::unit::Adapter::Adapter</a></div><div class="ttdeci">Adapter()</div><div class="ttdoc">Default constructor (creates Unknown type adapter)</div><div class="ttdef"><b>Definition</b> adapter_base.hpp:133</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_adapter_html_a6d3797f5be198a03cd4699e63dbbafce"><div class="ttname"><a href="classm5_1_1unit_1_1_adapter.html#a6d3797f5be198a03cd4699e63dbbafce">m5::unit::Adapter::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Adapter type.</div><div class="ttdef"><b>Definition</b> adapter_base.hpp:28</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_adapter_html_a6d3797f5be198a03cd4699e63dbbafceacec5769b01fb096efaf0d6186823c78f"><div class="ttname"><a href="classm5_1_1unit_1_1_adapter.html#a6d3797f5be198a03cd4699e63dbbafceacec5769b01fb096efaf0d6186823c78f">m5::unit::Adapter::Type::UART</a></div><div class="ttdeci">@ UART</div><div class="ttdoc">UART serial.</div></div>
<div class="ttc" id="aclassm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl_html"><div class="ttname"><a href="classm5_1_1unit_1_1_adapter_u_a_r_t_1_1_u_a_r_t_impl.html">m5::unit::AdapterUART::UARTImpl</a></div><div class="ttdef"><b>Definition</b> adapter_uart.hpp:27</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 class="ttdef"><b>Definition</b> test_helper.hpp:20</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><!-- 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_0fcc4442f312ae19b23b5a34d6d76227.html">m5_unit_component</a></li><li class="navelem"><a class="el" href="adapter__uart_8hpp.html">adapter_uart.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