1126 lines
79 KiB
HTML
1126 lines
79 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.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: LED</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="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.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="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<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="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API Reference</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 -->
|
|
<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">
|
|
$(document).ready(function(){initNavTree('a00035.html','');});
|
|
</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)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LED</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<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:a00360"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a00360">_led_pin_config</a></td></tr>
|
|
<tr class="memdesc:a00360"><td class="mdescLeft"> </td><td class="mdescRight">The pin config struct of LED. <a href="a00035.html#a00360">More...</a><br/></td></tr>
|
|
<tr class="separator:a00360"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00361"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a00361">_led_rgb_config</a></td></tr>
|
|
<tr class="memdesc:a00361"><td class="mdescLeft"> </td><td class="mdescRight">The pin config struct of rgb LED. <a href="a00035.html#a00361">More...</a><br/></td></tr>
|
|
<tr class="separator:a00361"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00359"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a00359">_led_monochrome_config</a></td></tr>
|
|
<tr class="memdesc:a00359"><td class="mdescLeft"> </td><td class="mdescRight">The pin config struct of monochrome LED. <a href="a00035.html#a00359">More...</a><br/></td></tr>
|
|
<tr class="separator:a00359"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00357"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a00357">_led_config</a></td></tr>
|
|
<tr class="memdesc:a00357"><td class="mdescLeft"> </td><td class="mdescRight">The config struct of LED. <a href="a00035.html#a00357">More...</a><br/></td></tr>
|
|
<tr class="separator:a00357"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00358"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a00358">_led_flash_config</a></td></tr>
|
|
<tr class="memdesc:a00358"><td class="mdescLeft"> </td><td class="mdescRight">The flash config struct of LED. <a href="a00035.html#a00358">More...</a><br/></td></tr>
|
|
<tr class="separator:a00358"><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:gab1c951f31df0dec0a76866f76e5fdacc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gab1c951f31df0dec0a76866f76e5fdacc">LED_DIMMING_ENABLEMENT</a>   (0U)</td></tr>
|
|
<tr class="memdesc:gab1c951f31df0dec0a76866f76e5fdacc"><td class="mdescLeft"> </td><td class="mdescRight">Definition to determine whether enable dimming. <a href="#gab1c951f31df0dec0a76866f76e5fdacc">More...</a><br/></td></tr>
|
|
<tr class="separator:gab1c951f31df0dec0a76866f76e5fdacc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafb4b93ae3a6ca5dad479212ef291ad42"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gafb4b93ae3a6ca5dad479212ef291ad42">LED_COLOR_WHEEL_ENABLEMENT</a>   (0U)</td></tr>
|
|
<tr class="memdesc:gafb4b93ae3a6ca5dad479212ef291ad42"><td class="mdescLeft"> </td><td class="mdescRight">Definition to determine whether enable color wheel. <a href="#gafb4b93ae3a6ca5dad479212ef291ad42">More...</a><br/></td></tr>
|
|
<tr class="separator:gafb4b93ae3a6ca5dad479212ef291ad42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5f975104bd800236305e068d1e4d935f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga5f975104bd800236305e068d1e4d935f">LED_USE_CONFIGURE_STRUCTURE</a>   (1U)</td></tr>
|
|
<tr class="memdesc:ga5f975104bd800236305e068d1e4d935f"><td class="mdescLeft"> </td><td class="mdescRight">Definition to determine whether use confgure structure. <a href="#ga5f975104bd800236305e068d1e4d935f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5f975104bd800236305e068d1e4d935f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga163c4226a9d58115ed32485eb7056da7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7">LED_HANDLE_SIZE</a>   ((16U * 3U) + 32U)</td></tr>
|
|
<tr class="memdesc:ga163c4226a9d58115ed32485eb7056da7"><td class="mdescLeft"> </td><td class="mdescRight">Definition of LED handle size. <a href="#ga163c4226a9d58115ed32485eb7056da7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga163c4226a9d58115ed32485eb7056da7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9eb96498b2b1a7619864ca3482a1d017"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga9eb96498b2b1a7619864ca3482a1d017">LED_HANDLE_DEFINE</a>(name)   uint32_t name[((<a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7">LED_HANDLE_SIZE</a> + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]</td></tr>
|
|
<tr class="memdesc:ga9eb96498b2b1a7619864ca3482a1d017"><td class="mdescLeft"> </td><td class="mdescRight">Defines the led handle. <a href="#ga9eb96498b2b1a7619864ca3482a1d017">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9eb96498b2b1a7619864ca3482a1d017"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga605db5821e9d220c6eff157bb5f6cbad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga605db5821e9d220c6eff157bb5f6cbad">LED_HANDLE_ARRAY_DEFINE</a>(name, count)   uint32_t name[count][((<a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7">LED_HANDLE_SIZE</a> + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]</td></tr>
|
|
<tr class="memdesc:ga605db5821e9d220c6eff157bb5f6cbad"><td class="mdescLeft"> </td><td class="mdescRight">Defines the led handle array. <a href="#ga605db5821e9d220c6eff157bb5f6cbad">More...</a><br/></td></tr>
|
|
<tr class="separator:ga605db5821e9d220c6eff157bb5f6cbad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa189c6766bd5be625917152cbbff1c95"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gaa189c6766bd5be625917152cbbff1c95">LED_TIMER_INTERVAL</a>   (100U)</td></tr>
|
|
<tr class="memdesc:gaa189c6766bd5be625917152cbbff1c95"><td class="mdescLeft"> </td><td class="mdescRight">Definition of LED timer interval,unit is ms. <a href="#gaa189c6766bd5be625917152cbbff1c95">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa189c6766bd5be625917152cbbff1c95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga28ef147d17735d1751ac771d53f20d36"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga28ef147d17735d1751ac771d53f20d36">LED_DIMMING_UPDATE_INTERVAL</a>   (100U)</td></tr>
|
|
<tr class="memdesc:ga28ef147d17735d1751ac771d53f20d36"><td class="mdescLeft"> </td><td class="mdescRight">Definition of LED dimming update interval,unit is ms. <a href="#ga28ef147d17735d1751ac771d53f20d36">More...</a><br/></td></tr>
|
|
<tr class="separator:ga28ef147d17735d1751ac771d53f20d36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0fcfb713f2c6b0af490d6b65d98416cb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga0fcfb713f2c6b0af490d6b65d98416cb">LED_FLASH_CYCLE_FOREVER</a>   (0xFFFFFFFFU)</td></tr>
|
|
<tr class="memdesc:ga0fcfb713f2c6b0af490d6b65d98416cb"><td class="mdescLeft"> </td><td class="mdescRight">Definition of LED flash cycle forever. <a href="#ga0fcfb713f2c6b0af490d6b65d98416cb">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0fcfb713f2c6b0af490d6b65d98416cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga63fae0c4958dbf9353854dc1731c7e73"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga63fae0c4958dbf9353854dc1731c7e73">LED_BLIP_INTERVAL</a>   (250U)</td></tr>
|
|
<tr class="memdesc:ga63fae0c4958dbf9353854dc1731c7e73"><td class="mdescLeft"> </td><td class="mdescRight">Definition of LED blip interval,unit is ms. <a href="#ga63fae0c4958dbf9353854dc1731c7e73">More...</a><br/></td></tr>
|
|
<tr class="separator:ga63fae0c4958dbf9353854dc1731c7e73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga59cb1a3d1b67b5efdf1832ee436445a7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga59cb1a3d1b67b5efdf1832ee436445a7">LED_MAKE_COLOR</a>(r, g, b)   ((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)((((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)b) << 16) | (((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)g) << 8) | ((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)r)))</td></tr>
|
|
<tr class="memdesc:ga59cb1a3d1b67b5efdf1832ee436445a7"><td class="mdescLeft"> </td><td class="mdescRight">Definition to set LED color. <a href="#ga59cb1a3d1b67b5efdf1832ee436445a7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga59cb1a3d1b67b5efdf1832ee436445a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga2e6f49cb4cfe9771f15be4734ebb21c2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2e6f49cb4cfe9771f15be4734ebb21c2"></a>
|
|
typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a></td></tr>
|
|
<tr class="memdesc:ga2e6f49cb4cfe9771f15be4734ebb21c2"><td class="mdescLeft"> </td><td class="mdescRight">The handle of LED. <br/></td></tr>
|
|
<tr class="separator:ga2e6f49cb4cfe9771f15be4734ebb21c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0ce30ec3455305300bd367a04a96465a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0ce30ec3455305300bd367a04a96465a"></a>
|
|
typedef enum <a class="el" href="a00035.html#ga282a78e9d7df11dbf752d06b129900ac">_led_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a></td></tr>
|
|
<tr class="memdesc:ga0ce30ec3455305300bd367a04a96465a"><td class="mdescLeft"> </td><td class="mdescRight">The status type of LED. <br/></td></tr>
|
|
<tr class="separator:ga0ce30ec3455305300bd367a04a96465a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4c0d3d21b054dc3e9532268221410495"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4c0d3d21b054dc3e9532268221410495"></a>
|
|
typedef enum <a class="el" href="a00035.html#gaa52f8292f954a4ad917f6712b1d2e3de">_led_flash_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga4c0d3d21b054dc3e9532268221410495">led_flash_type_t</a></td></tr>
|
|
<tr class="memdesc:ga4c0d3d21b054dc3e9532268221410495"><td class="mdescLeft"> </td><td class="mdescRight">The flash type of LED. <br/></td></tr>
|
|
<tr class="separator:ga4c0d3d21b054dc3e9532268221410495"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga49b09097ec358cb93e9b950a10debc05"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga49b09097ec358cb93e9b950a10debc05"></a>
|
|
typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a></td></tr>
|
|
<tr class="memdesc:ga49b09097ec358cb93e9b950a10debc05"><td class="mdescLeft"> </td><td class="mdescRight">The color struct of LED. <br/></td></tr>
|
|
<tr class="separator:ga49b09097ec358cb93e9b950a10debc05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga55e87ade8e72b6f8dbee053791b7085b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga55e87ade8e72b6f8dbee053791b7085b"></a>
|
|
typedef struct <a class="el" href="a00035.html#a00360">_led_pin_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga55e87ade8e72b6f8dbee053791b7085b">led_pin_config_t</a></td></tr>
|
|
<tr class="memdesc:ga55e87ade8e72b6f8dbee053791b7085b"><td class="mdescLeft"> </td><td class="mdescRight">The pin config struct of LED. <br/></td></tr>
|
|
<tr class="separator:ga55e87ade8e72b6f8dbee053791b7085b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1b1433bbdfecfb794d66b59f32b06458"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b1433bbdfecfb794d66b59f32b06458"></a>
|
|
typedef struct <a class="el" href="a00035.html#a00361">_led_rgb_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga1b1433bbdfecfb794d66b59f32b06458">led_rgb_config_t</a></td></tr>
|
|
<tr class="memdesc:ga1b1433bbdfecfb794d66b59f32b06458"><td class="mdescLeft"> </td><td class="mdescRight">The pin config struct of rgb LED. <br/></td></tr>
|
|
<tr class="separator:ga1b1433bbdfecfb794d66b59f32b06458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6d32ab680d388ab0d5e37c791ddd25ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6d32ab680d388ab0d5e37c791ddd25ae"></a>
|
|
typedef struct <br class="typebreak"/>
|
|
<a class="el" href="a00035.html#a00359">_led_monochrome_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga6d32ab680d388ab0d5e37c791ddd25ae">led_monochrome_config_t</a></td></tr>
|
|
<tr class="memdesc:ga6d32ab680d388ab0d5e37c791ddd25ae"><td class="mdescLeft"> </td><td class="mdescRight">The pin config struct of monochrome LED. <br/></td></tr>
|
|
<tr class="separator:ga6d32ab680d388ab0d5e37c791ddd25ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga28ffd75a93e744515b917687482d410f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga28ffd75a93e744515b917687482d410f"></a>
|
|
typedef enum <a class="el" href="a00035.html#ga85a0546eef6beda4fb23a9a2097c7746">_led_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga28ffd75a93e744515b917687482d410f">led_type_t</a></td></tr>
|
|
<tr class="memdesc:ga28ffd75a93e744515b917687482d410f"><td class="mdescLeft"> </td><td class="mdescRight">The type of LED. <br/></td></tr>
|
|
<tr class="separator:ga28ffd75a93e744515b917687482d410f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga68a414f4f08f73a4283511740e419099"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga68a414f4f08f73a4283511740e419099"></a>
|
|
typedef struct <a class="el" href="a00035.html#a00357">_led_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga68a414f4f08f73a4283511740e419099">led_config_t</a></td></tr>
|
|
<tr class="memdesc:ga68a414f4f08f73a4283511740e419099"><td class="mdescLeft"> </td><td class="mdescRight">The config struct of LED. <br/></td></tr>
|
|
<tr class="separator:ga68a414f4f08f73a4283511740e419099"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga88453c10bcdd5e6a2380fd641bf48b58"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga88453c10bcdd5e6a2380fd641bf48b58"></a>
|
|
typedef struct <a class="el" href="a00035.html#a00358">_led_flash_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga88453c10bcdd5e6a2380fd641bf48b58">led_flash_config_t</a></td></tr>
|
|
<tr class="memdesc:ga88453c10bcdd5e6a2380fd641bf48b58"><td class="mdescLeft"> </td><td class="mdescRight">The flash config struct of LED. <br/></td></tr>
|
|
<tr class="separator:ga88453c10bcdd5e6a2380fd641bf48b58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga282a78e9d7df11dbf752d06b129900ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga282a78e9d7df11dbf752d06b129900ac">_led_status</a> { <br/>
|
|
  <a class="el" href="a00035.html#gga282a78e9d7df11dbf752d06b129900aca8914efe44b8e4c0fc872a15524300e7a">kStatus_LED_Success</a> = kStatus_Success,
|
|
<br/>
|
|
  <a class="el" href="a00035.html#gga282a78e9d7df11dbf752d06b129900aca739191d62d706a9399ecfb03c27501a7">kStatus_LED_Error</a> = MAKE_STATUS(kStatusGroup_LED, 1),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#gga282a78e9d7df11dbf752d06b129900acad4fb887fd148788c63a3823c3321086f">kStatus_LED_InvalidParameter</a> = MAKE_STATUS(kStatusGroup_LED, 2)
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga282a78e9d7df11dbf752d06b129900ac"><td class="mdescLeft"> </td><td class="mdescRight">The status type of LED. <a href="a00035.html#ga282a78e9d7df11dbf752d06b129900ac">More...</a><br/></td></tr>
|
|
<tr class="separator:ga282a78e9d7df11dbf752d06b129900ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa52f8292f954a4ad917f6712b1d2e3de"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gaa52f8292f954a4ad917f6712b1d2e3de">_led_flash_type</a> { <a class="el" href="a00035.html#ggaa52f8292f954a4ad917f6712b1d2e3dea9ff53165a416cc96df5c736976950e0a">kLED_FlashOneColor</a> = 0x00U
|
|
}</td></tr>
|
|
<tr class="memdesc:gaa52f8292f954a4ad917f6712b1d2e3de"><td class="mdescLeft"> </td><td class="mdescRight">The flash type of LED. <a href="a00035.html#gaa52f8292f954a4ad917f6712b1d2e3de">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa52f8292f954a4ad917f6712b1d2e3de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabd1b73f6693cfce35d0646bdc4968605"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gabd1b73f6693cfce35d0646bdc4968605">_led_color</a> { <br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a2894a72f48bb95157b59bdfe1d4d5721">kLED_Black</a> = LED_MAKE_COLOR(0, 0, 0),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a923a3b2518bb69d5025b9e9621cc0ae8">kLED_Red</a> = LED_MAKE_COLOR(255, 0, 0),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a03e3f035a538d513be60d9ba32a5539a">kLED_Green</a> = LED_MAKE_COLOR(0, 255, 0),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a307e5504d9e9a1c510ebd0de840a9e1f">kLED_Yellow</a> = LED_MAKE_COLOR(255, 255, 0),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a59ee5d6c7a715234164c9a030c4d3f9b">kLED_Blue</a> = LED_MAKE_COLOR(0, 0, 255),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a8f4e99975514a3639a398304078d08e1">kLED_Pink</a> = LED_MAKE_COLOR(255, 0, 255),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605a1cacba6b1843e879dd4a5a85fca55435">kLED_Aquamarine</a> = LED_MAKE_COLOR(0, 255, 255),
|
|
<br/>
|
|
  <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605ad6d014a95c481f9044290264c559f78d">kLED_White</a> = LED_MAKE_COLOR(255, 255, 255)
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gabd1b73f6693cfce35d0646bdc4968605"><td class="mdescLeft"> </td><td class="mdescRight">The color type of LED. <a href="a00035.html#gabd1b73f6693cfce35d0646bdc4968605">More...</a><br/></td></tr>
|
|
<tr class="separator:gabd1b73f6693cfce35d0646bdc4968605"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga85a0546eef6beda4fb23a9a2097c7746"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga85a0546eef6beda4fb23a9a2097c7746">_led_type</a> { <br/>
|
|
  <a class="el" href="a00035.html#gga85a0546eef6beda4fb23a9a2097c7746aebe359c12bfcbab9849f3a3d3de8c7cc">kLED_TypeRgb</a> = 0x01U,
|
|
<br/>
|
|
  <a class="el" href="a00035.html#gga85a0546eef6beda4fb23a9a2097c7746ad89ac5514e2522e2625af7fed9c80d43">kLED_TypeMonochrome</a> = 0x02U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga85a0546eef6beda4fb23a9a2097c7746"><td class="mdescLeft"> </td><td class="mdescRight">The type of LED. <a href="a00035.html#ga85a0546eef6beda4fb23a9a2097c7746">More...</a><br/></td></tr>
|
|
<tr class="separator:ga85a0546eef6beda4fb23a9a2097c7746"><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:ga1fd1e552595ec600d7c9c24377e1da7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga1fd1e552595ec600d7c9c24377e1da7e">LED_Init</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle, const <a class="el" href="a00035.html#ga68a414f4f08f73a4283511740e419099">led_config_t</a> *ledConfig)</td></tr>
|
|
<tr class="memdesc:ga1fd1e552595ec600d7c9c24377e1da7e"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a LED with the LED handle and the user configuration structure. <a href="#ga1fd1e552595ec600d7c9c24377e1da7e">More...</a><br/></td></tr>
|
|
<tr class="separator:ga1fd1e552595ec600d7c9c24377e1da7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2937c4494d92a597fcc26518159ed53c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga2937c4494d92a597fcc26518159ed53c">LED_Deinit</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle)</td></tr>
|
|
<tr class="memdesc:ga2937c4494d92a597fcc26518159ed53c"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes a LED instance. <a href="#ga2937c4494d92a597fcc26518159ed53c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2937c4494d92a597fcc26518159ed53c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf75e0b24785ccbff5d3b18af0b5bd20d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gaf75e0b24785ccbff5d3b18af0b5bd20d">LED_SetColor</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle, <a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a> ledRgbColor)</td></tr>
|
|
<tr class="memdesc:gaf75e0b24785ccbff5d3b18af0b5bd20d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LED color. <a href="#gaf75e0b24785ccbff5d3b18af0b5bd20d">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf75e0b24785ccbff5d3b18af0b5bd20d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeab8885cb349165278342341925407fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gaeab8885cb349165278342341925407fb">LED_TurnOnOff</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle, uint8_t turnOnOff)</td></tr>
|
|
<tr class="memdesc:gaeab8885cb349165278342341925407fb"><td class="mdescLeft"> </td><td class="mdescRight">Turns on or off the LED. <a href="#gaeab8885cb349165278342341925407fb">More...</a><br/></td></tr>
|
|
<tr class="separator:gaeab8885cb349165278342341925407fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa498b1f9d3f12329706437e5d97762df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#gaa498b1f9d3f12329706437e5d97762df">LED_Blip</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle)</td></tr>
|
|
<tr class="memdesc:gaa498b1f9d3f12329706437e5d97762df"><td class="mdescLeft"> </td><td class="mdescRight">Blips the LED. <a href="#gaa498b1f9d3f12329706437e5d97762df">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa498b1f9d3f12329706437e5d97762df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga603876bbd160829da7e70c4d85f62616"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga603876bbd160829da7e70c4d85f62616">LED_Flash</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle, <a class="el" href="a00035.html#ga88453c10bcdd5e6a2380fd641bf48b58">led_flash_config_t</a> *ledFlash)</td></tr>
|
|
<tr class="memdesc:ga603876bbd160829da7e70c4d85f62616"><td class="mdescLeft"> </td><td class="mdescRight">Flashes the LED. <a href="#ga603876bbd160829da7e70c4d85f62616">More...</a><br/></td></tr>
|
|
<tr class="separator:ga603876bbd160829da7e70c4d85f62616"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga872dcf0908843f30c377a0bc4937adaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga872dcf0908843f30c377a0bc4937adaa">LED_Dimming</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle, uint16_t dimmingPeriod, uint8_t increasement)</td></tr>
|
|
<tr class="memdesc:ga872dcf0908843f30c377a0bc4937adaa"><td class="mdescLeft"> </td><td class="mdescRight">Adjusts the brightness of the LED. <a href="#ga872dcf0908843f30c377a0bc4937adaa">More...</a><br/></td></tr>
|
|
<tr class="separator:ga872dcf0908843f30c377a0bc4937adaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga95b0a22da0369cdd31e66ff88493adad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga95b0a22da0369cdd31e66ff88493adad">LED_EnterLowpower</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle)</td></tr>
|
|
<tr class="memdesc:ga95b0a22da0369cdd31e66ff88493adad"><td class="mdescLeft"> </td><td class="mdescRight">Prepares to enter low power consumption. <a href="#ga95b0a22da0369cdd31e66ff88493adad">More...</a><br/></td></tr>
|
|
<tr class="separator:ga95b0a22da0369cdd31e66ff88493adad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga26719ed8ec8ac56822f858291e013c94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ga26719ed8ec8ac56822f858291e013c94">LED_ExitLowpower</a> (<a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> ledHandle)</td></tr>
|
|
<tr class="memdesc:ga26719ed8ec8ac56822f858291e013c94"><td class="mdescLeft"> </td><td class="mdescRight">Restores from low power consumption. <a href="#ga26719ed8ec8ac56822f858291e013c94">More...</a><br/></td></tr>
|
|
<tr class="separator:ga26719ed8ec8ac56822f858291e013c94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00360" id="a00360"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _led_pin_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a7054a87b1c5d96cb127b5fae843bbf2a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7054a87b1c5d96cb127b5fae843bbf2a"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a></td></tr>
|
|
<tr class="memdesc:a7054a87b1c5d96cb127b5fae843bbf2a"><td class="mdescLeft"> </td><td class="mdescRight">dimming enable, 0 - disable, 1 - enable <br/></td></tr>
|
|
<tr class="separator:a7054a87b1c5d96cb127b5fae843bbf2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0255e32e756c1c66a614b5c15c8dcd5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0255e32e756c1c66a614b5c15c8dcd5"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#aa0255e32e756c1c66a614b5c15c8dcd5">sourceClock</a></td></tr>
|
|
<tr class="memdesc:aa0255e32e756c1c66a614b5c15c8dcd5"><td class="mdescLeft"> </td><td class="mdescRight">The clock source of the PWM module. <br/></td></tr>
|
|
<tr class="separator:aa0255e32e756c1c66a614b5c15c8dcd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb632c5eca635db2c112c5956b56b59a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb632c5eca635db2c112c5956b56b59a"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#afb632c5eca635db2c112c5956b56b59a">instance</a></td></tr>
|
|
<tr class="memdesc:afb632c5eca635db2c112c5956b56b59a"><td class="mdescLeft"> </td><td class="mdescRight">PWM instance of the pin. <br/></td></tr>
|
|
<tr class="separator:afb632c5eca635db2c112c5956b56b59a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94780ee534ce322cda1cc36c35d19726"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94780ee534ce322cda1cc36c35d19726"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a94780ee534ce322cda1cc36c35d19726">channel</a></td></tr>
|
|
<tr class="memdesc:a94780ee534ce322cda1cc36c35d19726"><td class="mdescLeft"> </td><td class="mdescRight">PWM channel of the pin. <br/></td></tr>
|
|
<tr class="separator:a94780ee534ce322cda1cc36c35d19726"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac21181d9b7187880e23d6ffeb220c159"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac21181d9b7187880e23d6ffeb220c159"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ac21181d9b7187880e23d6ffeb220c159">pinStateDefault</a></td></tr>
|
|
<tr class="memdesc:ac21181d9b7187880e23d6ffeb220c159"><td class="mdescLeft"> </td><td class="mdescRight">The Pin voltage when LED is off (0 - low level, 1 - high level) <br/></td></tr>
|
|
<tr class="separator:ac21181d9b7187880e23d6ffeb220c159"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00361" id="a00361"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _led_rgb_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a5c0a9fd4372e7dc042d060e600649ffd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c0a9fd4372e7dc042d060e600649ffd"></a>
|
|
<a class="el" href="a00035.html#ga55e87ade8e72b6f8dbee053791b7085b">led_pin_config_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a5c0a9fd4372e7dc042d060e600649ffd">redPin</a></td></tr>
|
|
<tr class="memdesc:a5c0a9fd4372e7dc042d060e600649ffd"><td class="mdescLeft"> </td><td class="mdescRight">Red pin setting. <br/></td></tr>
|
|
<tr class="separator:a5c0a9fd4372e7dc042d060e600649ffd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7e2029df9fe2d4dad22cd6cd15a5d29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7e2029df9fe2d4dad22cd6cd15a5d29"></a>
|
|
<a class="el" href="a00035.html#ga55e87ade8e72b6f8dbee053791b7085b">led_pin_config_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ae7e2029df9fe2d4dad22cd6cd15a5d29">greenPin</a></td></tr>
|
|
<tr class="memdesc:ae7e2029df9fe2d4dad22cd6cd15a5d29"><td class="mdescLeft"> </td><td class="mdescRight">Green pin setting. <br/></td></tr>
|
|
<tr class="separator:ae7e2029df9fe2d4dad22cd6cd15a5d29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1663ba88fb604e73fc65757d234b71d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1663ba88fb604e73fc65757d234b71d"></a>
|
|
<a class="el" href="a00035.html#ga55e87ade8e72b6f8dbee053791b7085b">led_pin_config_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ac1663ba88fb604e73fc65757d234b71d">bluePin</a></td></tr>
|
|
<tr class="memdesc:ac1663ba88fb604e73fc65757d234b71d"><td class="mdescLeft"> </td><td class="mdescRight">Blue pin setting. <br/></td></tr>
|
|
<tr class="separator:ac1663ba88fb604e73fc65757d234b71d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00359" id="a00359"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _led_monochrome_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:ac8417963f18b1e739ba3a608c03399f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8417963f18b1e739ba3a608c03399f9"></a>
|
|
<a class="el" href="a00035.html#ga55e87ade8e72b6f8dbee053791b7085b">led_pin_config_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a></td></tr>
|
|
<tr class="memdesc:ac8417963f18b1e739ba3a608c03399f9"><td class="mdescLeft"> </td><td class="mdescRight">Monochrome pin setting. <br/></td></tr>
|
|
<tr class="separator:ac8417963f18b1e739ba3a608c03399f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00357" id="a00357"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _led_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div>
|
|
</div>
|
|
</div>
|
|
<a name="a00358" id="a00358"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _led_flash_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a34d14035c48ed130ed826dddd939d06b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34d14035c48ed130ed826dddd939d06b"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a34d14035c48ed130ed826dddd939d06b">times</a></td></tr>
|
|
<tr class="memdesc:a34d14035c48ed130ed826dddd939d06b"><td class="mdescLeft"> </td><td class="mdescRight">Flash times, LED_FLASH_CYCLE_FOREVER for forever. <br/></td></tr>
|
|
<tr class="separator:a34d14035c48ed130ed826dddd939d06b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a206b2481dca7d3d12cbc13b1fc18d34b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a206b2481dca7d3d12cbc13b1fc18d34b"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a206b2481dca7d3d12cbc13b1fc18d34b">period</a></td></tr>
|
|
<tr class="memdesc:a206b2481dca7d3d12cbc13b1fc18d34b"><td class="mdescLeft"> </td><td class="mdescRight">Flash period, unit is ms. <br/></td></tr>
|
|
<tr class="separator:a206b2481dca7d3d12cbc13b1fc18d34b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b0ca0b7077d924f278e0378a3dd2cd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00035.html#ga4c0d3d21b054dc3e9532268221410495">led_flash_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a4b0ca0b7077d924f278e0378a3dd2cd6">flashType</a></td></tr>
|
|
<tr class="memdesc:a4b0ca0b7077d924f278e0378a3dd2cd6"><td class="mdescLeft"> </td><td class="mdescRight">Flash type, one color or color wheel. <a href="#a4b0ca0b7077d924f278e0378a3dd2cd6">More...</a><br/></td></tr>
|
|
<tr class="separator:a4b0ca0b7077d924f278e0378a3dd2cd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a879ba7d9147e12d37e369f1971508d02"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a879ba7d9147e12d37e369f1971508d02">duty</a></td></tr>
|
|
<tr class="memdesc:a879ba7d9147e12d37e369f1971508d02"><td class="mdescLeft"> </td><td class="mdescRight">Duty of the LED on for one period (duration = duty * period / 100). <a href="#a879ba7d9147e12d37e369f1971508d02">More...</a><br/></td></tr>
|
|
<tr class="separator:a879ba7d9147e12d37e369f1971508d02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a4b0ca0b7077d924f278e0378a3dd2cd6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga4c0d3d21b054dc3e9532268221410495">led_flash_type_t</a> _led_flash_config::flashType</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Refer to <a class="el" href="a00035.html#ga4c0d3d21b054dc3e9532268221410495" title="The flash type of LED. ">led_flash_type_t</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a879ba7d9147e12d37e369f1971508d02"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _led_flash_config::duty</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="gab1c951f31df0dec0a76866f76e5fdacc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_DIMMING_ENABLEMENT   (0U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Enable or disable the dimming feature </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafb4b93ae3a6ca5dad479212ef291ad42"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_COLOR_WHEEL_ENABLEMENT   (0U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Enable or disable the color wheel feature </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5f975104bd800236305e068d1e4d935f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_USE_CONFIGURE_STRUCTURE   (1U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Enable or disable the confgure structure pointer </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga163c4226a9d58115ed32485eb7056da7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_HANDLE_SIZE   ((16U * 3U) + 32U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9eb96498b2b1a7619864ca3482a1d017"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_HANDLE_DEFINE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">name</td><td>)</td>
|
|
<td>   uint32_t name[((<a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7">LED_HANDLE_SIZE</a> + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This macro is used to define a 4 byte aligned led handle. Then use "(led_handle_t)name" to get the led handle.</p>
|
|
<p>The macro should be global and could be optional. You could also define led handle by yourself.</p>
|
|
<p>This is an example, </p>
|
|
<div class="fragment"><div class="line">* <a class="code" href="a00035.html#ga9eb96498b2b1a7619864ca3482a1d017">LED_HANDLE_DEFINE</a>(ledHandle);</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name string of the led handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga605db5821e9d220c6eff157bb5f6cbad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_HANDLE_ARRAY_DEFINE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">name, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">count </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   uint32_t name[count][((<a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7">LED_HANDLE_SIZE</a> + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This macro is used to define a 4 byte aligned led handle array. Then use "(led_handle_t)name[0]" to get the first led handle.</p>
|
|
<p>The macro should be global and could be optional. You could also define these led handle by yourself.</p>
|
|
<p>This is an example, </p>
|
|
<div class="fragment"><div class="line">* <a class="code" href="a00035.html#ga605db5821e9d220c6eff157bb5f6cbad">LED_HANDLE_ARRAY_DEFINE</a>(ledHandleArray,1);</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name string of the led handle array. </td></tr>
|
|
<tr><td class="paramname">count</td><td>The amount of led handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa189c6766bd5be625917152cbbff1c95"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_TIMER_INTERVAL   (100U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga28ef147d17735d1751ac771d53f20d36"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_DIMMING_UPDATE_INTERVAL   (100U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0fcfb713f2c6b0af490d6b65d98416cb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_FLASH_CYCLE_FOREVER   (0xFFFFFFFFU)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga63fae0c4958dbf9353854dc1731c7e73"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_BLIP_INTERVAL   (250U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga59cb1a3d1b67b5efdf1832ee436445a7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define LED_MAKE_COLOR</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">r, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">g, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">b </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   ((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)((((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)b) << 16) | (((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)g) << 8) | ((<a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a>)r)))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga282a78e9d7df11dbf752d06b129900ac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00035.html#ga282a78e9d7df11dbf752d06b129900ac">_led_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga282a78e9d7df11dbf752d06b129900aca8914efe44b8e4c0fc872a15524300e7a"></a>kStatus_LED_Success</em> </td><td class="fielddoc">
|
|
<p>Success. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga282a78e9d7df11dbf752d06b129900aca739191d62d706a9399ecfb03c27501a7"></a>kStatus_LED_Error</em> </td><td class="fielddoc">
|
|
<p>Failed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga282a78e9d7df11dbf752d06b129900acad4fb887fd148788c63a3823c3321086f"></a>kStatus_LED_InvalidParameter</em> </td><td class="fielddoc">
|
|
<p>Invalid parameter. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa52f8292f954a4ad917f6712b1d2e3de"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00035.html#gaa52f8292f954a4ad917f6712b1d2e3de">_led_flash_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaa52f8292f954a4ad917f6712b1d2e3dea9ff53165a416cc96df5c736976950e0a"></a>kLED_FlashOneColor</em> </td><td class="fielddoc">
|
|
<p>Fast with one color. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabd1b73f6693cfce35d0646bdc4968605"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00035.html#gabd1b73f6693cfce35d0646bdc4968605">_led_color</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a2894a72f48bb95157b59bdfe1d4d5721"></a>kLED_Black</em> </td><td class="fielddoc">
|
|
<p>Black. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a923a3b2518bb69d5025b9e9621cc0ae8"></a>kLED_Red</em> </td><td class="fielddoc">
|
|
<p>Red. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a03e3f035a538d513be60d9ba32a5539a"></a>kLED_Green</em> </td><td class="fielddoc">
|
|
<p>Green. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a307e5504d9e9a1c510ebd0de840a9e1f"></a>kLED_Yellow</em> </td><td class="fielddoc">
|
|
<p>Yellow. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a59ee5d6c7a715234164c9a030c4d3f9b"></a>kLED_Blue</em> </td><td class="fielddoc">
|
|
<p>Blue. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a8f4e99975514a3639a398304078d08e1"></a>kLED_Pink</em> </td><td class="fielddoc">
|
|
<p>Pink. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605a1cacba6b1843e879dd4a5a85fca55435"></a>kLED_Aquamarine</em> </td><td class="fielddoc">
|
|
<p>Aquamarine. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd1b73f6693cfce35d0646bdc4968605ad6d014a95c481f9044290264c559f78d"></a>kLED_White</em> </td><td class="fielddoc">
|
|
<p>White. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga85a0546eef6beda4fb23a9a2097c7746"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00035.html#ga85a0546eef6beda4fb23a9a2097c7746">_led_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga85a0546eef6beda4fb23a9a2097c7746aebe359c12bfcbab9849f3a3d3de8c7cc"></a>kLED_TypeRgb</em> </td><td class="fielddoc">
|
|
<p>RGB LED. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga85a0546eef6beda4fb23a9a2097c7746ad89ac5514e2522e2625af7fed9c80d43"></a>kLED_TypeMonochrome</em> </td><td class="fielddoc">
|
|
<p>Monochrome LED. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga1fd1e552595ec600d7c9c24377e1da7e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00035.html#ga68a414f4f08f73a4283511740e419099">led_config_t</a> * </td>
|
|
<td class="paramname"><em>ledConfig</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function configures the LED with user-defined settings. The user can configure the configuration structure. The parameter ledHandle is a pointer to point to a memory space of size <a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7" title="Definition of LED handle size. ">LED_HANDLE_SIZE</a> allocated by the caller. The LED supports two types LED, RGB and monochrome. Please refer to <a class="el" href="a00035.html#ga28ffd75a93e744515b917687482d410f" title="The type of LED. ">led_type_t</a>. These two types can be set by using <a class="el" href="a00035.html#ga68a414f4f08f73a4283511740e419099" title="The config struct of LED. ">led_config_t</a>. The LED also supports LED dimming mode.</p>
|
|
<p>Example below shows how to use this API to configure the LED. For monochrome LED, </p>
|
|
<div class="fragment"><div class="line">* <span class="keyword">static</span> <a class="code" href="a00035.html#ga9eb96498b2b1a7619864ca3482a1d017">LED_HANDLE_DEFINE</a>(s_ledMonochromeHandle);</div>
|
|
<div class="line">* <a class="code" href="a00035.html#a00357">led_config_t</a> ledMonochromeConfig;</div>
|
|
<div class="line">* ledMonochromeConfig.type = <a class="code" href="a00035.html#gga85a0546eef6beda4fb23a9a2097c7746ad89ac5514e2522e2625af7fed9c80d43">kLED_TypeMonochrome</a>;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.<a class="code" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a> = 0;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.gpio.port = 0;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.gpio.pin = 1;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.gpio.pinStateDefault = 0;</div>
|
|
<div class="line">* <a class="code" href="a00035.html#ga1fd1e552595ec600d7c9c24377e1da7e">LED_Init</a>((<a class="code" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a>)s_ledMonochromeHandle, &ledMonochromeConfig);</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><p> For rgb LED, </p>
|
|
<div class="fragment"><div class="line">* <span class="keyword">static</span> <a class="code" href="a00035.html#ga9eb96498b2b1a7619864ca3482a1d017">LED_HANDLE_DEFINE</a>(s_ledRgbHandle);</div>
|
|
<div class="line">* <a class="code" href="a00035.html#a00357">led_config_t</a> ledRgbConfig;</div>
|
|
<div class="line">* ledRgbConfig.type = <a class="code" href="a00035.html#gga85a0546eef6beda4fb23a9a2097c7746aebe359c12bfcbab9849f3a3d3de8c7cc">kLED_TypeRgb</a>;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#a5c0a9fd4372e7dc042d060e600649ffd">redPin</a>.<a class="code" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a> = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#a5c0a9fd4372e7dc042d060e600649ffd">redPin</a>.gpio.port = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#a5c0a9fd4372e7dc042d060e600649ffd">redPin</a>.gpio.pin = 1;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#a5c0a9fd4372e7dc042d060e600649ffd">redPin</a>.gpio.pinStateDefault = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ae7e2029df9fe2d4dad22cd6cd15a5d29">greenPin</a>.<a class="code" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a> = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ae7e2029df9fe2d4dad22cd6cd15a5d29">greenPin</a>.gpio.port = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ae7e2029df9fe2d4dad22cd6cd15a5d29">greenPin</a>.gpio.pin = 2;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ae7e2029df9fe2d4dad22cd6cd15a5d29">greenPin</a>.gpio.pinStateDefault = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ac1663ba88fb604e73fc65757d234b71d">bluePin</a>.<a class="code" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a> = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ac1663ba88fb604e73fc65757d234b71d">bluePin</a>.gpio.port = 0;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ac1663ba88fb604e73fc65757d234b71d">bluePin</a>.gpio.pin = 3;</div>
|
|
<div class="line">* ledRgbConfig.<a class="code" href="a00035.html#a0e764f94942f72b4017b8c99963e1888">ledRgb</a>.<a class="code" href="a00035.html#ac1663ba88fb604e73fc65757d234b71d">bluePin</a>.gpio.pinStateDefault = 0;</div>
|
|
<div class="line">* <a class="code" href="a00035.html#ga1fd1e552595ec600d7c9c24377e1da7e">LED_Init</a>((<a class="code" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a>)s_ledRgbHandle, &ledRgbConfig);</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><p> For dimming monochrome LED, </p>
|
|
<div class="fragment"><div class="line">* <span class="keyword">static</span> <a class="code" href="a00035.html#ga9eb96498b2b1a7619864ca3482a1d017">LED_HANDLE_DEFINE</a>(s_ledMonochromeHandle);</div>
|
|
<div class="line">* <a class="code" href="a00035.html#a00357">led_config_t</a> ledMonochromeConfig;</div>
|
|
<div class="line">* ledMonochromeConfig.type = <a class="code" href="a00035.html#gga85a0546eef6beda4fb23a9a2097c7746ad89ac5514e2522e2625af7fed9c80d43">kLED_TypeMonochrome</a>;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.<a class="code" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a> = 1;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.sourceClock = 48000000;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.instance = 0;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.channel = 1;</div>
|
|
<div class="line">* ledMonochromeConfig.<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.pinStateDefault = 0;</div>
|
|
<div class="line">* <a class="code" href="a00035.html#ga1fd1e552595ec600d7c9c24377e1da7e">LED_Init</a>((<a class="code" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a>)s_ledMonochromeHandle, &ledMonochromeConfig);</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><p> For multiple LEDs, </p>
|
|
<div class="fragment"><div class="line">* <span class="keyword">static</span> <a class="code" href="a00035.html#ga605db5821e9d220c6eff157bb5f6cbad">LED_HANDLE_ARRAY_DEFINE</a>(s_ledArrayHandle, count);</div>
|
|
<div class="line">* <a class="code" href="a00035.html#a00357">led_config_t</a> ledArrayConfig[count];</div>
|
|
<div class="line">* <span class="keywordflow">for</span>(uint8_t i = 0; i < count; i++ )</div>
|
|
<div class="line">* {</div>
|
|
<div class="line">* ledArrayConfig[i].type = <a class="code" href="a00035.html#gga85a0546eef6beda4fb23a9a2097c7746ad89ac5514e2522e2625af7fed9c80d43">kLED_TypeMonochrome</a>;</div>
|
|
<div class="line">* ledArrayConfig[i].<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.<a class="code" href="a00035.html#a7054a87b1c5d96cb127b5fae843bbf2a">dimmingEnable</a> = 1;</div>
|
|
<div class="line">* ledArrayConfig[i].<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.sourceClock = 48000000;</div>
|
|
<div class="line">* ledArrayConfig[i].<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.instance = 0;</div>
|
|
<div class="line">* ledArrayConfig[i].<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.channel = 1;</div>
|
|
<div class="line">* ledArrayConfig[i].<a class="code" href="a00035.html#a6bc0863fc03880ca8bcc1d86b45af4f2">ledMonochrome</a>.<a class="code" href="a00035.html#ac8417963f18b1e739ba3a608c03399f9">monochromePin</a>.dimming.pinStateDefault = 0;</div>
|
|
<div class="line">* <a class="code" href="a00035.html#ga1fd1e552595ec600d7c9c24377e1da7e">LED_Init</a>((<a class="code" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a>)s_ledArrayHandle[i], &ledArrayConfig[i]);</div>
|
|
<div class="line">* }</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>Pointer to point to a memory space of size <a class="el" href="a00035.html#ga163c4226a9d58115ed32485eb7056da7" title="Definition of LED handle size. ">LED_HANDLE_SIZE</a> allocated by the caller. The handle should be 4 byte aligned, because unaligned access doesn't be supported on some devices. You can define one handle in the following two ways: <a class="el" href="a00035.html#ga9eb96498b2b1a7619864ca3482a1d017" title="Defines the led handle. ">LED_HANDLE_DEFINE(ledHandle)</a>; or uint32_t ledHandle[((LED_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]; You can define multiple handles in the following way: <a class="el" href="a00035.html#ga605db5821e9d220c6eff157bb5f6cbad" title="Defines the led handle array. ">LED_HANDLE_ARRAY_DEFINE(ledHandleArray, count)</a>; </td></tr>
|
|
<tr><td class="paramname">ledConfig</td><td>Pointer to user-defined configuration structure. please note, if the LED_USE_CONFIGURE_STRUCTURE is set to 1, then user must use const buffer forledConfig, LED module will directly use the const buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Error</td><td>An error occurred. </td></tr>
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>LED initialization succeed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2937c4494d92a597fcc26518159ed53c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function deinitializes the LED instance.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>LED de-initialization succeed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf75e0b24785ccbff5d3b18af0b5bd20d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_SetColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga49b09097ec358cb93e9b950a10debc05">led_color_t</a> </td>
|
|
<td class="paramname"><em>ledRgbColor</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function sets the LED color. The function only supports the RGB LED. The default color is <a class="el" href="a00035.html#ggabd1b73f6693cfce35d0646bdc4968605ad6d014a95c481f9044290264c559f78d" title="White. ">kLED_White</a>. Please refer to <a class="el" href="a00035.html#ga59cb1a3d1b67b5efdf1832ee436445a7" title="Definition to set LED color. ">LED_MAKE_COLOR(r,g,b)</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
<tr><td class="paramname">ledRgbColor</td><td>LED color. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Error</td><td>An error occurred. </td></tr>
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Color setting succeed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaeab8885cb349165278342341925407fb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_TurnOnOff </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>turnOnOff</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function turns on or off the led.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
<tr><td class="paramname">turnOnOff</td><td>Setting value, 1 - turns on, 0 - turns off. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Error</td><td>An error occurred. </td></tr>
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Successfully turn on or off the LED. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa498b1f9d3f12329706437e5d97762df"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_Blip </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function blips the led.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Error</td><td>An error occurred. </td></tr>
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Successfully blip the LED. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga603876bbd160829da7e70c4d85f62616"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_Flash </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga88453c10bcdd5e6a2380fd641bf48b58">led_flash_config_t</a> * </td>
|
|
<td class="paramname"><em>ledFlash</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function flashes the led. The flash configuration is passed by using <a class="el" href="a00035.html#ga88453c10bcdd5e6a2380fd641bf48b58" title="The flash config struct of LED. ">led_flash_config_t</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
<tr><td class="paramname">ledFlash</td><td>LED flash configuration. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Error</td><td>An error occurred. </td></tr>
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Successfully flash the LED. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga872dcf0908843f30c377a0bc4937adaa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_Dimming </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>dimmingPeriod</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>increasement</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function adjust the brightness of the LED.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
<tr><td class="paramname">dimmingPeriod</td><td>The duration of the dimming (unit is ms). </td></tr>
|
|
<tr><td class="paramname">increasement</td><td>Brighten or dim (1 - brighten, 0 - dim). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Error</td><td>An error occurred. </td></tr>
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Successfully adjust the brightness of the LED. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga95b0a22da0369cdd31e66ff88493adad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_EnterLowpower </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function is used to prepare to enter low power consumption.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Successful operation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga26719ed8ec8ac56822f858291e013c94"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00035.html#ga0ce30ec3455305300bd367a04a96465a">led_status_t</a> LED_ExitLowpower </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00035.html#ga2e6f49cb4cfe9771f15be4734ebb21c2">led_handle_t</a> </td>
|
|
<td class="paramname"><em>ledHandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function is used to restore from low power consumption.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledHandle</td><td>LED handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_LED_Success</td><td>Successful operation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|