263 lines
39 KiB
HTML
263 lines
39 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">
|
|
<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.9.1"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<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.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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 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"><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="separator:a5a67b3a63420d762ecba9448671c99bf inherit pub_types_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9393088249856eab568126aeb2493e4a inherit pub_types_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a9393088249856eab568126aeb2493e4a"></a>
|
|
typedef int16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a>) (uint8_t in)</td></tr>
|
|
<tr class="memdesc:a9393088249856eab568126aeb2493e4a inherit pub_types_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI status parsing callback typedef. <br /></td></tr>
|
|
<tr class="separator:a9393088249856eab568126aeb2493e4a 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"><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. <a href="class_module.html#a817178405f125e068e88bad62aeb6f3b">More...</a><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"><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. <a href="class_module.html#a919baf2e46c357ebfcdbc1025b6c551e">More...</a><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"><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. <a href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">More...</a><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"><td class="memItemLeft" align="right" valign="top"><a id="ad1956ac81429ec1f61f83dbc081cf18c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">init</a> ()</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"><td class="memItemLeft" align="right" valign="top"><a id="a45bd514a1f2859d9a867c8f9b13eb332"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a> ()</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:a01e15988ec448c76142ee5709929be2c inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a01e15988ec448c76142ee5709929be2c">SPIgetRegValue</a> (uint16_t reg, uint8_t msb=7, uint8_t lsb=0)</td></tr>
|
|
<tr class="memdesc:a01e15988ec448c76142ee5709929be2c 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. <a href="class_module.html#a01e15988ec448c76142ee5709929be2c">More...</a><br /></td></tr>
|
|
<tr class="separator:a01e15988ec448c76142ee5709929be2c inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a081191402ad5c49e6c21982fc4587b77 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a081191402ad5c49e6c21982fc4587b77">SPIsetRegValue</a> (uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)</td></tr>
|
|
<tr class="memdesc:a081191402ad5c49e6c21982fc4587b77 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. <a href="class_module.html#a081191402ad5c49e6c21982fc4587b77">More...</a><br /></td></tr>
|
|
<tr class="separator:a081191402ad5c49e6c21982fc4587b77 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a874e030f1931e606e380930d37dd83ee inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a874e030f1931e606e380930d37dd83ee">SPIreadRegisterBurst</a> (uint16_t reg, size_t numBytes, uint8_t *inBytes)</td></tr>
|
|
<tr class="memdesc:a874e030f1931e606e380930d37dd83ee inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI burst read method. <a href="class_module.html#a874e030f1931e606e380930d37dd83ee">More...</a><br /></td></tr>
|
|
<tr class="separator:a874e030f1931e606e380930d37dd83ee inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a545e4a001da0d9f6358279ac40d4f0 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a9a545e4a001da0d9f6358279ac40d4f0">SPIreadRegister</a> (uint16_t reg)</td></tr>
|
|
<tr class="memdesc:a9a545e4a001da0d9f6358279ac40d4f0 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. <a href="class_module.html#a9a545e4a001da0d9f6358279ac40d4f0">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a545e4a001da0d9f6358279ac40d4f0 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af474f82d00fffc1ee0fc8def2c7f220c inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af474f82d00fffc1ee0fc8def2c7f220c">SPIwriteRegisterBurst</a> (uint16_t reg, uint8_t *data, size_t numBytes)</td></tr>
|
|
<tr class="memdesc:af474f82d00fffc1ee0fc8def2c7f220c inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI burst write method. <a href="class_module.html#af474f82d00fffc1ee0fc8def2c7f220c">More...</a><br /></td></tr>
|
|
<tr class="separator:af474f82d00fffc1ee0fc8def2c7f220c inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4437af6552e258e95ed8ed452afa6dd4 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4437af6552e258e95ed8ed452afa6dd4">SPIwriteRegister</a> (uint16_t reg, uint8_t data)</td></tr>
|
|
<tr class="memdesc:a4437af6552e258e95ed8ed452afa6dd4 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. <a href="class_module.html#a4437af6552e258e95ed8ed452afa6dd4">More...</a><br /></td></tr>
|
|
<tr class="separator:a4437af6552e258e95ed8ed452afa6dd4 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78dd39aa71d97e2220a880df8162fdde inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">SPItransfer</a> (uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)</td></tr>
|
|
<tr class="memdesc:a78dd39aa71d97e2220a880df8162fdde inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI single transfer method. <a href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">More...</a><br /></td></tr>
|
|
<tr class="separator:a78dd39aa71d97e2220a880df8162fdde inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5efa7ae78cab1d7f43005e965923f769 inherit pub_methods_class_module"><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. <a href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">More...</a><br /></td></tr>
|
|
<tr class="separator:a5efa7ae78cab1d7f43005e965923f769 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9fc874adc8dbe7c3f1fd3c267c27708 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">SPIreadStream</a> (uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:ab9fc874adc8dbe7c3f1fd3c267c27708 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a read transaction with SPI stream. <a href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9fc874adc8dbe7c3f1fd3c267c27708 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a085415b49ff72238f118b937ad896cbd inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a085415b49ff72238f118b937ad896cbd">SPIreadStream</a> (uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:a085415b49ff72238f118b937ad896cbd inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a read transaction with SPI stream. <a href="class_module.html#a085415b49ff72238f118b937ad896cbd">More...</a><br /></td></tr>
|
|
<tr class="separator:a085415b49ff72238f118b937ad896cbd inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74ce586afa403130007a474d3295d762 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a74ce586afa403130007a474d3295d762">SPIwriteStream</a> (uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:a74ce586afa403130007a474d3295d762 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a write transaction with SPI stream. <a href="class_module.html#a74ce586afa403130007a474d3295d762">More...</a><br /></td></tr>
|
|
<tr class="separator:a74ce586afa403130007a474d3295d762 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7acbe601ebe6398781d0f2de5177305e inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7acbe601ebe6398781d0f2de5177305e">SPIwriteStream</a> (uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</td></tr>
|
|
<tr class="memdesc:a7acbe601ebe6398781d0f2de5177305e inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Method to perform a write transaction with SPI stream. <a href="class_module.html#a7acbe601ebe6398781d0f2de5177305e">More...</a><br /></td></tr>
|
|
<tr class="separator:a7acbe601ebe6398781d0f2de5177305e inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3586c8d4013cbdd22cf34032632c181 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">SPItransferStream</a> (uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)</td></tr>
|
|
<tr class="memdesc:ac3586c8d4013cbdd22cf34032632c181 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.). <a href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">More...</a><br /></td></tr>
|
|
<tr class="separator:ac3586c8d4013cbdd22cf34032632c181 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6cac04c7cb6d5278a318db0966ad1a7 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7">getCs</a> () const</td></tr>
|
|
<tr class="memdesc:aa6cac04c7cb6d5278a318db0966ad1a7 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of SPI chip select. <a href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7">More...</a><br /></td></tr>
|
|
<tr class="separator:aa6cac04c7cb6d5278a318db0966ad1a7 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab61bc5066c356e2d0d79f08a2bd0fbc9 inherit pub_methods_class_module"><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. <a href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">More...</a><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"><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. <a href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">More...</a><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"><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. <a href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">More...</a><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"><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. <a href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">More...</a><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"><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. <a href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">More...</a><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"><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. <a href="class_module.html#a5699a937b62ba41387567b4d679b9377">More...</a><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"><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. <a href="class_module.html#afbed643f082286012bf44bba22381ae6">More...</a><br /></td></tr>
|
|
<tr class="separator:afbed643f082286012bf44bba22381ae6 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47978200f7e2e408fb64f506c81cee9f inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">waitForMicroseconds</a> (uint32_t start, uint32_t len)</td></tr>
|
|
<tr class="memdesc:a47978200f7e2e408fb64f506c81cee9f 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! <a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">More...</a><br /></td></tr>
|
|
<tr class="separator:a47978200f7e2e408fb64f506c81cee9f inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_methods_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_module')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a4add1a875bb88e91da232118201a78a8 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4add1a875bb88e91da232118201a78a8">reflect</a> (uint32_t in, uint8_t bits)</td></tr>
|
|
<tr class="memdesc:a4add1a875bb88e91da232118201a78a8 inherit pub_static_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Function to reflect bits within a byte. <a href="class_module.html#a4add1a875bb88e91da232118201a78a8">More...</a><br /></td></tr>
|
|
<tr class="separator:a4add1a875bb88e91da232118201a78a8 inherit pub_static_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"><td class="memItemLeft" align="right" valign="top"><a id="a4483f0a39a523dd1b37b467d81418f7d"></a>
|
|
<a class="el" href="class_radio_lib_hal.html">RadioLibHal</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">hal</a> = 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:a849ad85fc1bc3a7130e660c13973ab26 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a849ad85fc1bc3a7130e660c13973ab26"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a> = 0b00000000</td></tr>
|
|
<tr class="memdesc:a849ad85fc1bc3a7130e660c13973ab26 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI read command. Defaults to 0x00. <br /></td></tr>
|
|
<tr class="separator:a849ad85fc1bc3a7130e660c13973ab26 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae89764d15e8df5694a6aec0e18f72d3f inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="ae89764d15e8df5694a6aec0e18f72d3f"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a> = 0b10000000</td></tr>
|
|
<tr class="memdesc:ae89764d15e8df5694a6aec0e18f72d3f inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI write command. Defaults to 0x80. <br /></td></tr>
|
|
<tr class="separator:ae89764d15e8df5694a6aec0e18f72d3f inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a466112286d19675ca2dbe481358e4365 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a466112286d19675ca2dbe481358e4365"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a466112286d19675ca2dbe481358e4365">SPInopCommand</a> = 0x00</td></tr>
|
|
<tr class="memdesc:a466112286d19675ca2dbe481358e4365 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI no-operation command. Defaults to 0x00. <br /></td></tr>
|
|
<tr class="separator:a466112286d19675ca2dbe481358e4365 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06d8d4257c584b57a529fcc405d87c79 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a06d8d4257c584b57a529fcc405d87c79"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a06d8d4257c584b57a529fcc405d87c79">SPIstatusCommand</a> = 0x00</td></tr>
|
|
<tr class="memdesc:a06d8d4257c584b57a529fcc405d87c79 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI status read command. Defaults to 0x00. <br /></td></tr>
|
|
<tr class="separator:a06d8d4257c584b57a529fcc405d87c79 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac19a495026aae62f5c2f089aa1b2b57a inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="ac19a495026aae62f5c2f089aa1b2b57a"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ac19a495026aae62f5c2f089aa1b2b57a">SPIaddrWidth</a> = 8</td></tr>
|
|
<tr class="memdesc:ac19a495026aae62f5c2f089aa1b2b57a inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses. <br /></td></tr>
|
|
<tr class="separator:ac19a495026aae62f5c2f089aa1b2b57a inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34927454be3a34df8a5a586c46c428af inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a34927454be3a34df8a5a586c46c428af"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a34927454be3a34df8a5a586c46c428af">SPIstreamType</a> = false</td></tr>
|
|
<tr class="memdesc:a34927454be3a34df8a5a586c46c428af inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Whether the SPI interface is stream-type (e.g. <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>) or register-type (e.g. <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>). Defaults to register-type SPI interfaces. <br /></td></tr>
|
|
<tr class="separator:a34927454be3a34df8a5a586c46c428af inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66b06e69d57b97116bed1c6f185381f1 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a66b06e69d57b97116bed1c6f185381f1"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a66b06e69d57b97116bed1c6f185381f1">SPIstreamError</a> = <a class="el" href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a></td></tr>
|
|
<tr class="memdesc:a66b06e69d57b97116bed1c6f185381f1 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">The last recorded SPI stream error. <br /></td></tr>
|
|
<tr class="separator:a66b06e69d57b97116bed1c6f185381f1 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6e89e2bc4976e8c5dc42dedda9fa6a2 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="af6e89e2bc4976e8c5dc42dedda9fa6a2"></a>
|
|
<a class="el" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2">SPIparseStatusCb</a> = nullptr</td></tr>
|
|
<tr class="memdesc:af6e89e2bc4976e8c5dc42dedda9fa6a2 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Callback to function that will parse the module-specific status codes to RadioLib status codes. Typically used for modules with SPI stream-type interface (e.g. SX126x/SX128x). <br /></td></tr>
|
|
<tr class="separator:af6e89e2bc4976e8c5dc42dedda9fa6a2 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"><td class="memItemLeft" align="right" valign="top">static const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 3</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. <a href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">More...</a><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/STM32WLx_Module.cpp</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|