327 lines
15 KiB
HTML
327 lines
15 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
||
|
|
<title>ESP8266_RTOS_SDK: PWM Driver APIs</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
</script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">ESP8266_RTOS_SDK
|
||
|
|
 <span id="projectnumber">v1.4.0</span>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<!-- 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">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#nested-classes">Data Structures</a> |
|
||
|
|
<a href="#define-members">Macros</a> |
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">PWM Driver APIs<div class="ingroups"><a class="el" href="group__Driver__APIs.html">Driver APIs</a></div></div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>PWM driver APIs.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||
|
|
Data Structures</h2></td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpwm__param.html">pwm_param</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
||
|
|
Macros</h2></td></tr>
|
||
|
|
<tr class="memitem:gabd1740ea7992ec3db609babfd6d1e58e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabd1740ea7992ec3db609babfd6d1e58e"></a>
|
||
|
|
#define </td><td class="memItemRight" valign="bottom"><b>PWM_DEPTH</b>   1023</td></tr>
|
||
|
|
<tr class="separator:gabd1740ea7992ec3db609babfd6d1e58e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ga96286902d138bbba183495583db6f369"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWM__Driver__APIs.html#ga96286902d138bbba183495583db6f369">pwm_init</a> (uint32 period, uint32 *duty, uint32 pwm_channel_num, uint32(*pin_info_list)[3])</td></tr>
|
||
|
|
<tr class="memdesc:ga96286902d138bbba183495583db6f369"><td class="mdescLeft"> </td><td class="mdescRight">PWM function initialization, including GPIO, frequency and duty cycle. <a href="#ga96286902d138bbba183495583db6f369">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga96286902d138bbba183495583db6f369"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga3c85e3b8654b48f23033f132b91c07b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWM__Driver__APIs.html#ga3c85e3b8654b48f23033f132b91c07b3">pwm_set_duty</a> (uint32 duty, uint8 channel)</td></tr>
|
||
|
|
<tr class="memdesc:ga3c85e3b8654b48f23033f132b91c07b3"><td class="mdescLeft"> </td><td class="mdescRight">Set the duty cycle of a PWM channel. <a href="#ga3c85e3b8654b48f23033f132b91c07b3">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga3c85e3b8654b48f23033f132b91c07b3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaa2c27474ef8774f6a85971f813785068"><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWM__Driver__APIs.html#gaa2c27474ef8774f6a85971f813785068">pwm_get_duty</a> (uint8 channel)</td></tr>
|
||
|
|
<tr class="memdesc:gaa2c27474ef8774f6a85971f813785068"><td class="mdescLeft"> </td><td class="mdescRight">Get the duty cycle of a PWM channel. <a href="#gaa2c27474ef8774f6a85971f813785068">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gaa2c27474ef8774f6a85971f813785068"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga57dad644319cd4324edd382d5ce772f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWM__Driver__APIs.html#ga57dad644319cd4324edd382d5ce772f5">pwm_set_period</a> (uint32 period)</td></tr>
|
||
|
|
<tr class="memdesc:ga57dad644319cd4324edd382d5ce772f5"><td class="mdescLeft"> </td><td class="mdescRight">Set PWM period, unit : us. <a href="#ga57dad644319cd4324edd382d5ce772f5">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga57dad644319cd4324edd382d5ce772f5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga347173af17daf294b4312d975f3bed8b"><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWM__Driver__APIs.html#ga347173af17daf294b4312d975f3bed8b">pwm_get_period</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:ga347173af17daf294b4312d975f3bed8b"><td class="mdescLeft"> </td><td class="mdescRight">Get PWM period, unit : us. <a href="#ga347173af17daf294b4312d975f3bed8b">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga347173af17daf294b4312d975f3bed8b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gad405ef7080a8cea5c9ac23ba25da1fbb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWM__Driver__APIs.html#gad405ef7080a8cea5c9ac23ba25da1fbb">pwm_start</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:gad405ef7080a8cea5c9ac23ba25da1fbb"><td class="mdescLeft"> </td><td class="mdescRight">Starts PWM. <a href="#gad405ef7080a8cea5c9ac23ba25da1fbb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gad405ef7080a8cea5c9ac23ba25da1fbb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<p>PWM driver APIs. </p>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a class="anchor" id="gaa2c27474ef8774f6a85971f813785068"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint32 pwm_get_duty </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint8 </td>
|
||
|
|
<td class="paramname"><em>channel</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the duty cycle of a PWM channel. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint8</td><td>channel : PWM channel number</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Duty cycle of PWM output. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga347173af17daf294b4312d975f3bed8b"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint32 pwm_get_period </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get PWM period, unit : us. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>PWM period, unit : us. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga96286902d138bbba183495583db6f369"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void pwm_init </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>period</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32 * </td>
|
||
|
|
<td class="paramname"><em>duty</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>pwm_channel_num</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32(*) </td>
|
||
|
|
<td class="paramname"><em>pin_info_list</em>[3] </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>PWM function initialization, including GPIO, frequency and duty cycle. </p>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd>This API can be called only once.</dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>period : pwm frequency </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>*duty : duty cycle </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>pwm_channel_num : PWM channel number </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>(*pin_info_list)[3] : GPIO parameter of PWM channel, it is a pointer of n x 3 array which defines GPIO register, IO reuse of corresponding pin and GPIO number.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga3c85e3b8654b48f23033f132b91c07b3"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void pwm_set_duty </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>duty</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint8 </td>
|
||
|
|
<td class="paramname"><em>channel</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the duty cycle of a PWM channel. </p>
|
||
|
|
<p>Set the time that high level signal will last, duty depends on period, the maximum value can be 1023.</p>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd>After set configuration, pwm_start needs to be called to take effect.</dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>duty : duty cycle </td></tr>
|
||
|
|
<tr><td class="paramname">uint8</td><td>channel : PWM channel number</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga57dad644319cd4324edd382d5ce772f5"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void pwm_set_period </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>period</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set PWM period, unit : us. </p>
|
||
|
|
<p>For example, for 1KHz PWM, period is 1000 us.</p>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd>After set configuration, pwm_start needs to be called to take effect.</dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>period : PWM period, unit : us.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="gad405ef7080a8cea5c9ac23ba25da1fbb"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void pwm_start </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Starts PWM. </p>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd>This function needs to be called after PWM configuration is changed.</dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.10
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|