246 lines
33 KiB
HTML
246 lines
33 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: STM32WLx_Module Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_s_t_m32_w_lx___module.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="class_s_t_m32_w_lx___module-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">STM32WLx_Module Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_s_t_m32_w_lx___module_8h_source.html">STM32WLx_Module.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for STM32WLx_Module:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_s_t_m32_w_lx___module.png" usemap="#STM32WLx_5FModule_map" alt=""/>
|
|
<map id="STM32WLx_5FModule_map" name="STM32WLx_5FModule_map">
|
|
<area href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o..." alt="Module" shape="rect" coords="0,0,125,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_module')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a5a67b3a63420d762ecba9448671c99bf inherit pub_types_class_module" id="r_a5a67b3a63420d762ecba9448671c99bf"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">OpMode_t</a> { <a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">MODE_END_OF_TABLE</a> = 0
|
|
, <a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">MODE_IDLE</a>
|
|
, <a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">MODE_RX</a>
|
|
, <a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">MODE_TX</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a5a67b3a63420d762ecba9448671c99bf"><td class="mdescLeft"> </td><td class="mdescRight">Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios, but some radios define their own constants to be used instead. <a href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a67b3a63420d762ecba9448671c99bf inherit pub_types_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5e5dd089a3117f6499b818b426e2e0d inherit pub_types_class_module" id="r_af5e5dd089a3117f6499b818b426e2e0d"><td class="memItemLeft" align="right" valign="top"><a id="af5e5dd089a3117f6499b818b426e2e0d" name="af5e5dd089a3117f6499b818b426e2e0d"></a>enum  </td><td class="memItemRight" valign="bottom"><b>BitWidth_t</b> { <b>BITS_0</b> = 0
|
|
, <b>BITS_8</b> = 8
|
|
, <b>BITS_16</b> = 16
|
|
, <b>BITS_32</b> = 32
|
|
}</td></tr>
|
|
<tr class="separator:af5e5dd089a3117f6499b818b426e2e0d inherit pub_types_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9393088249856eab568126aeb2493e4a inherit pub_types_class_module" id="r_a9393088249856eab568126aeb2493e4a"><td class="memItemLeft" align="right" valign="top">
|
|
typedef int16_t(* </td><td class="memItemRight" valign="bottom"><b>SPIparseStatusCb_t</b>) (uint8_t in)</td></tr>
|
|
<tr class="memdesc:a9393088249856eab568126aeb2493e4a inherit pub_types_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Callback for parsing SPI status. <br /></td></tr>
|
|
<tr class="separator:a9393088249856eab568126aeb2493e4a inherit pub_types_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ad7bef7d380d3b6b88dca99bd35d640 inherit pub_types_class_module" id="r_a1ad7bef7d380d3b6b88dca99bd35d640"><td class="memItemLeft" align="right" valign="top">
|
|
typedef int16_t(* </td><td class="memItemRight" valign="bottom"><b>SPIcheckStatusCb_t</b>) (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a1ad7bef7d380d3b6b88dca99bd35d640 inherit pub_types_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Callback for validation SPI status. <br /></td></tr>
|
|
<tr class="separator:a1ad7bef7d380d3b6b88dca99bd35d640 inherit pub_types_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_module')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a817178405f125e068e88bad62aeb6f3b inherit pub_methods_class_module" id="r_a817178405f125e068e88bad62aeb6f3b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module</a> (<a class="el" href="class_radio_lib_hal.html">RadioLibHal</a> *<a class="el" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">hal</a>, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio=RADIOLIB_NC)</td></tr>
|
|
<tr class="memdesc:a817178405f125e068e88bad62aeb6f3b inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> constructor. <br /></td></tr>
|
|
<tr class="separator:a817178405f125e068e88bad62aeb6f3b inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a919baf2e46c357ebfcdbc1025b6c551e inherit pub_methods_class_module" id="r_a919baf2e46c357ebfcdbc1025b6c551e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a919baf2e46c357ebfcdbc1025b6c551e">Module</a> (const <a class="el" href="class_module.html">Module</a> &mod)</td></tr>
|
|
<tr class="memdesc:a919baf2e46c357ebfcdbc1025b6c551e inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
|
|
<tr class="separator:a919baf2e46c357ebfcdbc1025b6c551e inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ea888758b4a7784082d513a1e7849a4 inherit pub_methods_class_module" id="r_a4ea888758b4a7784082d513a1e7849a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_module.html">Module</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">operator=</a> (const <a class="el" href="class_module.html">Module</a> &mod)</td></tr>
|
|
<tr class="memdesc:a4ea888758b4a7784082d513a1e7849a4 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Overload for assignment operator. <br /></td></tr>
|
|
<tr class="separator:a4ea888758b4a7784082d513a1e7849a4 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1956ac81429ec1f61f83dbc081cf18c inherit pub_methods_class_module" id="r_ad1956ac81429ec1f61f83dbc081cf18c"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>init</b> ()</td></tr>
|
|
<tr class="memdesc:ad1956ac81429ec1f61f83dbc081cf18c inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Initialize low-level module control. <br /></td></tr>
|
|
<tr class="separator:ad1956ac81429ec1f61f83dbc081cf18c inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45bd514a1f2859d9a867c8f9b13eb332 inherit pub_methods_class_module" id="r_a45bd514a1f2859d9a867c8f9b13eb332"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>term</b> ()</td></tr>
|
|
<tr class="memdesc:a45bd514a1f2859d9a867c8f9b13eb332 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Terminate low-level module control. <br /></td></tr>
|
|
<tr class="separator:a45bd514a1f2859d9a867c8f9b13eb332 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a369e916626c821ecec85f25d5b46d752 inherit pub_methods_class_module" id="r_a369e916626c821ecec85f25d5b46d752"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a369e916626c821ecec85f25d5b46d752">SPIgetRegValue</a> (uint32_t reg, uint8_t msb=7, uint8_t lsb=0)</td></tr>
|
|
<tr class="memdesc:a369e916626c821ecec85f25d5b46d752 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. <br /></td></tr>
|
|
<tr class="separator:a369e916626c821ecec85f25d5b46d752 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed95fba2ee72d7a2a21f98dd63ae4ad1 inherit pub_methods_class_module" id="r_aed95fba2ee72d7a2a21f98dd63ae4ad1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#aed95fba2ee72d7a2a21f98dd63ae4ad1">SPIsetRegValue</a> (uint32_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF, bool force=false)</td></tr>
|
|
<tr class="memdesc:aed95fba2ee72d7a2a21f98dd63ae4ad1 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. <br /></td></tr>
|
|
<tr class="separator:aed95fba2ee72d7a2a21f98dd63ae4ad1 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac993ab8e2ea0f5aa93339d1f6ffb54ee inherit pub_methods_class_module" id="r_ac993ab8e2ea0f5aa93339d1f6ffb54ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ac993ab8e2ea0f5aa93339d1f6ffb54ee">SPIreadRegisterBurst</a> (uint32_t reg, size_t numBytes, uint8_t *inBytes)</td></tr>
|
|
<tr class="memdesc:ac993ab8e2ea0f5aa93339d1f6ffb54ee inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI burst read method. <br /></td></tr>
|
|
<tr class="separator:ac993ab8e2ea0f5aa93339d1f6ffb54ee inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab250eb929068e0c890e16e8e6d7cd7e6 inherit pub_methods_class_module" id="r_ab250eb929068e0c890e16e8e6d7cd7e6"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ab250eb929068e0c890e16e8e6d7cd7e6">SPIreadRegister</a> (uint32_t reg)</td></tr>
|
|
<tr class="memdesc:ab250eb929068e0c890e16e8e6d7cd7e6 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. <br /></td></tr>
|
|
<tr class="separator:ab250eb929068e0c890e16e8e6d7cd7e6 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10809e942c686b4e605269e58bd637b9 inherit pub_methods_class_module" id="r_a10809e942c686b4e605269e58bd637b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a10809e942c686b4e605269e58bd637b9">SPIwriteRegisterBurst</a> (uint32_t reg, const uint8_t *data, size_t numBytes)</td></tr>
|
|
<tr class="memdesc:a10809e942c686b4e605269e58bd637b9 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI burst write method. <br /></td></tr>
|
|
<tr class="separator:a10809e942c686b4e605269e58bd637b9 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60ca6b4cae98f7d935191a569d519913 inherit pub_methods_class_module" id="r_a60ca6b4cae98f7d935191a569d519913"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a60ca6b4cae98f7d935191a569d519913">SPIwriteRegister</a> (uint32_t reg, uint8_t data)</td></tr>
|
|
<tr class="memdesc:a60ca6b4cae98f7d935191a569d519913 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. <br /></td></tr>
|
|
<tr class="separator:a60ca6b4cae98f7d935191a569d519913 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bfbddb1ff044f8b1865aac89246445d inherit pub_methods_class_module" id="r_a2bfbddb1ff044f8b1865aac89246445d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a2bfbddb1ff044f8b1865aac89246445d">SPItransfer</a> (uint16_t cmd, uint32_t reg, const uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)</td></tr>
|
|
<tr class="memdesc:a2bfbddb1ff044f8b1865aac89246445d inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI single transfer method. <br /></td></tr>
|
|
<tr class="separator:a2bfbddb1ff044f8b1865aac89246445d inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5efa7ae78cab1d7f43005e965923f769 inherit pub_methods_class_module" id="r_a5efa7ae78cab1d7f43005e965923f769"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">SPIcheckStream</a> ()</td></tr>
|
|
<tr class="memdesc:a5efa7ae78cab1d7f43005e965923f769 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to check the result of last SPI stream transfer. <br /></td></tr>
|
|
<tr class="separator:a5efa7ae78cab1d7f43005e965923f769 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adacceb57ecfecb09150c135b2b44436f inherit pub_methods_class_module" id="r_adacceb57ecfecb09150c135b2b44436f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#adacceb57ecfecb09150c135b2b44436f">SPIreadStream</a> (uint16_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:adacceb57ecfecb09150c135b2b44436f inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a read transaction with SPI stream. <br /></td></tr>
|
|
<tr class="separator:adacceb57ecfecb09150c135b2b44436f inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4af5fc5fd60e0aadb8a69606e511946 inherit pub_methods_class_module" id="r_ad4af5fc5fd60e0aadb8a69606e511946"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad4af5fc5fd60e0aadb8a69606e511946">SPIreadStream</a> (const uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:ad4af5fc5fd60e0aadb8a69606e511946 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a read transaction with SPI stream. <br /></td></tr>
|
|
<tr class="separator:ad4af5fc5fd60e0aadb8a69606e511946 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47e6e0c4e792a5ef7b3bb040947666a6 inherit pub_methods_class_module" id="r_a47e6e0c4e792a5ef7b3bb040947666a6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a47e6e0c4e792a5ef7b3bb040947666a6">SPIwriteStream</a> (uint16_t cmd, const uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:a47e6e0c4e792a5ef7b3bb040947666a6 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a write transaction with SPI stream. <br /></td></tr>
|
|
<tr class="separator:a47e6e0c4e792a5ef7b3bb040947666a6 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5594e8024d34d2d168413ae5c28e73b inherit pub_methods_class_module" id="r_af5594e8024d34d2d168413ae5c28e73b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af5594e8024d34d2d168413ae5c28e73b">SPIwriteStream</a> (const uint8_t *cmd, uint8_t cmdLen, const uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:af5594e8024d34d2d168413ae5c28e73b inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a write transaction with SPI stream. <br /></td></tr>
|
|
<tr class="separator:af5594e8024d34d2d168413ae5c28e73b inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b3f89fc63a82eb5fd55a7ddd72318fe inherit pub_methods_class_module" id="r_a2b3f89fc63a82eb5fd55a7ddd72318fe"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a2b3f89fc63a82eb5fd55a7ddd72318fe">SPItransferStream</a> (const uint8_t *cmd, uint8_t cmdLen, bool write, const uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio)</td></tr>
|
|
<tr class="memdesc:a2b3f89fc63a82eb5fd55a7ddd72318fe inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI single transfer method for modules with stream-type SPI interface (<a class="el" href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...">SX126x</a>, <a class="el" href="class_s_x128x.html" title="Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...">SX128x</a> etc.). <br /></td></tr>
|
|
<tr class="separator:a2b3f89fc63a82eb5fd55a7ddd72318fe inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab61bc5066c356e2d0d79f08a2bd0fbc9 inherit pub_methods_class_module" id="r_ab61bc5066c356e2d0d79f08a2bd0fbc9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">getIrq</a> () const</td></tr>
|
|
<tr class="memdesc:ab61bc5066c356e2d0d79f08a2bd0fbc9 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of interrupt/GPIO. <br /></td></tr>
|
|
<tr class="separator:ab61bc5066c356e2d0d79f08a2bd0fbc9 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6cddbf3aebec9717a1a381dd81ad398 inherit pub_methods_class_module" id="r_ad6cddbf3aebec9717a1a381dd81ad398"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">getRst</a> () const</td></tr>
|
|
<tr class="memdesc:ad6cddbf3aebec9717a1a381dd81ad398 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of hardware reset pin. <br /></td></tr>
|
|
<tr class="separator:ad6cddbf3aebec9717a1a381dd81ad398 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ec27f0ba5e0009ea9661a5110526b52 inherit pub_methods_class_module" id="r_a4ec27f0ba5e0009ea9661a5110526b52"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">getGpio</a> () const</td></tr>
|
|
<tr class="memdesc:a4ec27f0ba5e0009ea9661a5110526b52 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of second interrupt/GPIO. <br /></td></tr>
|
|
<tr class="separator:a4ec27f0ba5e0009ea9661a5110526b52 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d3adea64acab11c47c804afc74bd4f3 inherit pub_methods_class_module" id="r_a7d3adea64acab11c47c804afc74bd4f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">setRfSwitchPins</a> (uint32_t rxEn, uint32_t txEn)</td></tr>
|
|
<tr class="memdesc:a7d3adea64acab11c47c804afc74bd4f3 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the <code>txEn</code> pin will be HIGH, during RX the <code>rxPin</code> will be HIGH. <br /></td></tr>
|
|
<tr class="separator:a7d3adea64acab11c47c804afc74bd4f3 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac308fa817a5c36c5dc724a0d15cefd4d inherit pub_methods_class_module" id="r_ac308fa817a5c36c5dc724a0d15cefd4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">setRfSwitchTable</a> (const uint32_t(&pins)[<a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>], const <a class="el" href="struct_module_1_1_rf_switch_mode__t.html">RfSwitchMode_t</a> table[])</td></tr>
|
|
<tr class="memdesc:ac308fa817a5c36c5dc724a0d15cefd4d inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. <br /></td></tr>
|
|
<tr class="separator:ac308fa817a5c36c5dc724a0d15cefd4d inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5699a937b62ba41387567b4d679b9377 inherit pub_methods_class_module" id="r_a5699a937b62ba41387567b4d679b9377"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_module_1_1_rf_switch_mode__t.html">RfSwitchMode_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a5699a937b62ba41387567b4d679b9377">findRfSwitchMode</a> (uint8_t mode) const</td></tr>
|
|
<tr class="memdesc:a5699a937b62ba41387567b4d679b9377 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Find a mode in the RfSwitchTable. <br /></td></tr>
|
|
<tr class="separator:a5699a937b62ba41387567b4d679b9377 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbed643f082286012bf44bba22381ae6 inherit pub_methods_class_module" id="r_afbed643f082286012bf44bba22381ae6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#afbed643f082286012bf44bba22381ae6">setRfSwitchState</a> (uint8_t mode)</td></tr>
|
|
<tr class="memdesc:afbed643f082286012bf44bba22381ae6 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Set RF switch state. <br /></td></tr>
|
|
<tr class="separator:afbed643f082286012bf44bba22381ae6 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7df4c687249c07af2594a5f7ad0a946f inherit pub_methods_class_module" id="r_a7df4c687249c07af2594a5f7ad0a946f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7df4c687249c07af2594a5f7ad0a946f">waitForMicroseconds</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> start, <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> len)</td></tr>
|
|
<tr class="memdesc:a7df4c687249c07af2594a5f7ad0a946f inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt timing mode, it is up to the user to set up the timing interrupt! <br /></td></tr>
|
|
<tr class="separator:a7df4c687249c07af2594a5f7ad0a946f inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_module')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a4483f0a39a523dd1b37b467d81418f7d inherit pub_attribs_class_module" id="r_a4483f0a39a523dd1b37b467d81418f7d"><td class="memItemLeft" align="right" valign="top">
|
|
<a class="el" href="class_radio_lib_hal.html">RadioLibHal</a> * </td><td class="memItemRight" valign="bottom"><b>hal</b> = NULL</td></tr>
|
|
<tr class="memdesc:a4483f0a39a523dd1b37b467d81418f7d inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Hardware abstraction layer to be used. <br /></td></tr>
|
|
<tr class="separator:a4483f0a39a523dd1b37b467d81418f7d inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a4fc4101fb3f134152b458c447b8ecb inherit pub_attribs_class_module" id="r_a3a4fc4101fb3f134152b458c447b8ecb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_module_1_1_s_p_i_config__t.html">SPIConfig_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a3a4fc4101fb3f134152b458c447b8ecb">spiConfig</a></td></tr>
|
|
<tr class="memdesc:a3a4fc4101fb3f134152b458c447b8ecb inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI configuration structure. The default configuration corresponds to register-access modules, such as <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a>. <br /></td></tr>
|
|
<tr class="separator:a3a4fc4101fb3f134152b458c447b8ecb inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_attribs_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_module')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a0c11551e12579bbabf57b19e12555b3c inherit pub_static_attribs_class_module" id="r_a0c11551e12579bbabf57b19e12555b3c"><td class="memItemLeft" align="right" valign="top">
|
|
static const size_t </td><td class="memItemRight" valign="bottom"><b>RFSWITCH_MAX_PINS</b> = 5</td></tr>
|
|
<tr class="memdesc:a0c11551e12579bbabf57b19e12555b3c inherit pub_static_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this constant in your sketch when defining a rfswitch pins array, to prevent issues when this value is ever increased and such an array gets extra zero elements (that will be interpreted as pin 0). <br /></td></tr>
|
|
<tr class="separator:a0c11551e12579bbabf57b19e12555b3c inherit pub_static_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This is a subclass of <a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> to be used with the <a class="el" href="class_s_t_m32_w_lx.html" title="Derived class for STM32WL modules.">STM32WLx</a> driver.</p>
|
|
<p>It is used to override some callbacks, allowing access to some of the radio control signals that are wired to internal registers instead of actual GPIO pins. </p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/SX126x/<a class="el" href="_s_t_m32_w_lx___module_8h_source.html">STM32WLx_Module.h</a></li>
|
|
<li>src/modules/SX126x/<b>STM32WLx_Module.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_s_t_m32_w_lx___module.html">STM32WLx_Module</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|