<!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.8.17"/>
<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 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.8.17 -->
<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');
/* @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('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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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 name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_NRF24_H) && !defined(RADIOLIB_EXCLUDE_NRF24)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_NRF24_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../Module.h"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../../protocols/PhysicalLayer/PhysicalLayer.h"</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// nRF24 physical layer properties</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define NRF24_FREQUENCY_STEP_SIZE 1000000.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define NRF24_MAX_PACKET_LENGTH 32</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// nRF24 SPI commands</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define NRF24_CMD_READ 0b00000000</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define NRF24_CMD_WRITE 0b00100000</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define NRF24_CMD_READ_RX_PAYLOAD 0b01100001</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define NRF24_CMD_WRITE_TX_PAYLOAD 0b10100000</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define NRF24_CMD_FLUSH_TX 0b11100001</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define NRF24_CMD_FLUSH_RX 0b11100010</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define NRF24_CMD_REUSE_TX_PAXLOAD 0b11100011</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define NRF24_CMD_READ_RX_PAYLOAD_WIDTH 0b01100000</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define NRF24_CMD_WRITE_ACK_PAYLOAD 0b10101000</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define NRF24_CMD_WRITE_TX_PAYLOAD_NOACK 0b10110000</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define NRF24_CMD_NOP 0b11111111</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// nRF24 register map</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define NRF24_REG_CONFIG 0x00</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define NRF24_REG_EN_AA 0x01</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define NRF24_REG_EN_RXADDR 0x02</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define NRF24_REG_SETUP_AW 0x03</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define NRF24_REG_SETUP_RETR 0x04</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define NRF24_REG_RF_CH 0x05</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define NRF24_REG_RF_SETUP 0x06</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define NRF24_REG_STATUS 0x07</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define NRF24_REG_OBSERVE_TX 0x08</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define NRF24_REG_RPD 0x09</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define NRF24_REG_RX_ADDR_P0 0x0A</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define NRF24_REG_RX_ADDR_P1 0x0B</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define NRF24_REG_RX_ADDR_P2 0x0C</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define NRF24_REG_RX_ADDR_P3 0x0D</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define NRF24_REG_RX_ADDR_P4 0x0E</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define NRF24_REG_RX_ADDR_P5 0x0F</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#define NRF24_REG_TX_ADDR 0x10</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define NRF24_REG_RX_PW_P0 0x11</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define NRF24_REG_RX_PW_P1 0x12</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define NRF24_REG_RX_PW_P2 0x13</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#define NRF24_REG_RX_PW_P3 0x14</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define NRF24_REG_RX_PW_P4 0x15</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#define NRF24_REG_RX_PW_P5 0x16</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define NRF24_REG_FIFO_STATUS 0x17</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define NRF24_REG_DYNPD 0x1C</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define NRF24_REG_FEATURE 0x1D</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// NRF24_REG_CONFIG MSB LSB DESCRIPTION</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define NRF24_MASK_RX_DR_IRQ_OFF 0b01000000 // 6 6 RX_DR will not be reflected on IRQ pin</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define NRF24_MASK_RX_DR_IRQ_ON 0b00000000 // 6 6 RX_DR will be reflected on IRQ pin as active low (default)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define NRF24_MASK_TX_DS_IRQ_OFF 0b00100000 // 5 5 TX_DS will not be reflected on IRQ pin</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define NRF24_MASK_TX_DS_IRQ_ON 0b00000000 // 5 5 TX_DS will be reflected on IRQ pin as active low (default)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define NRF24_MASK_MAX_RT_IRQ_OFF 0b00010000 // 4 4 MAX_RT will not be reflected on IRQ pin</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#define NRF24_MASK_MAX_RT_IRQ_ON 0b00000000 // 4 4 MAX_RT will be reflected on IRQ pin as active low (default)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#define NRF24_CRC_OFF 0b00000000 // 3 3 CRC calculation: disabled</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define NRF24_CRC_ON 0b00001000 // 3 3 enabled (default)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#define NRF24_CRC_8 0b00000000 // 2 2 CRC scheme: CRC8 (default)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#define NRF24_CRC_16 0b00000100 // 2 2 CRC16</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define NRF24_POWER_UP 0b00000010 // 1 1 power up</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#define NRF24_POWER_DOWN 0b00000000 // 1 1 power down</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#define NRF24_PTX 0b00000000 // 0 0 enable primary Tx</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define NRF24_PRX 0b00000001 // 0 0 enable primary Rx</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// NRF24_REG_EN_AA</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#define NRF24_AA_ALL_OFF 0b00000000 // 5 0 auto-ACK on all pipes: disabled</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#define NRF24_AA_ALL_ON 0b00111111 // 5 0 enabled (default)</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#define NRF24_AA_P5_OFF 0b00000000 // 5 5 auto-ACK on pipe 5: disabled</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#define NRF24_AA_P5_ON 0b00100000 // 5 5 enabled (default)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#define NRF24_AA_P4_OFF 0b00000000 // 4 4 auto-ACK on pipe 4: disabled</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#define NRF24_AA_P4_ON 0b00010000 // 4 4 enabled (default)</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#define NRF24_AA_P3_OFF 0b00000000 // 3 3 auto-ACK on pipe 3: disabled</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#define NRF24_AA_P3_ON 0b00001000 // 3 3 enabled (default)</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#define NRF24_AA_P2_OFF 0b00000000 // 2 2 auto-ACK on pipe 2: disabled</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#define NRF24_AA_P2_ON 0b00000100 // 2 2 enabled (default)</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#define NRF24_AA_P1_OFF 0b00000000 // 1 1 auto-ACK on pipe 1: disabled</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#define NRF24_AA_P1_ON 0b00000010 // 1 1 enabled (default)</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#define NRF24_AA_P0_OFF 0b00000000 // 0 0 auto-ACK on pipe 0: disabled</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#define NRF24_AA_P0_ON 0b00000001 // 0 0 enabled (default)</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// NRF24_REG_EN_RXADDR</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#define NRF24_P5_OFF 0b00000000 // 5 5 receive pipe 5: disabled (default)</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#define NRF24_P5_ON 0b00100000 // 5 5 enabled</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#define NRF24_P4_OFF 0b00000000 // 4 4 receive pipe 4: disabled (default)</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#define NRF24_P4_ON 0b00010000 // 4 4 enabled</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#define NRF24_P3_OFF 0b00000000 // 3 3 receive pipe 3: disabled (default)</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#define NRF24_P3_ON 0b00001000 // 3 3 enabled</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#define NRF24_P2_OFF 0b00000000 // 2 2 receive pipe 2: disabled (default)</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#define NRF24_P2_ON 0b00000100 // 2 2 enabled</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define NRF24_P1_OFF 0b00000000 // 1 1 receive pipe 1: disabled</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#define NRF24_P1_ON 0b00000010 // 1 1 enabled (default)</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#define NRF24_P0_OFF 0b00000000 // 0 0 receive pipe 0: disabled</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#define NRF24_P0_ON 0b00000001 // 0 0 enabled (default)</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// NRF24_REG_SETUP_AW</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#define NRF24_ADDRESS_2_BYTES 0b00000000 // 1 0 address width: 2 bytes</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#define NRF24_ADDRESS_3_BYTES 0b00000001 // 1 0 3 bytes</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#define NRF24_ADDRESS_4_BYTES 0b00000010 // 1 0 4 bytes</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#define NRF24_ADDRESS_5_BYTES 0b00000011 // 1 0 5 bytes (default)</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// NRF24_REG_SETUP_RETR</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#define NRF24_ARD 0b00000000 // 7 4 auto retransmit delay: t[us] = (NRF24_ARD + 1) * 250 us</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#define NRF24_ARC_OFF 0b00000000 // 3 0 auto retransmit count: auto retransmit disabled</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#define NRF24_ARC 0b00000011 // 3 0 up to 3 retransmits on AA fail (default)</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// NRF24_REG_RF_CH</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#define NRF24_RF_CH 0b00000010 // 6 0 RF channel: f_CH[MHz] = 2400 MHz + NRF24_RF_CH</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">// NRF24_REG_RF_SETUP</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#define NRF24_CONT_WAVE_OFF 0b00000000 // 7 7 continuous carrier transmit: disabled (default)</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#define NRF24_CONT_WAVE_ON 0b10000000 // 7 7 enabled</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#define NRF24_DR_250_KBPS 0b00100000 // 5 5 data rate: 250 kbps</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#define NRF24_DR_1_MBPS 0b00000000 // 3 3 1 Mbps (default)</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#define NRF24_DR_2_MBPS 0b00001000 // 3 3 2 Mbps</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#define NRF24_PLL_LOCK_ON 0b00010000 // 4 4 force PLL lock: enabled</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#define NRF24_PLL_LOCK_OFF 0b00000000 // 4 4 disabled (default)</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#define NRF24_RF_PWR_18_DBM 0b00000000 // 2 1 output power: -18 dBm</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#define NRF24_RF_PWR_12_DBM 0b00000010 // 2 1 -12 dBm</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#define NRF24_RF_PWR_6_DBM 0b00000100 // 2 1 -6 dBm</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#define NRF24_RF_PWR_0_DBM 0b00000110 // 2 1 0 dBm (default)</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// NRF24_REG_STATUS</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#define NRF24_RX_DR 0b01000000 // 6 6 Rx data ready</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#define NRF24_TX_DS 0b00100000 // 5 5 Tx data sent</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#define NRF24_MAX_RT 0b00010000 // 4 4 maximum number of retransmits reached (must be cleared to continue)</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#define NRF24_RX_FIFO_EMPTY 0b00001110 // 3 1 Rx FIFO is empty</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#define NRF24_RX_P_NO 0b00000000 // 3 1 number of data pipe that received data</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#define NRF24_TX_FIFO_FULL 0b00000001 // 0 0 Tx FIFO is full</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">// NRF24_REG_OBSERVE_TX</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#define NRF24_PLOS_CNT 0b00000000 // 7 4 number of lost packets</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#define NRF24_ARC_CNT 0b00000000 // 3 0 number of retransmitted packets</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">// NRF24_REG_RPD</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor">#define NRF24_RP_BELOW_64_DBM 0b00000000 // 0 0 received power in the current channel: less than -64 dBm</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#define NRF24_RP_ABOVE_64_DBM 0b00000001 // 0 0 more than -64 dBm</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">// NRF24_REG_FIFO_STATUS</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#define NRF24_TX_REUSE 0b01000000 // 6 6 reusing last transmitted payload</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#define NRF24_TX_FIFO_FULL_FLAG 0b00100000 // 5 5 Tx FIFO is full</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#define NRF24_TX_FIFO_EMPTY_FLAG 0b00010000 // 4 4 Tx FIFO is empty</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#define NRF24_RX_FIFO_FULL_FLAG 0b00000010 // 1 1 Rx FIFO is full</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#define NRF24_RX_FIFO_EMPTY_FLAG 0b00000001 // 0 0 Rx FIFO is empty</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">// NRF24_REG_DYNPD</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#define NRF24_DPL_P5_OFF 0b00000000 // 5 5 dynamic payload length on pipe 5: disabled (default)</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#define NRF24_DPL_P5_ON 0b00100000 // 5 5 enabled</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#define NRF24_DPL_P4_OFF 0b00000000 // 4 4 dynamic payload length on pipe 4: disabled (default)</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#define NRF24_DPL_P4_ON 0b00010000 // 4 4 enabled</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#define NRF24_DPL_P3_OFF 0b00000000 // 3 3 dynamic payload length on pipe 3: disabled (default)</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#define NRF24_DPL_P3_ON 0b00001000 // 3 3 enabled</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#define NRF24_DPL_P2_OFF 0b00000000 // 2 2 dynamic payload length on pipe 2: disabled (default)</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#define NRF24_DPL_P2_ON 0b00000100 // 2 2 enabled</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#define NRF24_DPL_P1_OFF 0b00000000 // 1 1 dynamic payload length on pipe 1: disabled (default)</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#define NRF24_DPL_P1_ON 0b00000010 // 1 1 enabled</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#define NRF24_DPL_P0_OFF 0b00000000 // 0 0 dynamic payload length on pipe 0: disabled (default)</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#define NRF24_DPL_P0_ON 0b00000001 // 0 0 enabled</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#define NRF24_DPL_ALL_OFF 0b00000000 // 5 0 disable all dynamic payloads</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="preprocessor">#define NRF24_DPL_ALL_ON 0b00111111 // 5 0 enable all dynamic payloads</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">// NRF24_REG_FEATURE</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#define NRF24_DPL_OFF 0b00000000 // 2 2 dynamic payload length: disabled (default)</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#define NRF24_DPL_ON 0b00000100 // 2 2 enabled</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#define NRF24_ACK_PAY_OFF 0b00000000 // 1 1 payload with ACK packets: disabled (default)</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#define NRF24_ACK_PAY_ON 0b00000010 // 1 1 enabled</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#define NRF24_DYN_ACK_OFF 0b00000000 // 0 0 payloads without ACK: disabled (default)</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#define NRF24_DYN_ACK_ON 0b00000001 // 0 0 enabled</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div>
<div class="line"><a name="l00179"></a><span class="lineno"><a class="line" href="classn_r_f24.html"> 179</a></span> <span class="keyword">class </span><a class="code" href="classn_r_f24.html">nRF24</a>: <span class="keyword">public</span> <a class="code" href="class_physical_layer.html">PhysicalLayer</a> {</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="comment">// introduce PhysicalLayer overloads</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">using</span> <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a>;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">using</span> <a class="code" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a>;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keyword">using</span> <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a>;</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keyword">using</span> <a class="code" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a>;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <a class="code" href="classn_r_f24.html#ab12de8d953c2384c5fff09b4abf65d1e">nRF24</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  </div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  int16_t <a class="code" href="classn_r_f24.html#a60eb59262c5004b587b1d8177706ff28">begin</a>(int16_t freq = 2400, int16_t dataRate = 1000, int8_t power = -12, uint8_t addrWidth = 5);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  int16_t <a class="code" href="classn_r_f24.html#a033287e33c532638c11e2775a073f297">sleep</a>();</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  int16_t <a class="code" href="classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56">standby</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  int16_t <a class="code" href="classn_r_f24.html#a583d505bd3a638ecc5576dd2dd95f044">transmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  </div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  int16_t <a class="code" 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 name="l00250"></a><span class="lineno"> 250</span>  </div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  int16_t <a class="code" href="classn_r_f24.html#a090bb64f65309efabfa1ffd86daa2303">transmitDirect</a>(uint32_t frf = 0) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  </div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  int16_t <a class="code" href="classn_r_f24.html#a415d86947742e981bfcf7f2371f8605c">receiveDirect</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  </div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="comment">// interrupt methods</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  </div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordtype">void</span> <a class="code" href="classn_r_f24.html#abf9323748b1a850e6ddc6f6d48f4cfb3">setIrqAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>));</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  </div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  int16_t <a class="code" href="classn_r_f24.html#a42fdc828b49f2b8e15457189bd57d917">startTransmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  </div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  int16_t <a class="code" href="classn_r_f24.html#af4f443da5d90e032e5f2f65420515f9c">startReceive</a>();</div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  </div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  int16_t <a class="code" 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 name="l00307"></a><span class="lineno"> 307</span>  </div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  </div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  int16_t <a class="code" href="classn_r_f24.html#abec5f9dba44a019e23c8bf516f104fad">setFrequency</a>(int16_t freq);</div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  </div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  int16_t <a class="code" href="classn_r_f24.html#a1f3ec2196733a2e2476f50690967f285">setDataRate</a>(int16_t dataRate);</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  </div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  int16_t <a class="code" href="classn_r_f24.html#a824453d547c0b42ac1988acb42032ca4">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  </div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  int16_t <a class="code" href="classn_r_f24.html#a5b01677f5ce6bee54da8fc7098c339f4">setAddressWidth</a>(uint8_t addrWidth);</div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  </div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  int16_t <a class="code" href="classn_r_f24.html#aa0e1f2dddf810213410a420205bbd8af">setTransmitPipe</a>(uint8_t* addr);</div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  </div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  int16_t <a class="code" href="classn_r_f24.html#a31bcc5a8c3747bf08a273dbdadc5481a">setReceivePipe</a>(uint8_t pipeNum, uint8_t* addr);</div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  </div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  int16_t <a class="code" href="classn_r_f24.html#a31bcc5a8c3747bf08a273dbdadc5481a">setReceivePipe</a>(uint8_t pipeNum, uint8_t addrByte);</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  </div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  int16_t <a class="code" href="classn_r_f24.html#a4dd39e5c0efee1f0c2a14f729eb4426a">disablePipe</a>(uint8_t pipeNum);</div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  </div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  int16_t <a class="code" href="classn_r_f24.html#a3f0b08fd8e58db36f6c1926cc3eac6a9">getStatus</a>(uint8_t mask = 0xFF);</div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  </div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  <span class="keywordtype">bool</span> <a class="code" href="classn_r_f24.html#ad9204ee787b425e2c9e8422bb7939a37">isCarrierDetected</a>();</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  </div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  int16_t <a class="code" href="classn_r_f24.html#a5170284f0a5535de7d00216d450b87a4">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  </div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  <span class="keywordtype">size_t</span> <a class="code" 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 name="l00419"></a><span class="lineno"> 419</span>  </div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  int16_t <a class="code" href="classn_r_f24.html#a3eb45884a5730ac1c339c7ba4f7b5282">setCrcFiltering</a>(<span class="keywordtype">bool</span> crcOn = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  </div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  int16_t <a class="code" href="classn_r_f24.html#aca941c9235ba1212257288554eb4b7fe">setAutoAck</a>(<span class="keywordtype">bool</span> autoAckOn = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  </div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  int16_t <a class="code" href="classn_r_f24.html#aca941c9235ba1212257288554eb4b7fe">setAutoAck</a>(uint8_t pipeNum, <span class="keywordtype">bool</span> autoAckOn);</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  </div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  int16_t <a class="code" href="classn_r_f24.html#a0db248d2bcdb4ca2b401e8e638442916">setDataShaping</a>(uint8_t sh) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  </div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  int16_t <a class="code" href="classn_r_f24.html#a0429a9d6524005065e6fac21aaebdcbf">setEncoding</a>(uint8_t encoding) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  </div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  uint8_t <a class="code" href="classn_r_f24.html#aeb98b92de42dec7c703888c62e061c3c">random</a>();</div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  </div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  <a class="code" href="class_module.html">Module</a>* _mod;</div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  </div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  <span class="keywordtype">void</span> SPIreadRxPayload(uint8_t* data, uint8_t numBytes);</div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="keywordtype">void</span> SPIwriteTxPayload(uint8_t* data, uint8_t numBytes);</div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  <span class="keywordtype">void</span> SPItransfer(uint8_t cmd, <span class="keywordtype">bool</span> write = <span class="keyword">false</span>, uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);</div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  </div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  </div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  uint8_t _addrWidth = 0;</div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  </div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  int16_t config();</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="keywordtype">void</span> clearIRQ();</div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> };</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  </div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<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:111</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab139a34e03a6fd5a781cd54da21d308f"><div class="ttname"><a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)</div><div class="ttdoc">Arduino Flash String transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:10</div></div>
<div class="ttc" id="aclassn_r_f24_html_a1f3ec2196733a2e2476f50690967f285"><div class="ttname"><a href="classn_r_f24.html#a1f3ec2196733a2e2476f50690967f285">nRF24::setDataRate</a></div><div class="ttdeci">int16_t setDataRate(int16_t dataRate)</div><div class="ttdoc">Sets data rate. Allowed values are 2000, 1000 or 250 kbps.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:252</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:494</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:454</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:447</div></div>
<div class="ttc" id="aclassn_r_f24_html_aa0e1f2dddf810213410a420205bbd8af"><div class="ttname"><a href="classn_r_f24.html#aa0e1f2dddf810213410a420205bbd8af">nRF24::setTransmitPipe</a></div><div class="ttdeci">int16_t setTransmitPipe(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:334</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae8eed0e888a7c8742e89d2b850977de2"><div class="ttname"><a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a></div><div class="ttdeci">int16_t readData(String &str, size_t len=0)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:59</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:154</div></div>
<div class="ttc" id="aclassn_r_f24_html_a42fdc828b49f2b8e15457189bd57d917"><div class="ttname"><a href="classn_r_f24.html#a42fdc828b49f2b8e15457189bd57d917">nRF24::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(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:158</div></div>
<div class="ttc" id="aclassn_r_f24_html_aeb98b92de42dec7c703888c62e061c3c"><div class="ttname"><a href="classn_r_f24.html#aeb98b92de42dec7c703888c62e061c3c">nRF24::random</a></div><div class="ttdeci">uint8_t random()</div><div class="ttdoc">Dummy random method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:508</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:436</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:501</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:440</div></div>
<div class="ttc" id="aclassn_r_f24_html_af4f443da5d90e032e5f2f65420515f9c"><div class="ttname"><a href="classn_r_f24.html#af4f443da5d90e032e5f2f65420515f9c">nRF24::startReceive</a></div><div class="ttdeci">int16_t startReceive()</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:198</div></div>
<div class="ttc" id="aclassn_r_f24_html_a583d505bd3a638ecc5576dd2dd95f044"><div class="ttname"><a href="classn_r_f24.html#a583d505bd3a638ecc5576dd2dd95f044">nRF24::transmit</a></div><div class="ttdeci">int16_t transmit(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:80</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:148</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:401</div></div>
<div class="ttc" id="aclassn_r_f24_html_ab12de8d953c2384c5fff09b4abf65d1e"><div class="ttname"><a href="classn_r_f24.html#ab12de8d953c2384c5fff09b4abf65d1e">nRF24::nRF24</a></div><div class="ttdeci">nRF24(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:4</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:14</div></div>
<div class="ttc" id="aclass_physical_layer_html_afb1b090348d9091bfa3a0b5ba3d85b36"><div class="ttname"><a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a></div><div class="ttdeci">int16_t receive(String &str, size_t len=0)</div><div class="ttdoc">Arduino String receive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:100</div></div>
<div class="ttc" id="aclassn_r_f24_html_a824453d547c0b42ac1988acb42032ca4"><div class="ttname"><a href="classn_r_f24.html#a824453d547c0b42ac1988acb42032ca4">nRF24::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t power)</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:274</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:432</div></div>
<div class="ttc" id="aclassn_r_f24_html_a033287e33c532638c11e2775a073f297"><div class="ttname"><a href="classn_r_f24.html#a033287e33c532638c11e2775a073f297">nRF24::sleep</a></div><div class="ttdeci">int16_t sleep()</div><div class="ttdoc">Sets the module to sleep mode.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:66</div></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 SPI/UART/I2C methods to control the wireless module....</div><div class="ttdef"><b>Definition:</b> Module.h:17</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:179</div></div>
<div class="ttc" id="aclassn_r_f24_html_a60eb59262c5004b587b1d8177706ff28"><div class="ttname"><a href="classn_r_f24.html#a60eb59262c5004b587b1d8177706ff28">nRF24::begin</a></div><div class="ttdeci">int16_t begin(int16_t freq=2400, int16_t dataRate=1000, int8_t power=-12, uint8_t addrWidth=5)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:8</div></div>
<div class="ttc" id="aclassn_r_f24_html_abec5f9dba44a019e23c8bf516f104fad"><div class="ttname"><a href="classn_r_f24.html#abec5f9dba44a019e23c8bf516f104fad">nRF24::setFrequency</a></div><div class="ttdeci">int16_t setFrequency(int16_t freq)</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:244</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:133</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:70</div></div>
<div class="ttc" id="aclassn_r_f24_html_a31bcc5a8c3747bf08a273dbdadc5481a"><div class="ttname"><a href="classn_r_f24.html#a31bcc5a8c3747bf08a273dbdadc5481a">nRF24::setReceivePipe</a></div><div class="ttdeci">int16_t setReceivePipe(uint8_t pipeNum, 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:349</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:465</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:303</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.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:224</div></div>
<div class="ttc" id="aclass_physical_layer_html_af068e6e862c99e39d0261a7971dd56db"><div class="ttname"><a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(String &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:51</div></div>
<!-- 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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>