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

209 lines
11 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>M5Utility: src/m5_utility/compatibility_feature.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<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">M5Utility<span id="projectnumber">&#160;0.0.12 git rev:13bfbd6</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('compatibility__feature_8cpp.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="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">compatibility_feature.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Maintain compatibility with Arduino API, etc.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="compatibility__feature_8hpp_source.html">compatibility_feature.hpp</a>&quot;</code><br />
<code>#include &lt;ctime&gt;</code><br />
<code>#include &lt;chrono&gt;</code><br />
<code>#include &lt;thread&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem5.html">m5</a></td></tr>
<tr class="memdesc:namespacem5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Top level namespace of M5. <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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8b5a7da03d5e9fbb2ca81ddc85025012" id="r_a8b5a7da03d5e9fbb2ca81ddc85025012"><td class="memItemLeft" align="right" valign="top"><a id="a8b5a7da03d5e9fbb2ca81ddc85025012" name="a8b5a7da03d5e9fbb2ca81ddc85025012"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>IRAM_ATTR</b>&#160;&#160;&#160;/* nop */</td></tr>
<tr class="separator:a8b5a7da03d5e9fbb2ca81ddc85025012"><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><td colspan="2"><div class="groupHeader">Arduino API</div></td></tr>
<tr class="memitem:a212ab4413419cc8950b40d60700e8802" id="r_a212ab4413419cc8950b40d60700e8802"><td class="memItemLeft" align="right" valign="top"><a id="a212ab4413419cc8950b40d60700e8802" name="a212ab4413419cc8950b40d60700e8802"></a>
IRAM_ATTR unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>m5::utility::millis</b> ()</td></tr>
<tr class="memdesc:a212ab4413419cc8950b40d60700e8802"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of milliseconds passed since the Arduino board began running the current program. <br /></td></tr>
<tr class="separator:a212ab4413419cc8950b40d60700e8802"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d4b270efab41768fe9b488056fa7e3a" id="r_a2d4b270efab41768fe9b488056fa7e3a"><td class="memItemLeft" align="right" valign="top"><a id="a2d4b270efab41768fe9b488056fa7e3a" name="a2d4b270efab41768fe9b488056fa7e3a"></a>
IRAM_ATTR unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>m5::utility::micros</b> ()</td></tr>
<tr class="memdesc:a2d4b270efab41768fe9b488056fa7e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of microseconds since the Arduino board began running the current program. <br /></td></tr>
<tr class="separator:a2d4b270efab41768fe9b488056fa7e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d21c95e4e4584fd20525b4070300471" id="r_a4d21c95e4e4584fd20525b4070300471"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d21c95e4e4584fd20525b4070300471">m5::utility::delay</a> (const unsigned long ms)</td></tr>
<tr class="memdesc:a4d21c95e4e4584fd20525b4070300471"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pauses the program for the amount of time (in milliseconds) specified as parameter. <br /></td></tr>
<tr class="separator:a4d21c95e4e4584fd20525b4070300471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc4368ab036207b55d64d7f7cf83a00" id="r_a7dc4368ab036207b55d64d7f7cf83a00"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7dc4368ab036207b55d64d7f7cf83a00">m5::utility::delayMicroseconds</a> (const unsigned int us)</td></tr>
<tr class="memdesc:a7dc4368ab036207b55d64d7f7cf83a00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pauses the program for the amount of time (in microseconds) specified by the parameter. <br /></td></tr>
<tr class="separator:a7dc4368ab036207b55d64d7f7cf83a00"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Maintain compatibility with Arduino API, etc. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a4d21c95e4e4584fd20525b4070300471" name="a4d21c95e4e4584fd20525b4070300471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d21c95e4e4584fd20525b4070300471">&#9670;&#160;</a></span>delay()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void m5::utility::delay </td>
<td>(</td>
<td class="paramtype">const unsigned long</td> <td class="paramname"><span class="paramname"><em>ms</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pauses the program for the amount of time (in milliseconds) specified as parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ms</td><td>delay time (ms) </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Accuracy varies depending on the environment. </dd></dl>
</div>
</div>
<a id="a7dc4368ab036207b55d64d7f7cf83a00" name="a7dc4368ab036207b55d64d7f7cf83a00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc4368ab036207b55d64d7f7cf83a00">&#9670;&#160;</a></span>delayMicroseconds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void m5::utility::delayMicroseconds </td>
<td>(</td>
<td class="paramtype">const unsigned int</td> <td class="paramname"><span class="paramname"><em>us</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pauses the program for the amount of time (in microseconds) specified by the parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">us</td><td>delay time (us) </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Accuracy varies depending on the environment. </dd></dl>
</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="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c43ce1a5a207b5021ecda6c5900e5b5f.html">m5_utility</a></li><li class="navelem"><a class="el" href="compatibility__feature_8cpp.html">compatibility_feature.cpp</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