452 lines
80 KiB
HTML
452 lines
80 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: src/modules/nRF24/nRF24.h Source File</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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</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('n_r_f24_8h_source.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="headertitle"><div class="title">nRF24.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#if !defined(_RADIOLIB_NRF24_H) && !RADIOLIB_EXCLUDE_NRF24</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_NRF24_H</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "../../Module.h"</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "../../TypeDef.h"</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "../../protocols/PhysicalLayer/PhysicalLayer.h"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// nRF24 physical layer properties</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#define RADIOLIB_NRF24_FREQUENCY_STEP_SIZE 1000000.0</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define RADIOLIB_NRF24_MAX_PACKET_LENGTH 32</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// nRF24 SPI commands</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_READ 0b00000000</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_WRITE 0b00100000</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_READ_RX_PAYLOAD 0b01100001</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_WRITE_TX_PAYLOAD 0b10100000</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_FLUSH_TX 0b11100001</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_FLUSH_RX 0b11100010</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_REUSE_TX_PAXLOAD 0b11100011</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_READ_RX_PAYLOAD_WIDTH 0b01100000</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_WRITE_ACK_PAYLOAD 0b10101000</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_WRITE_TX_PAYLOAD_NOACK 0b10110000</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#define RADIOLIB_NRF24_CMD_NOP 0b11111111</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">// nRF24 register map</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_CONFIG 0x00</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_EN_AA 0x01</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_EN_RXADDR 0x02</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_SETUP_AW 0x03</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_SETUP_RETR 0x04</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RF_CH 0x05</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RF_SETUP 0x06</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_STATUS 0x07</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_OBSERVE_TX 0x08</span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RPD 0x09</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_ADDR_P0 0x0A</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_ADDR_P1 0x0B</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_ADDR_P2 0x0C</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_ADDR_P3 0x0D</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_ADDR_P4 0x0E</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_ADDR_P5 0x0F</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_TX_ADDR 0x10</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_PW_P0 0x11</span></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_PW_P1 0x12</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_PW_P2 0x13</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_PW_P3 0x14</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_PW_P4 0x15</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_RX_PW_P5 0x16</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_FIFO_STATUS 0x17</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_DYNPD 0x1C</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#define RADIOLIB_NRF24_REG_FEATURE 0x1D</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">// RADIOLIB_NRF24_REG_CONFIG MSB LSB DESCRIPTION</span></div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#define RADIOLIB_NRF24_MASK_RX_DR_IRQ_OFF 0b01000000 </span><span class="comment">// 6 6 RX_DR will not be reflected on IRQ pin</span></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#define RADIOLIB_NRF24_MASK_RX_DR_IRQ_ON 0b00000000 </span><span class="comment">// 6 6 RX_DR will be reflected on IRQ pin as active low (default)</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#define RADIOLIB_NRF24_MASK_TX_DS_IRQ_OFF 0b00100000 </span><span class="comment">// 5 5 TX_DS will not be reflected on IRQ pin</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#define RADIOLIB_NRF24_MASK_TX_DS_IRQ_ON 0b00000000 </span><span class="comment">// 5 5 TX_DS will be reflected on IRQ pin as active low (default)</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#define RADIOLIB_NRF24_MASK_MAX_RT_IRQ_OFF 0b00010000 </span><span class="comment">// 4 4 MAX_RT will not be reflected on IRQ pin</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#define RADIOLIB_NRF24_MASK_MAX_RT_IRQ_ON 0b00000000 </span><span class="comment">// 4 4 MAX_RT will be reflected on IRQ pin as active low (default)</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#define RADIOLIB_NRF24_CRC_OFF 0b00000000 </span><span class="comment">// 3 3 CRC calculation: disabled</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#define RADIOLIB_NRF24_CRC_ON 0b00001000 </span><span class="comment">// 3 3 enabled (default)</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#define RADIOLIB_NRF24_CRC_8 0b00000000 </span><span class="comment">// 2 2 CRC scheme: CRC8 (default)</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#define RADIOLIB_NRF24_CRC_16 0b00000100 </span><span class="comment">// 2 2 CRC16</span></div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#define RADIOLIB_NRF24_POWER_UP 0b00000010 </span><span class="comment">// 1 1 power up</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#define RADIOLIB_NRF24_POWER_DOWN 0b00000000 </span><span class="comment">// 1 1 power down</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#define RADIOLIB_NRF24_PTX 0b00000000 </span><span class="comment">// 0 0 enable primary Tx</span></div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#define RADIOLIB_NRF24_PRX 0b00000001 </span><span class="comment">// 0 0 enable primary Rx</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">// RADIOLIB_NRF24_REG_EN_AA</span></div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_ALL_OFF 0b00000000 </span><span class="comment">// 5 0 auto-ACK on all pipes: disabled</span></div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_ALL_ON 0b00111111 </span><span class="comment">// 5 0 enabled (default)</span></div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P5_OFF 0b00000000 </span><span class="comment">// 5 5 auto-ACK on pipe 5: disabled</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P5_ON 0b00100000 </span><span class="comment">// 5 5 enabled (default)</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P4_OFF 0b00000000 </span><span class="comment">// 4 4 auto-ACK on pipe 4: disabled</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P4_ON 0b00010000 </span><span class="comment">// 4 4 enabled (default)</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P3_OFF 0b00000000 </span><span class="comment">// 3 3 auto-ACK on pipe 3: disabled</span></div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P3_ON 0b00001000 </span><span class="comment">// 3 3 enabled (default)</span></div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P2_OFF 0b00000000 </span><span class="comment">// 2 2 auto-ACK on pipe 2: disabled</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P2_ON 0b00000100 </span><span class="comment">// 2 2 enabled (default)</span></div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P1_OFF 0b00000000 </span><span class="comment">// 1 1 auto-ACK on pipe 1: disabled</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P1_ON 0b00000010 </span><span class="comment">// 1 1 enabled (default)</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P0_OFF 0b00000000 </span><span class="comment">// 0 0 auto-ACK on pipe 0: disabled</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="preprocessor">#define RADIOLIB_NRF24_AA_P0_ON 0b00000001 </span><span class="comment">// 0 0 enabled (default)</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment">// RADIOLIB_NRF24_REG_EN_RXADDR</span></div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor">#define RADIOLIB_NRF24_P5_OFF 0b00000000 </span><span class="comment">// 5 5 receive pipe 5: disabled (default)</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor">#define RADIOLIB_NRF24_P5_ON 0b00100000 </span><span class="comment">// 5 5 enabled</span></div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="preprocessor">#define RADIOLIB_NRF24_P4_OFF 0b00000000 </span><span class="comment">// 4 4 receive pipe 4: disabled (default)</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#define RADIOLIB_NRF24_P4_ON 0b00010000 </span><span class="comment">// 4 4 enabled</span></div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor">#define RADIOLIB_NRF24_P3_OFF 0b00000000 </span><span class="comment">// 3 3 receive pipe 3: disabled (default)</span></div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#define RADIOLIB_NRF24_P3_ON 0b00001000 </span><span class="comment">// 3 3 enabled</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#define RADIOLIB_NRF24_P2_OFF 0b00000000 </span><span class="comment">// 2 2 receive pipe 2: disabled (default)</span></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#define RADIOLIB_NRF24_P2_ON 0b00000100 </span><span class="comment">// 2 2 enabled</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="preprocessor">#define RADIOLIB_NRF24_P1_OFF 0b00000000 </span><span class="comment">// 1 1 receive pipe 1: disabled</span></div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="preprocessor">#define RADIOLIB_NRF24_P1_ON 0b00000010 </span><span class="comment">// 1 1 enabled (default)</span></div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#define RADIOLIB_NRF24_P0_OFF 0b00000000 </span><span class="comment">// 0 0 receive pipe 0: disabled</span></div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="preprocessor">#define RADIOLIB_NRF24_P0_ON 0b00000001 </span><span class="comment">// 0 0 enabled (default)</span></div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment">// RADIOLIB_NRF24_REG_SETUP_AW</span></div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="preprocessor">#define RADIOLIB_NRF24_ADDRESS_2_BYTES 0b00000000 </span><span class="comment">// 1 0 address width: 2 bytes</span></div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#define RADIOLIB_NRF24_ADDRESS_3_BYTES 0b00000001 </span><span class="comment">// 1 0 3 bytes</span></div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="preprocessor">#define RADIOLIB_NRF24_ADDRESS_4_BYTES 0b00000010 </span><span class="comment">// 1 0 4 bytes</span></div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="preprocessor">#define RADIOLIB_NRF24_ADDRESS_5_BYTES 0b00000011 </span><span class="comment">// 1 0 5 bytes (default)</span></div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment">// RADIOLIB_NRF24_REG_SETUP_RETR</span></div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="preprocessor">#define RADIOLIB_NRF24_ARD 0b00000000 </span><span class="comment">// 7 4 auto retransmit delay: t[us] = (NRF24_ARD + 1) * 250 us</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="preprocessor">#define RADIOLIB_NRF24_ARC_OFF 0b00000000 </span><span class="comment">// 3 0 auto retransmit count: auto retransmit disabled</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="preprocessor">#define RADIOLIB_NRF24_ARC 0b00000011 </span><span class="comment">// 3 0 up to 3 retransmits on AA fail (default)</span></div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment">// RADIOLIB_NRF24_REG_RF_CH</span></div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_CH 0b00000010 </span><span class="comment">// 6 0 RF channel: f_CH[MHz] = 2400 MHz + NRF24_RF_CH</span></div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment">// RADIOLIB_NRF24_REG_RF_SETUP</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="preprocessor">#define RADIOLIB_NRF24_CONT_WAVE_OFF 0b00000000 </span><span class="comment">// 7 7 continuous carrier transmit: disabled (default)</span></div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="preprocessor">#define RADIOLIB_NRF24_CONT_WAVE_ON 0b10000000 </span><span class="comment">// 7 7 enabled</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor">#define RADIOLIB_NRF24_DR_250_KBPS 0b00100000 </span><span class="comment">// 5 5 data rate: 250 kbps</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="preprocessor">#define RADIOLIB_NRF24_DR_1_MBPS 0b00000000 </span><span class="comment">// 3 3 1 Mbps (default)</span></div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="preprocessor">#define RADIOLIB_NRF24_DR_2_MBPS 0b00001000 </span><span class="comment">// 3 3 2 Mbps</span></div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="preprocessor">#define RADIOLIB_NRF24_PLL_LOCK_ON 0b00010000 </span><span class="comment">// 4 4 force PLL lock: enabled</span></div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="preprocessor">#define RADIOLIB_NRF24_PLL_LOCK_OFF 0b00000000 </span><span class="comment">// 4 4 disabled (default)</span></div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_PWR_18_DBM 0b00000000 </span><span class="comment">// 2 1 output power: -18 dBm</span></div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_PWR_12_DBM 0b00000010 </span><span class="comment">// 2 1 -12 dBm</span></div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_PWR_6_DBM 0b00000100 </span><span class="comment">// 2 1 -6 dBm</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_PWR_0_DBM 0b00000110 </span><span class="comment">// 2 1 0 dBm (default)</span></div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_LNA_OFF 0b00000000 </span><span class="comment">// 0 0 LNA gain: Off</span></div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#define RADIOLIB_NRF24_RF_LNA_ON 0b00000001 </span><span class="comment">// 0 0 On</span></div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment">// RADIOLIB_NRF24_REG_STATUS</span></div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="preprocessor">#define RADIOLIB_NRF24_RX_DR 0b01000000 </span><span class="comment">// 6 6 Rx data ready</span></div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="preprocessor">#define RADIOLIB_NRF24_TX_DS 0b00100000 </span><span class="comment">// 5 5 Tx data sent</span></div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="preprocessor">#define RADIOLIB_NRF24_MAX_RT 0b00010000 </span><span class="comment">// 4 4 maximum number of retransmits reached (must be cleared to continue)</span></div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="preprocessor">#define RADIOLIB_NRF24_RX_FIFO_EMPTY 0b00001110 </span><span class="comment">// 3 1 Rx FIFO is empty</span></div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="preprocessor">#define RADIOLIB_NRF24_RX_P_NO 0b00000000 </span><span class="comment">// 3 1 number of data pipe that received data</span></div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="preprocessor">#define RADIOLIB_NRF24_TX_FIFO_FULL 0b00000001 </span><span class="comment">// 0 0 Tx FIFO is full</span></div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment">// RADIOLIB_NRF24_REG_OBSERVE_TX</span></div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="preprocessor">#define RADIOLIB_NRF24_PLOS_CNT 0b00000000 </span><span class="comment">// 7 4 number of lost packets</span></div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="preprocessor">#define RADIOLIB_NRF24_ARC_CNT 0b00000000 </span><span class="comment">// 3 0 number of retransmitted packets</span></div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="comment">// RADIOLIB_NRF24_REG_RPD</span></div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="preprocessor">#define RADIOLIB_NRF24_RP_BELOW_64_DBM 0b00000000 </span><span class="comment">// 0 0 received power in the current channel: less than -64 dBm</span></div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="preprocessor">#define RADIOLIB_NRF24_RP_ABOVE_64_DBM 0b00000001 </span><span class="comment">// 0 0 more than -64 dBm</span></div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="comment">// RADIOLIB_NRF24_REG_FIFO_STATUS</span></div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="preprocessor">#define RADIOLIB_NRF24_TX_REUSE 0b01000000 </span><span class="comment">// 6 6 reusing last transmitted payload</span></div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="preprocessor">#define RADIOLIB_NRF24_TX_FIFO_FULL_FLAG 0b00100000 </span><span class="comment">// 5 5 Tx FIFO is full</span></div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="preprocessor">#define RADIOLIB_NRF24_TX_FIFO_EMPTY_FLAG 0b00010000 </span><span class="comment">// 4 4 Tx FIFO is empty</span></div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="preprocessor">#define RADIOLIB_NRF24_RX_FIFO_FULL_FLAG 0b00000010 </span><span class="comment">// 1 1 Rx FIFO is full</span></div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="preprocessor">#define RADIOLIB_NRF24_RX_FIFO_EMPTY_FLAG 0b00000001 </span><span class="comment">// 0 0 Rx FIFO is empty</span></div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span><span class="comment">// RADIOLIB_NRF24_REG_DYNPD</span></div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P5_OFF 0b00000000 </span><span class="comment">// 5 5 dynamic payload length on pipe 5: disabled (default)</span></div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P5_ON 0b00100000 </span><span class="comment">// 5 5 enabled</span></div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P4_OFF 0b00000000 </span><span class="comment">// 4 4 dynamic payload length on pipe 4: disabled (default)</span></div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P4_ON 0b00010000 </span><span class="comment">// 4 4 enabled</span></div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P3_OFF 0b00000000 </span><span class="comment">// 3 3 dynamic payload length on pipe 3: disabled (default)</span></div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P3_ON 0b00001000 </span><span class="comment">// 3 3 enabled</span></div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P2_OFF 0b00000000 </span><span class="comment">// 2 2 dynamic payload length on pipe 2: disabled (default)</span></div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P2_ON 0b00000100 </span><span class="comment">// 2 2 enabled</span></div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P1_OFF 0b00000000 </span><span class="comment">// 1 1 dynamic payload length on pipe 1: disabled (default)</span></div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P1_ON 0b00000010 </span><span class="comment">// 1 1 enabled</span></div>
|
|
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P0_OFF 0b00000000 </span><span class="comment">// 0 0 dynamic payload length on pipe 0: disabled (default)</span></div>
|
|
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_P0_ON 0b00000001 </span><span class="comment">// 0 0 enabled</span></div>
|
|
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_ALL_OFF 0b00000000 </span><span class="comment">// 5 0 disable all dynamic payloads</span></div>
|
|
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_ALL_ON 0b00111111 </span><span class="comment">// 5 0 enable all dynamic payloads</span></div>
|
|
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> </div>
|
|
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span><span class="comment">// RADIOLIB_NRF24_REG_FEATURE</span></div>
|
|
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_OFF 0b00000000 </span><span class="comment">// 2 2 dynamic payload length: disabled (default)</span></div>
|
|
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span><span class="preprocessor">#define RADIOLIB_NRF24_DPL_ON 0b00000100 </span><span class="comment">// 2 2 enabled</span></div>
|
|
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span><span class="preprocessor">#define RADIOLIB_NRF24_ACK_PAY_OFF 0b00000000 </span><span class="comment">// 1 1 payload with ACK packets: disabled (default)</span></div>
|
|
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span><span class="preprocessor">#define RADIOLIB_NRF24_ACK_PAY_ON 0b00000010 </span><span class="comment">// 1 1 enabled</span></div>
|
|
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span><span class="preprocessor">#define RADIOLIB_NRF24_DYN_ACK_OFF 0b00000000 </span><span class="comment">// 0 0 payloads without ACK: disabled (default)</span></div>
|
|
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span><span class="preprocessor">#define RADIOLIB_NRF24_DYN_ACK_ON 0b00000001 </span><span class="comment">// 0 0 enabled</span></div>
|
|
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> </div>
|
|
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span><span class="comment">// RadioLib defaults</span></div>
|
|
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span><span class="preprocessor">#define RADIOLIB_NRF24_DEFAULT_FREQ 2400</span></div>
|
|
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span><span class="preprocessor">#define RADIOLIB_NRF24_DEFAULT_DR 1000</span></div>
|
|
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span><span class="preprocessor">#define RADIOLIB_NRF24_DEFAULT_POWER -12</span></div>
|
|
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span><span class="preprocessor">#define RADIOLIB_NRF24_DEFAULT_ADDRWIDTH 5</span></div>
|
|
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div>
|
|
<div class="foldopen" id="foldopen00186" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="classn_r_f24.html"> 186</a></span><span class="keyword">class </span><a class="code hl_class" href="classn_r_f24.html">nRF24</a>: <span class="keyword">public</span> <a class="code hl_class" href="class_physical_layer.html">PhysicalLayer</a> {</div>
|
|
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="comment">// introduce PhysicalLayer overloads</span></div>
|
|
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> <span class="keyword">using </span><a class="code hl_function" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::transmit</a>;</div>
|
|
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> <span class="keyword">using </span><a class="code hl_function" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::receive</a>;</div>
|
|
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <span class="keyword">using </span><a class="code hl_function" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a>;</div>
|
|
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">using </span><a class="code hl_function" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a>;</div>
|
|
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> </div>
|
|
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> <a class="code hl_class" href="classn_r_f24.html">nRF24</a>(<a class="code hl_class" href="class_module.html">Module</a>* mod); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
|
|
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
|
|
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> </div>
|
|
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a0ef68849f812367432f5a3798f94b8ce">begin</a>(</div>
|
|
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> int16_t freq = RADIOLIB_NRF24_DEFAULT_FREQ,</div>
|
|
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> int16_t dr = RADIOLIB_NRF24_DEFAULT_DR,</div>
|
|
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> int8_t pwr = RADIOLIB_NRF24_DEFAULT_POWER,</div>
|
|
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> uint8_t addrWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH);</div>
|
|
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> </div>
|
|
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721">sleep</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> </div>
|
|
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56">standby</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> </div>
|
|
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56">standby</a>(uint8_t mode) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> </div>
|
|
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> int16_t <a class="code hl_function" href="classn_r_f24.html#af7c4cf05b992d8a97331b9888e95fc2f">transmit</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> </div>
|
|
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a239e94511d9ee67ad3d64a49a5c4d7ac">receive</a>(uint8_t* data, <span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> </div>
|
|
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a090bb64f65309efabfa1ffd86daa2303">transmitDirect</a>(uint32_t frf = 0) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span> </div>
|
|
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a415d86947742e981bfcf7f2371f8605c">receiveDirect</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> </div>
|
|
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> <span class="comment">// interrupt methods</span></div>
|
|
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> </div>
|
|
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classn_r_f24.html#abf9323748b1a850e6ddc6f6d48f4cfb3">setIrqAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>));</div>
|
|
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> </div>
|
|
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classn_r_f24.html#aaf5887fe58c4d542cbed80482de1d42d">clearIrqAction</a>();</div>
|
|
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> </div>
|
|
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classn_r_f24.html#a60df9afa489eabe3a3ca193ab7709165">setPacketReceivedAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>)) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span> </div>
|
|
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classn_r_f24.html#a52c097dc0078fc4e8707c095378aff3d">clearPacketReceivedAction</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span> </div>
|
|
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classn_r_f24.html#a26b5f873db167733df143a0608eea3ac">setPacketSentAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>)) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> </div>
|
|
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno"> 300</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classn_r_f24.html#a41499cf2c1a6c83a04ff89dd59e3fa56">clearPacketSentAction</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span> </div>
|
|
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a8b2365ad11840d1d05b0e17b37ddacd2">startTransmit</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> </div>
|
|
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span> int16_t <a class="code hl_function" href="classn_r_f24.html#af0c21ff66c011dfdc1ad12bc7dd11c2f">finishTransmit</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span> </div>
|
|
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a3c6aa3622c887118fb8d8cb2689fdff2">startReceive</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span> </div>
|
|
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a3c6aa3622c887118fb8d8cb2689fdff2">startReceive</a>(uint32_t timeout, uint32_t irqFlags, uint32_t irqMask, <span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span> </div>
|
|
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno"> 341</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a410fb78acb4ed358818c132687b8857a">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span> </div>
|
|
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno"> 343</span> <span class="comment">// configuration methods</span></div>
|
|
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno"> 344</span> </div>
|
|
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno"> 350</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a18f24764b2ecffc076e72dce0b036116">setFrequency</a>(<span class="keywordtype">float</span> freq) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> </div>
|
|
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno"> 357</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a760d3f47f58ddacdf41975447484a47c">setBitRate</a>(<span class="keywordtype">float</span> br) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno"> 358</span> </div>
|
|
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno"> 364</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a4fa66ce5fb6d7b22bbb439c2f9103bf3">setOutputPower</a>(int8_t pwr) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno"> 365</span> </div>
|
|
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a5b01677f5ce6bee54da8fc7098c339f4">setAddressWidth</a>(uint8_t addrWidth);</div>
|
|
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno"> 372</span> </div>
|
|
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a9f122e94ed8095d1c42292d8fb6c3e80">setTransmitPipe</a>(<span class="keyword">const</span> uint8_t* addr);</div>
|
|
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> </div>
|
|
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> int16_t <a class="code hl_function" href="classn_r_f24.html#ac3595667329715aef0e9f8d85f4116c4">setReceivePipe</a>(uint8_t pipeNum, <span class="keyword">const</span> uint8_t* addr);</div>
|
|
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span> </div>
|
|
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno"> 398</span> int16_t <a class="code hl_function" href="classn_r_f24.html#ac3595667329715aef0e9f8d85f4116c4">setReceivePipe</a>(uint8_t pipeNum, uint8_t addrByte);</div>
|
|
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno"> 399</span> </div>
|
|
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno"> 405</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a4dd39e5c0efee1f0c2a14f729eb4426a">disablePipe</a>(uint8_t pipeNum);</div>
|
|
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"> 406</span> </div>
|
|
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno"> 412</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a3f0b08fd8e58db36f6c1926cc3eac6a9">getStatus</a>(uint8_t mask = 0xFF);</div>
|
|
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno"> 413</span> </div>
|
|
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno"> 418</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classn_r_f24.html#ad9204ee787b425e2c9e8422bb7939a37">isCarrierDetected</a>();</div>
|
|
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno"> 419</span> </div>
|
|
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno"> 425</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a5170284f0a5535de7d00216d450b87a4">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno"> 426</span> </div>
|
|
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno"> 432</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classn_r_f24.html#a23ea1749c21863ebc5bd3a2b08d64f3b">getPacketLength</a>(<span class="keywordtype">bool</span> update = <span class="keyword">true</span>) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno"> 433</span> </div>
|
|
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno"> 439</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a3eb45884a5730ac1c339c7ba4f7b5282">setCrcFiltering</a>(<span class="keywordtype">bool</span> crcOn = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno"> 440</span> </div>
|
|
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span> int16_t <a class="code hl_function" href="classn_r_f24.html#aca941c9235ba1212257288554eb4b7fe">setAutoAck</a>(<span class="keywordtype">bool</span> autoAckOn = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> </div>
|
|
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno"> 454</span> int16_t <a class="code hl_function" href="classn_r_f24.html#aca941c9235ba1212257288554eb4b7fe">setAutoAck</a>(uint8_t pipeNum, <span class="keywordtype">bool</span> autoAckOn);</div>
|
|
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno"> 455</span> </div>
|
|
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno"> 461</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a0db248d2bcdb4ca2b401e8e638442916">setDataShaping</a>(uint8_t sh) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno"> 462</span> </div>
|
|
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno"> 468</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a0429a9d6524005065e6fac21aaebdcbf">setEncoding</a>(uint8_t encoding) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno"> 469</span> </div>
|
|
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno"> 476</span> int16_t <a class="code hl_function" href="classn_r_f24.html#a5e97c13373c6c8d5a86404646884dea3">setLNA</a>(<span class="keywordtype">bool</span> enable);</div>
|
|
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno"> 477</span> </div>
|
|
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno"> 478</span><span class="preprocessor">#if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL</span></div>
|
|
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno"> 479</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno"> 480</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno"> 481</span> <a class="code hl_class" href="class_module.html">Module</a>* getMod() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno"> 482</span> </div>
|
|
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno"> 483</span> <span class="keywordtype">void</span> SPIreadRxPayload(uint8_t* data, uint8_t numBytes);</div>
|
|
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno"> 484</span> <span class="keywordtype">void</span> SPIwriteTxPayload(<span class="keyword">const</span> uint8_t* data, uint8_t numBytes);</div>
|
|
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno"> 485</span> <span class="keywordtype">void</span> SPItransfer(uint8_t cmd, <span class="keywordtype">bool</span> write = <span class="keyword">false</span>, <span class="keyword">const</span> uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);</div>
|
|
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno"> 486</span> </div>
|
|
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno"> 487</span><span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno"> 488</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno"> 489</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno"> 490</span> <a class="code hl_class" href="class_module.html">Module</a>* mod;</div>
|
|
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno"> 491</span> </div>
|
|
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno"> 492</span> int16_t frequency = RADIOLIB_NRF24_DEFAULT_FREQ;</div>
|
|
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno"> 493</span> int16_t dataRate = RADIOLIB_NRF24_DEFAULT_DR;</div>
|
|
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno"> 494</span> int8_t power = RADIOLIB_NRF24_DEFAULT_POWER;</div>
|
|
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno"> 495</span> uint8_t addressWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH;</div>
|
|
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno"> 496</span> </div>
|
|
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno"> 497</span> int16_t config();</div>
|
|
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno"> 498</span> <span class="keywordtype">void</span> clearIRQ();</div>
|
|
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno"> 499</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno"> 500</span> </div>
|
|
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno"> 501</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition</b> Module.h:73</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition</b> PhysicalLayer.h:216</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition</b> PhysicalLayer.cpp:220</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint8_t addr=0)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition</b> PhysicalLayer.cpp:53</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *str, uint8_t addr=0)</div><div class="ttdoc">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...</div><div class="ttdef"><b>Definition</b> PhysicalLayer.cpp:155</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::receive</a></div><div class="ttdeci">virtual int16_t receive(uint8_t *data, size_t len)</div><div class="ttdoc">Binary receive method. Must be implemented in module class.</div><div class="ttdef"><b>Definition</b> PhysicalLayer.cpp:111</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html"><div class="ttname"><a href="classn_r_f24.html">nRF24</a></div><div class="ttdoc">Control class for nRF24 module.</div><div class="ttdef"><b>Definition</b> nRF24.h:186</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a0429a9d6524005065e6fac21aaebdcbf"><div class="ttname"><a href="classn_r_f24.html#a0429a9d6524005065e6fac21aaebdcbf">nRF24::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Dummy encoding configuration method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:559</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a090bb64f65309efabfa1ffd86daa2303"><div class="ttname"><a href="classn_r_f24.html#a090bb64f65309efabfa1ffd86daa2303">nRF24::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Starts direct mode transmission.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:135</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a0db248d2bcdb4ca2b401e8e638442916"><div class="ttname"><a href="classn_r_f24.html#a0db248d2bcdb4ca2b401e8e638442916">nRF24::setDataShaping</a></div><div class="ttdeci">int16_t setDataShaping(uint8_t sh) override</div><div class="ttdoc">Dummy data shaping configuration method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:552</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a0ef68849f812367432f5a3798f94b8ce"><div class="ttname"><a href="classn_r_f24.html#a0ef68849f812367432f5a3798f94b8ce">nRF24::begin</a></div><div class="ttdeci">int16_t begin(int16_t freq=RADIOLIB_NRF24_DEFAULT_FREQ, int16_t dr=RADIOLIB_NRF24_DEFAULT_DR, int8_t pwr=RADIOLIB_NRF24_DEFAULT_POWER, uint8_t addrWidth=RADIOLIB_NRF24_DEFAULT_ADDRWIDTH)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:11</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a18f24764b2ecffc076e72dce0b036116"><div class="ttname"><a href="classn_r_f24.html#a18f24764b2ecffc076e72dce0b036116">nRF24::setFrequency</a></div><div class="ttdeci">int16_t setFrequency(float freq) override</div><div class="ttdoc">Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:283</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a239e94511d9ee67ad3d64a49a5c4d7ac"><div class="ttname"><a href="classn_r_f24.html#a239e94511d9ee67ad3d64a49a5c4d7ac">nRF24::receive</a></div><div class="ttdeci">int16_t receive(uint8_t *data, size_t len) override</div><div class="ttdoc">Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...</div><div class="ttdef"><b>Definition</b> nRF24.cpp:113</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a23ea1749c21863ebc5bd3a2b08d64f3b"><div class="ttname"><a href="classn_r_f24.html#a23ea1749c21863ebc5bd3a2b08d64f3b">nRF24::getPacketLength</a></div><div class="ttdeci">size_t getPacketLength(bool update=true) override</div><div class="ttdoc">Query modem for the packet length of received payload.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:505</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a26b5f873db167733df143a0608eea3ac"><div class="ttname"><a href="classn_r_f24.html#a26b5f873db167733df143a0608eea3ac">nRF24::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:172</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a3c6aa3622c887118fb8d8cb2689fdff2"><div class="ttname"><a href="classn_r_f24.html#a3c6aa3622c887118fb8d8cb2689fdff2">nRF24::startReceive</a></div><div class="ttdeci">int16_t startReceive() override</div><div class="ttdoc">Interrupt-driven receive method. IRQ will be activated when full packet is received.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:228</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a3eb45884a5730ac1c339c7ba4f7b5282"><div class="ttname"><a href="classn_r_f24.html#a3eb45884a5730ac1c339c7ba4f7b5282">nRF24::setCrcFiltering</a></div><div class="ttdeci">int16_t setCrcFiltering(bool crcOn=true)</div><div class="ttdoc">Enable CRC filtering and generation.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:512</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a3f0b08fd8e58db36f6c1926cc3eac6a9"><div class="ttname"><a href="classn_r_f24.html#a3f0b08fd8e58db36f6c1926cc3eac6a9">nRF24::getStatus</a></div><div class="ttdeci">int16_t getStatus(uint8_t mask=0xFF)</div><div class="ttdoc">Gets nRF24 status register.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:490</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a410fb78acb4ed358818c132687b8857a"><div class="ttname"><a href="classn_r_f24.html#a410fb78acb4ed358818c132687b8857a">nRF24::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t len) override</div><div class="ttdoc">Reads data received after calling startReceive method. When the packet length is not known in advance...</div><div class="ttdef"><b>Definition</b> nRF24.cpp:262</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a41499cf2c1a6c83a04ff89dd59e3fa56"><div class="ttname"><a href="classn_r_f24.html#a41499cf2c1a6c83a04ff89dd59e3fa56">nRF24::clearPacketSentAction</a></div><div class="ttdeci">void clearPacketSentAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:176</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a415d86947742e981bfcf7f2371f8605c"><div class="ttname"><a href="classn_r_f24.html#a415d86947742e981bfcf7f2371f8605c">nRF24::receiveDirect</a></div><div class="ttdeci">int16_t receiveDirect() override</div><div class="ttdoc">Dummy direct mode reception method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:150</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a4dd39e5c0efee1f0c2a14f729eb4426a"><div class="ttname"><a href="classn_r_f24.html#a4dd39e5c0efee1f0c2a14f729eb4426a">nRF24::disablePipe</a></div><div class="ttdeci">int16_t disablePipe(uint8_t pipeNum)</div><div class="ttdoc">Disables specified receive pipe.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:459</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a4fa66ce5fb6d7b22bbb439c2f9103bf3"><div class="ttname"><a href="classn_r_f24.html#a4fa66ce5fb6d7b22bbb439c2f9103bf3">nRF24::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t pwr) override</div><div class="ttdoc">Sets output power. Allowed values are -18, -12, -6 or 0 dBm.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:325</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a5170284f0a5535de7d00216d450b87a4"><div class="ttname"><a href="classn_r_f24.html#a5170284f0a5535de7d00216d450b87a4">nRF24::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Dummy configuration method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:498</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a52c097dc0078fc4e8707c095378aff3d"><div class="ttname"><a href="classn_r_f24.html#a52c097dc0078fc4e8707c095378aff3d">nRF24::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:168</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a5957f06a891d3d9c07e87b59c239ce56"><div class="ttname"><a href="classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56">nRF24::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby mode.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:73</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a5b01677f5ce6bee54da8fc7098c339f4"><div class="ttname"><a href="classn_r_f24.html#a5b01677f5ce6bee54da8fc7098c339f4">nRF24::setAddressWidth</a></div><div class="ttdeci">int16_t setAddressWidth(uint8_t addrWidth)</div><div class="ttdoc">Sets address width of transmit and receive pipes in bytes. Allowed values are 3, 4 or 5 bytes.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:359</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a5e97c13373c6c8d5a86404646884dea3"><div class="ttname"><a href="classn_r_f24.html#a5e97c13373c6c8d5a86404646884dea3">nRF24::setLNA</a></div><div class="ttdeci">int16_t setLNA(bool enable)</div><div class="ttdoc">Enable or disable the low-noise amplifier. Improves receive performance at the cost of increased powe...</div><div class="ttdef"><b>Definition</b> nRF24.cpp:566</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a60df9afa489eabe3a3ca193ab7709165"><div class="ttname"><a href="classn_r_f24.html#a60df9afa489eabe3a3ca193ab7709165">nRF24::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:164</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a69b75e0889c609099487a43c8c3b6721"><div class="ttname"><a href="classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721">nRF24::sleep</a></div><div class="ttdeci">int16_t sleep() override</div><div class="ttdoc">Sets the module to sleep mode.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:69</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a760d3f47f58ddacdf41975447484a47c"><div class="ttname"><a href="classn_r_f24.html#a760d3f47f58ddacdf41975447484a47c">nRF24::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br) override</div><div class="ttdoc">Sets bit rate. Allowed values are 2000, 1000 or 250 kbps.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:297</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a8b2365ad11840d1d05b0e17b37ddacd2"><div class="ttname"><a href="classn_r_f24.html#a8b2365ad11840d1d05b0e17b37ddacd2">nRF24::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const uint8_t *data, size_t len, uint8_t addr) override</div><div class="ttdoc">Interrupt-driven binary transmit method. IRQ will be activated when full packet is transmitted....</div><div class="ttdef"><b>Definition</b> nRF24.cpp:180</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_a9f122e94ed8095d1c42292d8fb6c3e80"><div class="ttname"><a href="classn_r_f24.html#a9f122e94ed8095d1c42292d8fb6c3e80">nRF24::setTransmitPipe</a></div><div class="ttdeci">int16_t setTransmitPipe(const uint8_t *addr)</div><div class="ttdoc">Sets address of transmit pipe. The address width must be the same as the same as the configured in se...</div><div class="ttdef"><b>Definition</b> nRF24.cpp:392</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_aaf5887fe58c4d542cbed80482de1d42d"><div class="ttname"><a href="classn_r_f24.html#aaf5887fe58c4d542cbed80482de1d42d">nRF24::clearIrqAction</a></div><div class="ttdeci">void clearIrqAction()</div><div class="ttdoc">Clears interrupt service routine .</div><div class="ttdef"><b>Definition</b> nRF24.cpp:160</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_abf9323748b1a850e6ddc6f6d48f4cfb3"><div class="ttname"><a href="classn_r_f24.html#abf9323748b1a850e6ddc6f6d48f4cfb3">nRF24::setIrqAction</a></div><div class="ttdeci">void setIrqAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when IRQ activates.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:156</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_ac3595667329715aef0e9f8d85f4116c4"><div class="ttname"><a href="classn_r_f24.html#ac3595667329715aef0e9f8d85f4116c4">nRF24::setReceivePipe</a></div><div class="ttdeci">int16_t setReceivePipe(uint8_t pipeNum, const uint8_t *addr)</div><div class="ttdoc">Sets address of receive pipes 0 or 1. The address width must be the same as the same as the configure...</div><div class="ttdef"><b>Definition</b> nRF24.cpp:407</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_aca941c9235ba1212257288554eb4b7fe"><div class="ttname"><a href="classn_r_f24.html#aca941c9235ba1212257288554eb4b7fe">nRF24::setAutoAck</a></div><div class="ttdeci">int16_t setAutoAck(bool autoAckOn=true)</div><div class="ttdoc">Enable or disable auto-acknowledge packets on all pipes.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:523</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_ad9204ee787b425e2c9e8422bb7939a37"><div class="ttname"><a href="classn_r_f24.html#ad9204ee787b425e2c9e8422bb7939a37">nRF24::isCarrierDetected</a></div><div class="ttdeci">bool isCarrierDetected()</div><div class="ttdoc">Checks if carrier was detected during last RX.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:494</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_af0c21ff66c011dfdc1ad12bc7dd11c2f"><div class="ttname"><a href="classn_r_f24.html#af0c21ff66c011dfdc1ad12bc7dd11c2f">nRF24::finishTransmit</a></div><div class="ttdeci">int16_t finishTransmit() override</div><div class="ttdoc">Clean up after transmission is done.</div><div class="ttdef"><b>Definition</b> nRF24.cpp:220</div></div>
|
|
<div class="ttc" id="aclassn_r_f24_html_af7c4cf05b992d8a97331b9888e95fc2f"><div class="ttname"><a href="classn_r_f24.html#af7c4cf05b992d8a97331b9888e95fc2f">nRF24::transmit</a></div><div class="ttdeci">int16_t transmit(const uint8_t *data, size_t len, uint8_t addr) override</div><div class="ttdoc">Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...</div><div class="ttdef"><b>Definition</b> nRF24.cpp:87</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_8d5439df06ea2679013aa8390703d116.html">nRF24</a></li><li class="navelem"><b>nRF24.h</b></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>
|