| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.5"/>
- <title>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="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 style="padding-left: 0.5em;">
- <div id="projectname">NRF24
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.5 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="annotated.html"><span>Classes</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- <li><a href="examples.html"><span>Examples</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <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="comment">// NRF24.h</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Author: Mike McCauley</span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2012 Mike McCauley</span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// $Id: NRF24.h,v 1.2 2014/05/20 06:00:55 mikem Exp mikem $</span></div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span><span class="comment"></span></div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/// \mainpage NRF24 library for Arduino</span></div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/// This NRF24 library has now been superceded by the RadioHead </span></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/// library http://www.airspayce.com/mikem/arduino/RadioHead</span></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/// RadioHead and its RH_NRF24 driver provides all the features supported by NRF24, and much more</span></div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/// besides, including Reliable Datagrams, Addressing, Routing and Meshes. All the platforms that</span></div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/// NRF24 supported are also supported by RadioHead.</span></div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/// This library will no longer be maintained or updated, but we will continue to publish</span></div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/// it for the benefit of the the community, and you may continue to use it within the terms of</span></div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/// the license. Nevertheless we recommend upgrading to RadioHead where</span></div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/// possible.</span></div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/// This is the Arduino NRF24 library.</span></div>
- <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/// It provides an object-oriented interface for sending and receiving data messages with Nordic nRF24L01</span></div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/// based radio modules, such as the sparkfun WRL-00691 http://www.sparkfun.com/products/691</span></div>
- <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/// The nRF24L01 (http://www.sparkfun.com/datasheets/Wireless/Nordic/nRF24L01P_Product_Specification_1_0.pdf)</span></div>
- <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/// is a low-cost 2.4GHz ISM transceiver module. It supports a number of channel frequencies in the 2.4GHz band</span></div>
- <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// and a range of data rates.</span></div>
- <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/// This library provides functions for sending and receiving messages of up to 32 octets on any </span></div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/// frequency supported by the nRF24L01, at a selected data rate.</span></div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/// Up to 2 nRF24L01 modules can be connected to an Arduino, permitting the construction of translators</span></div>
- <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/// and frequency changers, etc.</span></div>
- <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// This library provides classes for </span></div>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/// - NRF24: addressed, reliable, retransmitted, acknowledged messages (using nrf24 Enhanced Shockburst)</span></div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// Example Arduino programs are included to show the main modes of use.</span></div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/// The version of the package that this documentation refers to can be downloaded </span></div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/// from http://www.airspayce.com/mikem/arduino/NRF24/NRF24-1.14.zip</span></div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/// You can find the latest version at http://www.airspayce.com/mikem/arduino/NRF24</span></div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/// You can also find online help and disussion at </span></div>
- <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/// http://groups.google.com/group/NRF24-arduino</span></div>
- <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/// Please use that group for all questions and discussions on this topic. </span></div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/// Do not contact the author directly, unless it is to discuss commercial licensing.</span></div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// Before asking a question or reporting a bug, please read http://www.catb.org/esr/faqs/smart-questions.html</span></div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/// Tested on Arduino Diecimila, Duemilanove and Mega with arduino 1.0</span></div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/// on OpenSuSE 12.1 with avr-libc-1.7.1-1.1, cross-avr-binutils-2.19.1-33.1</span></div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/// and cross-avr-gcc-4.3.3_20100125-28.1, and with arduino-0021 on the same platforms</span></div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/// \par Packet Format</span></div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/// All messages sent and received by this NRF24 library must conform to this packet format, as specified by </span></div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/// the nRF24L01 product specificaiton:</span></div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/// - 1 octets PREAMBLE</span></div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/// - 4 octets ADDRESS</span></div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/// - 9 bits packet control field</span></div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/// - 0 to 32 octets PAYLOAD</span></div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/// - 2 octets CRC </span></div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/// \par Connecting nRF24L01 to Arduino</span></div>
- <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/// The physical connection between the nRF24L01 and the Arduino require 3.3V, the 3 x SPI pins (SCK, SDI, SDO), </span></div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/// a Chip Enable pin and a Slave Select pin.</span></div>
- <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/// If you are using the Sparkfun WRL-00691 module, it has a voltage regulator on board and </span></div>
- <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/// can be run with 5V VCC</span></div>
- <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/// The examples below assume the Sparkfun WRL-00691 module</span></div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/// Connect the nRF24L01 to most Arduino's like this (Caution, Arduino Mega has different pins for SPI, </span></div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/// see below), </span></div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/// \code</span></div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/// Arduino Sparkfun WRL-00691</span></div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/// 3V3 or 5V----VCC (3.3V to 7V in)</span></div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/// pin D8-----------CE (chip enable in)</span></div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/// SS pin D10----------CSN (chip select in)</span></div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/// SCK pin D13----------SCK (SPI clock in)</span></div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/// MOSI pin D11----------SDI (SPI Data in)</span></div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/// MISO pin D12----------SDO (SPI data out)</span></div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">/// IRQ (Interrupt output, not connected)</span></div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/// GND----------GND (ground in)</span></div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/// \endcode</span></div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/// For an Arduino Leonardo (the SPI pins do not come out on the Digital pins as for normal Arduino, but only</span></div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/// appear on the ICSP header)</span></div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/// \code</span></div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">/// Leonardo Sparkfun WRL-00691</span></div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">/// 3V3 or 5V----VCC (3.3V to 7V in)</span></div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/// pin D8-----------CE (chip enable in)</span></div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/// SS pin D10----------CSN (chip select in)</span></div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/// SCK ICSP pin 3----------SCK (SPI clock in)</span></div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/// MOSI ICSP pin 4----------SDI (SPI Data in)</span></div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/// MISO ICSP pin 1----------SDO (SPI data out)</span></div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/// IRQ (Interrupt output, not connected)</span></div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/// GND----------GND (ground in)</span></div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/// \endcode</span></div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/// and initialise the NRF24 object like this to explicitly set the SS pin</span></div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">/// NRF24 nrf24(8, 10);</span></div>
- <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">/// For an Arduino Mega:</span></div>
- <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/// \code</span></div>
- <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">/// Mega Sparkfun WRL-00691</span></div>
- <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">/// 3V3 or 5V----VCC (3.3V to 7V in)</span></div>
- <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">/// pin D8-----------CE (chip enable in)</span></div>
- <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/// SS pin D53----------CSN (chip select in)</span></div>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">/// SCK pin D52----------SCK (SPI clock in)</span></div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/// MOSI pin D51----------SDI (SPI Data in)</span></div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/// MISO pin D50----------SDO (SPI data out)</span></div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">/// IRQ (Interrupt output, not connected)</span></div>
- <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">/// GND----------GND (ground in)</span></div>
- <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/// \endcode</span></div>
- <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">/// and you can then use the default constructor NRF24(). </span></div>
- <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/// You can override the default settings for the CSN and CE pins </span></div>
- <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">/// in the NRF24() constructor if you wish to connect the slave select CSN to other than the normal one for your </span></div>
- <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/// Arduino (D10 for Diecimila, Uno etc and D53 for Mega)</span></div>
- <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/// Caution: on some Arduinos such as the Mega 2560, if you set the slave select pin to be other than the usual SS </span></div>
- <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">/// pin (D53 on Mega 2560), you may need to set the usual SS pin to be an output to force the Arduino into SPI </span></div>
- <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">/// master mode.</span></div>
- <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">/// Caution: this module has not been proved to work with Leonardo, at least without level </span></div>
- <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">/// shifters between the NRF24 and the Leonardo. Tests seem to indicate that such level shifters would be required</span></div>
- <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">/// with Leonardo to make it work.</span></div>
- <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">/// It is possible to have 2 radios conected to one arduino, provided each radio has its own </span></div>
- <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">/// CSN and CE line (SCK, SDI and SDO are common to both radios)</span></div>
- <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/// \par Example programs</span></div>
- <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">/// The following example programs are provided:</span></div>
- <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/// -nrf24_ping_client, nrf24_pin_server. This is a matched pair. The client sends (acknowledged)</span></div>
- <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/// 4 byte timestamp to the server which replies (acknowledged). </span></div>
- <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">/// The client measures the round-trip time and prints it. Typical RTT is 1-2 msec. </span></div>
- <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">/// These are compatible radio wise with the ping_client and ping_server programs that come with the Mirf library</span></div>
- <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">/// though the electrical connections are different</span></div>
- <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">/// -nrf24_specan. Example sketch showing how to create a primitive spectrum analyser</span></div>
- <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/// with the NRF24 class. The nRF24L01 received power detector is only one bit, but</span></div>
- <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">/// this will show which channels have more than -64dBm present.</span></div>
- <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">/// -nrf24_audio_tx, nrf24_audio_rx. This is a matched pair. The clinet sends a stream of audio samples measured</span></div>
- <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">/// from analog input 0 to the receiver, which reconstructs them on output D6. See comments in those files for </span></div>
- <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/// electrical requirements. The pair demonstrates the use of NRF24 in NOACK modefor improved performance </span></div>
- <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">/// (but no reliability). Can achieve 6.4kHz sample rate. Dont expect good quality audio!</span></div>
- <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">/// \par Radio Performance</span></div>
- <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/// The performance of this radio seems to be very good. I was able to build ping client/server</span></div>
- <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/// that was able to achieve over 800 round trips per second </span></div>
- <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">/// (at 0dBm power, 2Mbps, channel 1, 4 byte payload each way, 1 checksum byte) when the radios were next to each other. </span></div>
- <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">/// This rate could still be achieved at 15m distance, but the orientation of the radios and </span></div>
- <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">/// obstructions became critical. The human body can easily block these signals. </span></div>
- <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/// Best response was when the chip antennas were broadside to each other.</span></div>
- <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/// </span></div>
- <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/// It is possible to get even better streaming performance using NOACK mode (see the nrf24_audio_tx sample)</span></div>
- <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/// at the cost of nop reliability.</span></div>
- <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">/// In NOACK mode, at 2Mbps, 32 byte payload, can get about 1900 packets per second: 60800 bytes of payload per second</span></div>
- <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">/// Frequency accuracy may be debatable. For nominal frequency of 2401.000 MHz (ie channel 1), </span></div>
- <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">/// my Yaesu VR-5000 receiver indicated the center frequency for my test radios</span></div>
- <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">/// was 2401.121 MHz. Its not clear to me if the Yaesu</span></div>
- <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">/// is the source of the error, but I tend to believe it, which would make the nRF24l01 frequency out by 121kHz.</span></div>
- <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">/// </span></div>
- <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">/// \par Radio operating strategy and defaults</span></div>
- <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">/// The radio is enabled all the time, and switched between TX and RX modes depending on </span></div>
- <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">/// whether there is any data to send. Sending data sets the radio to TX mode.</span></div>
- <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">/// After data is sent, the radion automatically returns to Standby II mode. Calling waitAvailable() or</span></div>
- <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/// waitAvailableTimeout() starts the radio in RX mode.</span></div>
- <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">/// The radio is configured by default to Channel 2, 2Mbps, 0dBm power, 5 bytes address, payload width 1, CRC enabled</span></div>
- <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">/// 1 byte CRC, Auto-Ack mode. Enhanced shockburst is used. </span></div>
- <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">/// P1 is the receive pipe. P0 is set to the transmit address to enable autoack.</span></div>
- <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">/// \par Memory</span></div>
- <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/// Memory usage of this program is minimal. The compiled ping client and server programs are about 4000 bytes. </span></div>
- <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">/// RAM requirements of the library are minimal.</span></div>
- <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">/// \par Installation</span></div>
- <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">/// Install in the usual way: unzip the distribution zip file to the libraries</span></div>
- <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">/// sub-folder of your sketchbook. </span></div>
- <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">/// This software is Copyright (C) 2012 Mike McCauley. Use is subject to license</span></div>
- <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">/// conditions. The main licensing options available are GPL V2 or Commercial:</span></div>
- <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">/// </span></div>
- <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">/// \par Donations</span></div>
- <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">/// This library is offered under a free GPL license for those who want to use it that way. </span></div>
- <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">/// We try hard to keep it up to date, fix bugs</span></div>
- <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">/// and to provide free support. If this library has helped you save time or money, please consider donating at</span></div>
- <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/// http://www.airspayce.com or here:</span></div>
- <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/// \htmlonly <form action="https://www.paypal.com/cgi-bin/webscr" method="post"><input type="hidden" name="cmd" value="_donations" /> <input type="hidden" name="business" value="mikem@airspayce.com" /> <input type="hidden" name="lc" value="AU" /> <input type="hidden" name="item_name" value="Airspayce" /> <input type="hidden" name="item_number" value="NRF24" /> <input type="hidden" name="currency_code" value="USD" /> <input type="hidden" name="bn" value="PP-DonationsBF:btn_donateCC_LG.gif:NonHosted" /> <input type="image" alt="PayPal — The safer, easier way to pay online." name="submit" src="https://www.paypalobjects.com/en_AU/i/btn/btn_donateCC_LG.gif" /> <img alt="" src="https://www.paypalobjects.com/en_AU/i/scr/pixel.gif" width="1" height="1" border="0" /></form> \endhtmlonly</span></div>
- <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">/// </span></div>
- <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">/// \par Open Source Licensing GPL V2</span></div>
- <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment">/// This is the appropriate option if you want to share the source code of your</span></div>
- <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">/// application with everyone you distribute it to, and you also want to give them</span></div>
- <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">/// the right to share who uses it. If you wish to use this software under Open</span></div>
- <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">/// Source Licensing, you must contribute all your source code to the open source</span></div>
- <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">/// community in accordance with the GPL Version 2 when your application is</span></div>
- <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">/// distributed. See http://www.gnu.org/copyleft/gpl.html</span></div>
- <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">/// </span></div>
- <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">/// \par Commercial Licensing</span></div>
- <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">/// This is the appropriate option if you are creating proprietary applications</span></div>
- <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">/// and you are not prepared to distribute and share the source code of your</span></div>
- <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">/// application. Contact info@airspayce.com for details.</span></div>
- <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">/// \par Revision History</span></div>
- <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">/// \version 1.0 Initial release</span></div>
- <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">/// \version 1.1 Changed default value for slave slect pin in constructor to be SS, ie the normal one for </span></div>
- <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">/// the compiled Arduino (D10 for Diecimila, Uno etc and D53 for Mega). This is because some Arduinos such as Mega 2560</span></div>
- <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">/// reportedly use the type of the SS pin to determine whether to run in slave or master mode. Therfore it</span></div>
- <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">/// is preferred that the slave select pin actually be the normal SS pin.</span></div>
- <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">/// \version 1.2 Updated documentation about what happens during init, and that SPI is initialised to 8MHz </span></div>
- <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment">/// (but can be set to other frequencies after calling init()</span></div>
- <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">/// \version 1.3 Fixed error in title of main page</span></div>
- <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">/// \version 1.4 Fixed typo in nrf24_test.pde, reported by TOM.</span></div>
- <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">/// \version 1.6 Fixed an error NRF24::setRF in setting data rate to 250kbps. Reported by Shiu Kumar.</span></div>
- <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment">/// \version 1.7 Improvements to waitPacketSent() so if the chip is not in transmit mode, it wont wait forever.</span></div>
- <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">/// Improvements to isSending() so it returns false if the chip is not in transmit mode.</span></div>
- <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment">/// \version 1.8 Fixed a conflict between 2 definitions of NRF24_TX_FULL. The one in 07 STATUS is changed to </span></div>
- <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">/// NRF24_STATUS_TX_FULL. Reported by Charles-Henri Hallard.</span></div>
- <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">/// Updated author and distribution location details to airspayce.com</span></div>
- <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">/// \version 1.9 Improvements to waitAvailableTimeout to make it robust on millis() rollover. </span></div>
- <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">/// \version 1.10 Testing with Leonardo and update documentation to reflect special electrical</span></div>
- <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">/// connection needs on Leonardo.</span></div>
- <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment">/// \version 1.11 NRF24_COMMAND_W_ACK_PAYLOAD(c) is now a macro that takes a pipe number parameter.</span></div>
- <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment">/// Added new function setRetry(), a convenience for setting ARD and ARC retry parameter.</span></div>
- <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">/// Can now customise the radio configuration byte with setConfiguration().</span></div>
- <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">/// Added new examples crazyflie and crazyflie_client that use the NRF24 library to</span></div>
- <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">/// communicate with Crazyflie quadcopters and transmitters.</span></div>
- <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">/// \version 1.12 NRF24::init, powerUpRx, powerUpTx will now fail if no device is connected;</span></div>
- <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">/// \version 1.13 Added End Of Life notice. This library will no longer be maintained </span></div>
- <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment">/// and updated: use RadioHead instead.</span></div>
- <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">/// \version 1.14 Fixed problem that prevented 250kbps data rate working.</span></div>
- <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">/// \author Mike McCauley (mikem@airspayce.com) DO NOT CONTACT THE AUTHOR DIRECTLY: USE THE LISTS</span></div>
- <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"></span></div>
- <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="preprocessor">#ifndef NRF24_h</span></div>
- <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_h</span></div>
- <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="preprocessor">#if ARDUINO >= 100</span></div>
- <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor"></span><span class="preprocessor">#include <Arduino.h></span></div>
- <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="preprocessor">#else</span></div>
- <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor"></span><span class="preprocessor">#include <wiring.h></span></div>
- <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="preprocessor">#include <pins_arduino.h></span></div>
- <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">// These defs cause trouble on some versions of Arduino</span></div>
- <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor">#undef round</span></div>
- <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="preprocessor"></span><span class="preprocessor">#undef double</span></div>
- <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">// This is the bit in the SPI address that marks it as a write</span></div>
- <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="preprocessor">#define NRF24_SPI_WRITE_MASK 0x80</span></div>
- <div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">// This is the maximum message length that can be supported by this library. Limited by</span></div>
- <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment">// the suported message lengths oin the nRF24</span></div>
- <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment">// Can be pre-defined to a smaller size (to save SRAM) prior to including this header</span></div>
- <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="preprocessor">#ifndef NRF24_MAX_MESSAGE_LEN</span></div>
- <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_MAX_MESSAGE_LEN 32</span></div>
- <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">// Keep track of the mode the NRF24 is in</span></div>
- <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="preprocessor">#define NRF24_MODE_IDLE 0</span></div>
- <div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_MODE_RX 1</span></div>
- <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_MODE_TX 2</span></div>
- <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">// These values we set for FIFO thresholds are actually the same as the POR values</span></div>
- <div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="preprocessor">#define NRF24_TXFFAEM_THRESHOLD 4</span></div>
- <div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_RXFFAFULL_THRESHOLD 55</span></div>
- <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment">// This is the default node address,</span></div>
- <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="preprocessor">#define NRF24_DEFAULT_NODE_ADDRESS 0x00000000</span></div>
- <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment">// This address in the TO addreess signifies a broadcast</span></div>
- <div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="preprocessor">#define NRF24_BROADCAST_ADDRESS 0xffffffffff</span></div>
- <div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment">// SPI Command names</span></div>
- <div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="preprocessor">#define NRF24_COMMAND_R_REGISTER 0x00</span></div>
- <div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_W_REGISTER 0x20</span></div>
- <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_R_RX_PAYLOAD 0x61</span></div>
- <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_W_TX_PAYLOAD 0xa0</span></div>
- <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_FLUSH_TX 0xe1</span></div>
- <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_FLUSH_RX 0xe2</span></div>
- <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_REUSE_TX_PL 0xe3</span></div>
- <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_R_RX_PL_WID 0x60</span></div>
- <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_W_ACK_PAYLOAD(pipe) (0xa8|(pipe&0x7))</span></div>
- <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_W_TX_PAYLOAD_NOACK 0xb0</span></div>
- <div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_COMMAND_NOP 0xff</span></div>
- <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">// Register names</span></div>
- <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="preprocessor">#define NRF24_REGISTER_MASK 0x1f</span></div>
- <div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_00_CONFIG 0x00</span></div>
- <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_01_EN_AA 0x01</span></div>
- <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_02_EN_RXADDR 0x02</span></div>
- <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_03_SETUP_AW 0x03</span></div>
- <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_04_SETUP_RETR 0x04</span></div>
- <div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_05_RF_CH 0x05</span></div>
- <div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_06_RF_SETUP 0x06</span></div>
- <div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_07_STATUS 0x07</span></div>
- <div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_08_OBSERVE_TX 0x08</span></div>
- <div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_09_RPD 0x09</span></div>
- <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_0A_RX_ADDR_P0 0x0a</span></div>
- <div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_0B_RX_ADDR_P1 0x0b</span></div>
- <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_0C_RX_ADDR_P2 0x0c</span></div>
- <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_0D_RX_ADDR_P3 0x0d</span></div>
- <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_0E_RX_ADDR_P4 0x0e</span></div>
- <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_0F_RX_ADDR_P5 0x0f</span></div>
- <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_10_TX_ADDR 0x10</span></div>
- <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_11_RX_PW_P0 0x11</span></div>
- <div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_12_RX_PW_P1 0x12</span></div>
- <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_13_RX_PW_P2 0x13</span></div>
- <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_14_RX_PW_P3 0x14</span></div>
- <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_15_RX_PW_P4 0x15</span></div>
- <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_16_RX_PW_P5 0x16</span></div>
- <div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_17_FIFO_STATUS 0x17</span></div>
- <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_1C_DYNPD 0x1c</span></div>
- <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_REG_1D_FEATURE 0x1d</span></div>
- <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">// These register masks etc are named wherever possible</span></div>
- <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">// corresponding to the bit and field names in the nRF24L01 Product Specification</span></div>
- <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">// #define NRF24_REG_00_CONFIG 0x00</span></div>
- <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor">#define NRF24_MASK_RX_DR 0x40</span></div>
- <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_MASK_TX_DS 0x20</span></div>
- <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_MASK_MAX_RT 0x10</span></div>
- <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_EN_CRC 0x08</span></div>
- <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_CRCO 0x04</span></div>
- <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PWR_UP 0x02</span></div>
- <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PRIM_RX 0x01</span></div>
- <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment">// #define NRF24_REG_01_EN_AA 0x01</span></div>
- <div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="preprocessor">#define NRF24_ENAA_P5 0x20</span></div>
- <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ENAA_P4 0x10</span></div>
- <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ENAA_P3 0x08</span></div>
- <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ENAA_P2 0x04</span></div>
- <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ENAA_P1 0x02</span></div>
- <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ENAA_P0 0x01</span></div>
- <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment">// #define NRF24_REG_02_EN_RXADDR 0x02</span></div>
- <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="preprocessor">#define NRF24_ERX_P5 0x20</span></div>
- <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ERX_P4 0x10</span></div>
- <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ERX_P3 0x08</span></div>
- <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ERX_P2 0x04</span></div>
- <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ERX_P1 0x02</span></div>
- <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ERX_P0 0x01</span></div>
- <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment">// #define NRF24_REG_03_SETUP_AW 0x03</span></div>
- <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor">#define NRF24_AW_3_BYTES 0x01</span></div>
- <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_AW_4_BYTES 0x02</span></div>
- <div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_AW_5_BYTES 0x03</span></div>
- <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment">// #define NRF24_REG_04_SETUP_RETR 0x04</span></div>
- <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="preprocessor">#define NRF24_ARD 0xf0</span></div>
- <div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ARC 0x0f</span></div>
- <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment">// #define NRF24_REG_05_RF_CH 0x05</span></div>
- <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="preprocessor">#define NRF24_RF_CH 0x7f</span></div>
- <div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment">// #define NRF24_REG_06_RF_SETUP 0x06</span></div>
- <div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="preprocessor">#define NRF24_CONT_WAVE 0x80</span></div>
- <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_RF_DR_LOW 0x20</span></div>
- <div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PLL_LOCK 0x10</span></div>
- <div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_RF_DR_HIGH 0x08</span></div>
- <div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PWR 0x06</span></div>
- <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PWR_m18dBm 0x00</span></div>
- <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PWR_m12dBm 0x02</span></div>
- <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PWR_m6dBm 0x04</span></div>
- <div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_PWR_0dBm 0x06</span></div>
- <div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment">// #define NRF24_REG_07_STATUS 0x07</span></div>
- <div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="preprocessor">#define NRF24_RX_DR 0x40</span></div>
- <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_TX_DS 0x20</span></div>
- <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_MAX_RT 0x10</span></div>
- <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_RX_P_NO 0x0e</span></div>
- <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_STATUS_TX_FULL 0x01</span></div>
- <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> </div>
- <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment">// #define NRF24_REG_08_OBSERVE_TX 0x08</span></div>
- <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="preprocessor">#define NRF24_PLOS_CNT 0xf0</span></div>
- <div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_ARC_CNT 0x0f</span></div>
- <div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment">// #define NRF24_REG_09_RPD 0x09</span></div>
- <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor">#define NRF24_RPD 0x01</span></div>
- <div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment">// #define NRF24_REG_17_FIFO_STATUS 0x17</span></div>
- <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="preprocessor">#define NRF24_TX_REUSE 0x40</span></div>
- <div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_TX_FULL 0x20</span></div>
- <div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_TX_EMPTY 0x10</span></div>
- <div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_RX_FULL 0x02</span></div>
- <div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_RX_EMPTY 0x01</span></div>
- <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment">// #define NRF24_REG_1C_DYNPD 0x1c</span></div>
- <div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="preprocessor">#define NRF24_DPL_P5 0x20</span></div>
- <div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_DPL_P4 0x10</span></div>
- <div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_DPL_P3 0x08</span></div>
- <div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_DPL_P2 0x04</span></div>
- <div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_DPL_P1 0x02</span></div>
- <div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_DPL_P0 0x01</span></div>
- <div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment">// #define NRF24_REG_1D_FEATURE 0x1d</span></div>
- <div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="preprocessor">#define NRF24_EN_DPL 0x04</span></div>
- <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_EN_ACK_PAY 0x02</span></div>
- <div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="preprocessor"></span><span class="preprocessor">#define NRF24_EN_DYN_ACK 0x01</span></div>
- <div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"></span></div>
- <div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment">/////////////////////////////////////////////////////////////////////</span></div>
- <div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment">/// \class NRF24 NRF24.h <NRF24.h></span></div>
- <div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment">/// \brief Send and receive addressed, reliable, acknowledged datagrams by nRF24L01.</span></div>
- <div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment">/// This base class provides basic functions for sending and receiving addressed, reliable, </span></div>
- <div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment">/// automatically acknowledged and retransmitted</span></div>
- <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment">/// datagrams via nRF24L01 of arbitrary length to 32 octets per packet. </span></div>
- <div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment">/// Sender and receiver must each know the addreesses of the other, so arbitrary meshes and stars are</span></div>
- <div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment">/// not possible at this level.</span></div>
- <div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment">/// Directed replies (ie replies sent back to the original sender) are not possible </span></div>
- <div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment">/// (the address of the sender is not carried in the message). </span></div>
- <div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment">/// See subclasses for support for this.</span></div>
- <div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment">/// Subclasses may use this class to implement streams, </span></div>
- <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment">/// mesh routers, repeaters, translators etc.</span></div>
- <div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment">/// On transmission, the addresses of this node defaults to 0x0000000000, unless changed by a subclass. </span></div>
- <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment">/// The radio is configured to use Enhanced Shockburst with retransmits.</span></div>
- <div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment">/// TX_ADDR and RX_ADDR_P0 are set to the transmit address (ie the address of the destination for the next message</span></div>
- <div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment">/// RX_ADDR_P1 is set to the address of this node</span></div>
- <div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment">/// RX_ADDR_P2 is set to RX_ADDR_P1 with the LSbyte set to 0xff, for use as a broadcast address</span></div>
- <div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment">/// Naturally, for any 2 radios to communicate that must be configured to use the same frequency and </span></div>
- <div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment">/// data rate, and with compatible addresses</span></div>
- <div class="line"><a name="l00437"></a><span class="lineno"><a class="line" href="classNRF24.html"> 437</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classNRF24.html">NRF24</a></div>
- <div class="line"><a name="l00438"></a><span class="lineno"> 438</span> {</div>
- <div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="keyword">public</span>:</div>
- <div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"></span></div>
- <div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> /// \brief Defines convenient values for setting data rates in setRF()</span></div>
- <div class="line"><a name="l00442"></a><span class="lineno"><a class="line" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742"> 442</a></span> <span class="comment"></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
- <div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  {</div>
- <div class="line"><a name="l00444"></a><span class="lineno"><a class="line" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742a774c99f9cf1c98cb883d4a01c1444c52"> 444</a></span>  <a class="code" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742a774c99f9cf1c98cb883d4a01c1444c52">NRF24DataRate1Mbps</a> = 0, <span class="comment">///< 1 Mbps</span></div>
- <div class="line"><a name="l00445"></a><span class="lineno"><a class="line" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742aca0c89dd1b40bdc57b7026d8da54de9a"> 445</a></span> <span class="comment"></span> <a class="code" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742aca0c89dd1b40bdc57b7026d8da54de9a">NRF24DataRate2Mbps</a>, <span class="comment">///< 2 Mbps</span></div>
- <div class="line"><a name="l00446"></a><span class="lineno"><a class="line" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742ae4523002495ee537f2731b61a220e3af"> 446</a></span> <span class="comment"></span> <a class="code" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742ae4523002495ee537f2731b61a220e3af">NRF24DataRate250kbps</a> <span class="comment">///< 250 kbps</span></div>
- <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"></span> } <a class="code" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742">NRF24DataRate</a>;</div>
- <div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"></span></div>
- <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment"> /// \brief Convenient values for setting transmitter power in setRF()</span></div>
- <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"> /// These are designed to agree with the values for RF_PWR</span></div>
- <div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment"> /// To be passed to setRF();</span></div>
- <div class="line"><a name="l00452"></a><span class="lineno"><a class="line" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7e"> 452</a></span> <span class="comment"></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
- <div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  {</div>
- <div class="line"><a name="l00454"></a><span class="lineno"><a class="line" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7ea4790420d436218aa3bf4c23687664853"> 454</a></span>  <a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7ea4790420d436218aa3bf4c23687664853">NRF24TransmitPowerm18dBm</a> = 0, <span class="comment">///< -18 dBm</span></div>
- <div class="line"><a name="l00455"></a><span class="lineno"><a class="line" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacce8a36a9753c7c125ad6db450ddfff8"> 455</a></span> <span class="comment"></span> <a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacce8a36a9753c7c125ad6db450ddfff8">NRF24TransmitPowerm12dBm</a>, <span class="comment">///< -12 dBm</span></div>
- <div class="line"><a name="l00456"></a><span class="lineno"><a class="line" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eaf8351d714335d0c24bcbb8d3c983d5c7"> 456</a></span> <span class="comment"></span> <a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eaf8351d714335d0c24bcbb8d3c983d5c7">NRF24TransmitPowerm6dBm</a>, <span class="comment">///< -6 dBm</span></div>
- <div class="line"><a name="l00457"></a><span class="lineno"><a class="line" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacef1d6c037e276e6dadaff2b6056ec0c"> 457</a></span> <span class="comment"></span> <a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacef1d6c037e276e6dadaff2b6056ec0c">NRF24TransmitPower0dBm</a> <span class="comment">///< 0 dBm</span></div>
- <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"></span> } <a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7e">NRF24TransmitPower</a>;</div>
- <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"></span></div>
- <div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> /// Constructor. You can have multiple instances, but each instance must have its own</span></div>
- <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> /// chip enable and slave select pin. </span></div>
- <div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> /// After constructing, you must call init() to initialise the interface</span></div>
- <div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> /// and the radio module</span></div>
- <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> /// \param[in] chipEnablePin the Arduino pin to use to enable the chip for4 transmit/receive</span></div>
- <div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> /// \param[in] chipSelectPin the Arduino pin number of the output to use to select the NRF24 before</span></div>
- <div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> /// accessing it</span></div>
- <div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"></span> <a class="code" href="classNRF24.html#ab0eb09c01f73bee4ff6935c0503a8ace">NRF24</a>(uint8_t chipEnablePin = 8, uint8_t chipSelectPin = SS);</div>
- <div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  <span class="comment"></span></div>
- <div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> /// Initialises this instance and the radio module connected to it.</span></div>
- <div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> /// The following steps are taken:g</span></div>
- <div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> /// - Set the chip enable and chip select pins to output LOW, HIGH respectively.</span></div>
- <div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> /// - Initialise the SPI output pins</span></div>
- <div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"> /// - Initialise the SPI interface library to 8MHz (Hint, if you want to lower</span></div>
- <div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> /// the SPI frequency (perhaps where you have other SPI shields, low voltages etc), </span></div>
- <div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> /// call SPI.setClockDivider() after init()).</span></div>
- <div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> /// -Flush the receiver and transmitter buffers</span></div>
- <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> /// - Set the radio to receive with powerUpRx();</span></div>
- <div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> /// \return true if everything was successful</span></div>
- <div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a6e98cf508939240c1805245170a995f6">init</a>();</div>
- <div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"></span></div>
- <div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> /// Execute an SPI command that requires neither reading or writing</span></div>
- <div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> /// \param[in] command the SPI command to execute, one of NRF24_COMMAND_*</span></div>
- <div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a08ae66610a928a779c0b256e782128b5">spiCommand</a>(uint8_t command);</div>
- <div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"></span></div>
- <div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> /// Reads a single command byte from the NRF24</span></div>
- <div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> /// \param[in] command Command number, one of NRF24_COMMAND_*</span></div>
- <div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> /// \return the single byte returned by the command</span></div>
- <div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#ab2f002c33ec719dfdd3ae70d70559254">spiRead</a>(uint8_t command);</div>
- <div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"></span></div>
- <div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> /// Writes a single command byte to the NRF24</span></div>
- <div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> /// \param[in] command Command number, one of NRF24_COMMAND_*</span></div>
- <div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> /// \param[in] val The value to write</span></div>
- <div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a16f168ffe059120ba696936cd6bd76f1">spiWrite</a>(uint8_t command, uint8_t val);</div>
- <div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"></span></div>
- <div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> /// Reads a number of consecutive bytes from a command using burst read mode</span></div>
- <div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> /// \param[in] command Command number of NRF24_COMMAND_*</span></div>
- <div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> /// \param[in] dest Array to write the bytes returned by the command to. Must be at least len bytes</span></div>
- <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> /// \param[in] len Number of bytes to read</span></div>
- <div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classNRF24.html#a448aad6cda19f068009106aa5f6a7e6a">spiBurstRead</a>(uint8_t command, uint8_t* dest, uint8_t len);</div>
- <div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"></span></div>
- <div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> /// Write a number of consecutive bytes to a command using burst write mode</span></div>
- <div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> /// \param[in] command Command number of the first register, one of NRF24_COMMAND_*</span></div>
- <div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> /// \param[in] src Array of bytes to write. Must be at least len bytes</span></div>
- <div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> /// \param[in] len Number of bytes to write</span></div>
- <div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a01161d0ba54c409e62ad670b9eceb73d">spiBurstWrite</a>(uint8_t command, uint8_t* src, uint8_t len);</div>
- <div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"></span></div>
- <div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> /// Reads a single register from the NRF24</span></div>
- <div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> /// \param[in] reg Register number, one of NRF24_REG_*</span></div>
- <div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> /// \return The value of the register</span></div>
- <div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a264f427858362e106705d92152bc634e">spiReadRegister</a>(uint8_t reg);</div>
- <div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"></span></div>
- <div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> /// Writes a single byte to the NRF24, and at the ame time reads the current STATUS register</span></div>
- <div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> /// \param[in] reg Register number, one of NRF24_REG_*</span></div>
- <div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> /// \param[in] val The value to write</span></div>
- <div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> /// \return the current STATUS (read while the command is sent)</span></div>
- <div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a81931bc1679b213b1cb1ae65b8357985">spiWriteRegister</a>(uint8_t reg, uint8_t val);</div>
- <div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"></span></div>
- <div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> /// Reads a number of consecutive registers from the NRF24 using burst read mode</span></div>
- <div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> /// \param[in] reg Register number of the first register, one of NRF24_REG_*</span></div>
- <div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> /// \param[in] dest Array to write the register values to. Must be at least len bytes</span></div>
- <div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> /// \param[in] len Number of bytes to read</span></div>
- <div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classNRF24.html#abc48bb5a86d0bb498c753dc47cea8daa">spiBurstReadRegister</a>(uint8_t reg, uint8_t* dest, uint8_t len);</div>
- <div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"></span></div>
- <div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> /// Write a number of consecutive registers using burst write mode</span></div>
- <div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> /// \param[in] reg Register number of the first register, one of NRF24_REG_*</span></div>
- <div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> /// \param[in] src Array of new register values to write. Must be at least len bytes</span></div>
- <div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> /// \param[in] len Number of bytes to write</span></div>
- <div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a8562055be6ba65ca8fc292be5f8abc5a">spiBurstWriteRegister</a>(uint8_t reg, uint8_t* src, uint8_t len);</div>
- <div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"></span></div>
- <div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> /// Reads and returns the device status register NRF24_REG_02_DEVICE_STATUS</span></div>
- <div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> /// \return The value of the device status register</span></div>
- <div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a9940479d33d554cab35d50b99112a166">statusRead</a>();</div>
- <div class="line"><a name="l00539"></a><span class="lineno"> 539</span>  <span class="comment"></span></div>
- <div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> /// Flush the TX FIFOs</span></div>
- <div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a644f3b4fd446438fb340b52df4216ba9">flushTx</a>();</div>
- <div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"></span></div>
- <div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> /// Flush the RX FIFOs</span></div>
- <div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> /// \return the value of the device status register</span></div>
- <div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"></span> uint8_t <a class="code" href="classNRF24.html#a9d3d0d432b09d3403a52aa9a78d3f848">flushRx</a>();</div>
- <div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"></span></div>
- <div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> /// Sets the transmit and receive channel number.</span></div>
- <div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> /// The frequency used is (2400 + channel) MHz</span></div>
- <div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a3fa90005f98eb2744a533899f9b7e023">setChannel</a>(uint8_t channel);</div>
- <div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"></span></div>
- <div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> /// Sets the chip configuration that will be used to set</span></div>
- <div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> /// the NRF24 NRF24_REG_00_CONFIG register. This allows you to change some</span></div>
- <div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> /// chip configuration for compatibility with libraries other than this one.</span></div>
- <div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> /// You should not normally need to call this.</span></div>
- <div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> /// Defaults to NRF24_EN_CRC, which is the standard configuraiton for this library.</span></div>
- <div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> /// \param[in] configuration The chip configuration to be used.</span></div>
- <div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a790d69e5cb1039fb2924f9405e30e250">setConfiguration</a>(uint8_t configuration);</div>
- <div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"></span></div>
- <div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> /// Sets the first len bytes of the address for the given NRF24 receiver pipe</span></div>
- <div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> /// This is an internal function and is not normally used by appications, but</span></div>
- <div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> /// can be used for specialised applications.</span></div>
- <div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> /// \param[in] pipe The index of the pipe to set, from 0 to 5</span></div>
- <div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> /// \param[in] address The new address for receiving. Must match the transmit address </span></div>
- <div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment"> /// of the transmitting node</span></div>
- <div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"> /// \param[in] len Number of bytes of receive address to set.</span></div>
- <div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a28b29969592f9f59c267ae7ffa020b2b">setPipeAddress</a>(uint8_t pipe, uint8_t* address, uint8_t len);</div>
- <div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"></span></div>
- <div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> /// Set the Auto Retransmit Delay and Auto Retransmit Count</span></div>
- <div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> /// for Auto retransmission (ART). See section 7.4.2 in the NRF24 documentation</span></div>
- <div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> /// It may be very important to set an appropriate delay and count</span></div>
- <div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> /// for your application, especially with</span></div>
- <div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> /// 250kbps (i.e. slow) data rate. The defaults are OK for faster data rates. If</span></div>
- <div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> /// the delay is too short, the symptoms wil be unreliable transmission, or tranmsission failures</span></div>
- <div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> /// \param[in] delay The number of 250 microsecond intervals to wait for an ACK.</span></div>
- <div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> /// \param[in] count The number of retries to us.</span></div>
- <div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a1ac9bfce3833725b8b66d9875a8bc00e">setRetry</a>(uint8_t delay, uint8_t count = 3);</div>
- <div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"></span></div>
- <div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> /// Sets the first len bytes of the address of this node</span></div>
- <div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> /// Normally len is the same length as setAddressLength, but can be smaller in order to set the</span></div>
- <div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> /// least significant bytes of the address</span></div>
- <div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> /// \param[in] address The new address for receiving. Must match the setTransmitAddress of the transmitting node.</span></div>
- <div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> /// \param[in] len Number of bytes of receive address to set.</span></div>
- <div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#ade21e0bd4f92d0dfa45909bbbb0e4b01">setThisAddress</a>(uint8_t* address, uint8_t len);</div>
- <div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment"></span></div>
- <div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> /// Sets the next transmit address</span></div>
- <div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> /// \param[in] address The new address for transmitting. Must match the setThisAddress of the receiving node.</span></div>
- <div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> /// \param[in] len Number of bytes of receive address to set.</span></div>
- <div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a7b40c4c481bddf343acdac5179fddc75">setTransmitAddress</a>(uint8_t* address, uint8_t len);</div>
- <div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"></span></div>
- <div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> /// Sets the number of bytes transmitted </span></div>
- <div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> /// in each payload</span></div>
- <div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> /// \param[in] size Size of the transmitted payload in bytes</span></div>
- <div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#adb2fbd1d1aadaad1e9b268508149b6c8">setPayloadSize</a>(uint8_t size);</div>
- <div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"></span></div>
- <div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> /// Sets the data rate and tranmitter power to use</span></div>
- <div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> /// \param [in] data_rate The data rate to use for all packets transmitted and received. One of NRF24DataRate</span></div>
- <div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> /// \param [in] power Transmitter power. One of NRF24TransmitPower.</span></div>
- <div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a3453db8390d5be4aa99d8c7fde3062a4">setRF</a>(uint8_t data_rate, uint8_t power);</div>
- <div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"></span></div>
- <div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> /// Sets the radio in power down mode.</span></div>
- <div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> /// Sets chip enable to LOW.</span></div>
- <div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a5f40f4c8dcb3b5e097510dc6396c7f9b">powerDown</a>();</div>
- <div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"></span></div>
- <div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> /// Sets the radio in RX mode.</span></div>
- <div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"> /// Sets chip enable to HIGH to enable the chip in RX mode.</span></div>
- <div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a9e15babbfa487da3425b19c60a93c057">powerUpRx</a>();</div>
- <div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"></span></div>
- <div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> /// Sets the radio in TX mode.</span></div>
- <div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> /// Pulses the chip enable LOW then HIGH to enable the chip in TX mode.</span></div>
- <div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a796cb1901211284a958197d657d6f164">powerUpTx</a>();</div>
- <div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"></span></div>
- <div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> /// Sends data to the address set by setTransmitAddress()</span></div>
- <div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> /// Sets the radio to TX mode</span></div>
- <div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> /// \param [in] data Data bytes to send.</span></div>
- <div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> /// \param [in] len Number of data bytes to set in teh TX buffer. The actual size of the </span></div>
- <div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> /// transmitted data payload is set by setPayloadSize</span></div>
- <div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> /// \param [in] noack Optional parameter if true sends the message NOACK mode. Requires that the NOACK feature be </span></div>
- <div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> /// enabled with spiWriteRegister(NRF24_REG_1D_FEATURE, NRF24_EN_DYN_ACK);</span></div>
- <div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#aad280539b80b28e55ab3187714bc7f2f">send</a>(uint8_t* data, uint8_t len, <span class="keywordtype">boolean</span> noack = <span class="keyword">false</span>);</div>
- <div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"></span></div>
- <div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment"> /// Blocks until the current message (if any) </span></div>
- <div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment"> /// has been transmitted</span></div>
- <div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> /// \return true on success, false if the Max retries were exceeded, or if the chip is not in transmit mode.</span></div>
- <div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a78a011cddedb14b8764ad5ea760c28ae">waitPacketSent</a>();</div>
- <div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"></span></div>
- <div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> /// Indicates if the chip is in transmit mode and </span></div>
- <div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> /// there is a packet currently being transmitted</span></div>
- <div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> /// \return true if the chip is in transmit mode and there is a transmission in progress</span></div>
- <div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#aaff7453d951c74e87ca845e708742252">isSending</a>();</div>
- <div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"></span></div>
- <div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment"> /// Prints the value of all chip registers</span></div>
- <div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> /// for debugging purposes</span></div>
- <div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"> /// \return true on success</span></div>
- <div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#ab6b14a05c78e40f0491793dcb73c8274">printRegisters</a>();</div>
- <div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"></span></div>
- <div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"> /// Checks whether a received message is available.</span></div>
- <div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"> /// This can be called multiple times in a timeout loop</span></div>
- <div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> /// \return true if a complete, valid message has been received and is able to be retrieved by</span></div>
- <div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> /// recv()</span></div>
- <div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a84a25d5654902ed6b69d3a0de9422cfd">available</a>();</div>
- <div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"></span></div>
- <div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> /// Starts the receiver and blocks until a valid received </span></div>
- <div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> /// message is available.</span></div>
- <div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classNRF24.html#a5260f3e5eeb911e720290e652f628ab5">waitAvailable</a>();</div>
- <div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"></span></div>
- <div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> /// Starts the receiver and blocks until a received message is available or a timeout</span></div>
- <div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> /// \param[in] timeout Maximum time to wait in milliseconds.</span></div>
- <div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> /// \return true if a message is available</span></div>
- <div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classNRF24.html#ae36ca859ea942a6e9480e8747a27921e">waitAvailableTimeout</a>(uint16_t timeout);</div>
- <div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"></span></div>
- <div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> /// Turns the receiver on if it not already on.</span></div>
- <div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> /// If there is a valid message available, copy it to buf and return true</span></div>
- <div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> /// else return false.</span></div>
- <div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> /// If a message is copied, *len is set to the length (Caution, 0 length messages are permitted).</span></div>
- <div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> /// You should be sure to call this function frequently enough to not miss any messages</span></div>
- <div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> /// It is recommended that you call it in your main loop.</span></div>
- <div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> /// \param[in] buf Location to copy the received message</span></div>
- <div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> /// \param[in,out] len Pointer to available space in buf. Set to the actual number of octets copied.</span></div>
- <div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> /// \return true if a valid message was copied to buf</span></div>
- <div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="classNRF24.html#a12799e0afcb52f2a8cb7418dca9e0eab">recv</a>(uint8_t* buf, uint8_t* len);</div>
- <div class="line"><a name="l00674"></a><span class="lineno"> 674</span> </div>
- <div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="keyword">protected</span>:</div>
- <div class="line"><a name="l00676"></a><span class="lineno"> 676</span> </div>
- <div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="keyword">private</span>:</div>
- <div class="line"><a name="l00678"></a><span class="lineno"> 678</span>  uint8_t _configuration;</div>
- <div class="line"><a name="l00679"></a><span class="lineno"> 679</span>  uint8_t _chipEnablePin;</div>
- <div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  uint8_t _chipSelectPin;</div>
- <div class="line"><a name="l00681"></a><span class="lineno"> 681</span> };</div>
- <div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment"></span></div>
- <div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment">/// @example nrf24_audio_rx.pde</span></div>
- <div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment">/// Example sketch showing how to create an audio digital receiver</span></div>
- <div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment">/// with the NRF24 class. </span></div>
- <div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment">/// Works with the nrf24_audio_tx sample transmitter</span></div>
- <div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment">/// Connect audio output to pin 6, through a low pass filter consisting of a 1k resistor in series followed by a </span></div>
- <div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment">/// 0.0033 microfarad capacitor to ground (48kHz filter).</span></div>
- <div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment">/// The audio quality is poor: dont expect hi-fi!</span></div>
- <div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment">/// We have to change the PWM frequency to 62 kHz so we can get bandwidth reasonable </span></div>
- <div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment">/// audio out through the low pass filter</span></div>
- <div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment">/// Tested on UNO</span></div>
- <div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment">/// @example nrf24_audio_tx.pde</span></div>
- <div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment">/// Example sketch showing how to create an audio digital transmitter </span></div>
- <div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment">/// with the NRF24 class. </span></div>
- <div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment">/// Connect a 1Vp-p audio sigal to analog input 0, connected through a 1uF capacitor</span></div>
- <div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment">/// Works with the nrf24_audio_rx sample receiver</span></div>
- <div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment">/// The audio quality is poor: dont expect hi-fi!</span></div>
- <div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment">///</span></div>
- <div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment">/// This code sends about 250 messages per second, each with 32 8 bit samples from analog input 0</span></div>
- <div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment">/// It uses the NRF4 in NOACK mode. The receiver never acknowledges or replies</span></div>
- <div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment">/// Tested on UNO</span></div>
- <div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment">/// @example nrf24_ping_client.pde</span></div>
- <div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment">/// Example sketch showing how to create a simple messageing client</span></div>
- <div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment">/// with the NRF24 class. </span></div>
- <div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment">/// It is designed to work with the example nrf24_ping_server</span></div>
- <div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment">/// It also works with ping_server from the Mirf library</span></div>
- <div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment">/// @example nrf24_ping_server.pde</span></div>
- <div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment">/// Example sketch showing how to create a simple messageing server</span></div>
- <div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment">/// with the NRF24 class. </span></div>
- <div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment">/// It is designed to work with the example nrf24_ping_client. </span></div>
- <div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment">/// It also works with ping_client from the Mirf library</span></div>
- <div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment">/// @example nrf24_specan.pde</span></div>
- <div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment">/// Example sketch showing how to create a primitive spectrum analyser</span></div>
- <div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment">/// with the NRF24 class. </span></div>
- <div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment">/// The nRF24L01 received power detector is only one bit, but</span></div>
- <div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment">/// this will show which channels have more than -64dBm present</span></div>
- <div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment">/// @example nrf24_test.pde</span></div>
- <div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment">/// Test suite for the NRF24 class. </span></div>
- <div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment">/// @example crazyflie.ino</span></div>
- <div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment">/// This sketch act like a Crazyflie quadcopter http://www.bitcraze.se/</span></div>
- <div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment">/// using the CRTP radiolink protocol:</span></div>
- <div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment">/// http://wiki.bitcraze.se/projects:crazyflie:firmware:comm_protocol</span></div>
- <div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment"></span><span class="comment"></span></div>
- <div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment">/// @example crazyflie_client.ino</span></div>
- <div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment">/// This sketch act like a Crazyflie client (ie the transmitter) using the CRTP radiolink protocol:</span></div>
- <div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment">/// http://wiki.bitcraze.se/projects:crazyflie:firmware:comm_protocol</span></div>
- <div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment">/// to control a Crazyflie quadcopter http://www.bitcraze.se/</span></div>
- <div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment">/// using a RC transmitter in trainer mode, such as the Spektrum DX6i and others.</span></div>
- <div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"></span><span class="preprocessor">#endif </span></div>
- <div class="ttc" id="classNRF24_html_ab0eb09c01f73bee4ff6935c0503a8ace"><div class="ttname"><a href="classNRF24.html#ab0eb09c01f73bee4ff6935c0503a8ace">NRF24::NRF24</a></div><div class="ttdeci">NRF24(uint8_t chipEnablePin=8, uint8_t chipSelectPin=SS)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:9</div></div>
- <div class="ttc" id="classNRF24_html_abc48bb5a86d0bb498c753dc47cea8daa"><div class="ttname"><a href="classNRF24.html#abc48bb5a86d0bb498c753dc47cea8daa">NRF24::spiBurstReadRegister</a></div><div class="ttdeci">void spiBurstReadRegister(uint8_t reg, uint8_t *dest, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:112</div></div>
- <div class="ttc" id="classNRF24_html_a52d7af9188397d4a6f5dab55d4f04742ae4523002495ee537f2731b61a220e3af"><div class="ttname"><a href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742ae4523002495ee537f2731b61a220e3af">NRF24::NRF24DataRate250kbps</a></div><div class="ttdoc">250 kbps </div><div class="ttdef"><b>Definition:</b> NRF24.h:446</div></div>
- <div class="ttc" id="classNRF24_html_a1ac9bfce3833725b8b66d9875a8bc00e"><div class="ttname"><a href="classNRF24.html#a1ac9bfce3833725b8b66d9875a8bc00e">NRF24::setRetry</a></div><div class="ttdeci">boolean setRetry(uint8_t delay, uint8_t count=3)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:154</div></div>
- <div class="ttc" id="classNRF24_html_aad280539b80b28e55ab3187714bc7f2f"><div class="ttname"><a href="classNRF24.html#aad280539b80b28e55ab3187714bc7f2f">NRF24::send</a></div><div class="ttdeci">boolean send(uint8_t *data, uint8_t len, boolean noack=false)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:225</div></div>
- <div class="ttc" id="classNRF24_html_a8386e81a9a4b824ab26e785879684c7eacce8a36a9753c7c125ad6db450ddfff8"><div class="ttname"><a href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacce8a36a9753c7c125ad6db450ddfff8">NRF24::NRF24TransmitPowerm12dBm</a></div><div class="ttdoc">-12 dBm </div><div class="ttdef"><b>Definition:</b> NRF24.h:455</div></div>
- <div class="ttc" id="classNRF24_html_a81931bc1679b213b1cb1ae65b8357985"><div class="ttname"><a href="classNRF24.html#a81931bc1679b213b1cb1ae65b8357985">NRF24::spiWriteRegister</a></div><div class="ttdeci">uint8_t spiWriteRegister(uint8_t reg, uint8_t val)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:107</div></div>
- <div class="ttc" id="classNRF24_html_aaff7453d951c74e87ca845e708742252"><div class="ttname"><a href="classNRF24.html#aaff7453d951c74e87ca845e708742252">NRF24::isSending</a></div><div class="ttdeci">boolean isSending()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:253</div></div>
- <div class="ttc" id="classNRF24_html_a08ae66610a928a779c0b256e782128b5"><div class="ttname"><a href="classNRF24.html#a08ae66610a928a779c0b256e782128b5">NRF24::spiCommand</a></div><div class="ttdeci">uint8_t spiCommand(uint8_t command)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:54</div></div>
- <div class="ttc" id="classNRF24_html_a84a25d5654902ed6b69d3a0de9422cfd"><div class="ttname"><a href="classNRF24.html#a84a25d5654902ed6b69d3a0de9422cfd">NRF24::available</a></div><div class="ttdeci">boolean available()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:272</div></div>
- <div class="ttc" id="classNRF24_html_a12799e0afcb52f2a8cb7418dca9e0eab"><div class="ttname"><a href="classNRF24.html#a12799e0afcb52f2a8cb7418dca9e0eab">NRF24::recv</a></div><div class="ttdeci">boolean recv(uint8_t *buf, uint8_t *len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:305</div></div>
- <div class="ttc" id="classNRF24_html_a8386e81a9a4b824ab26e785879684c7ea4790420d436218aa3bf4c23687664853"><div class="ttname"><a href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7ea4790420d436218aa3bf4c23687664853">NRF24::NRF24TransmitPowerm18dBm</a></div><div class="ttdoc">-18 dBm </div><div class="ttdef"><b>Definition:</b> NRF24.h:454</div></div>
- <div class="ttc" id="classNRF24_html_a644f3b4fd446438fb340b52df4216ba9"><div class="ttname"><a href="classNRF24.html#a644f3b4fd446438fb340b52df4216ba9">NRF24::flushTx</a></div><div class="ttdeci">uint8_t flushTx()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:128</div></div>
- <div class="ttc" id="classNRF24_html_a16f168ffe059120ba696936cd6bd76f1"><div class="ttname"><a href="classNRF24.html#a16f168ffe059120ba696936cd6bd76f1">NRF24::spiWrite</a></div><div class="ttdeci">uint8_t spiWrite(uint8_t command, uint8_t val)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:72</div></div>
- <div class="ttc" id="classNRF24_html_a9d3d0d432b09d3403a52aa9a78d3f848"><div class="ttname"><a href="classNRF24.html#a9d3d0d432b09d3403a52aa9a78d3f848">NRF24::flushRx</a></div><div class="ttdeci">uint8_t flushRx()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:133</div></div>
- <div class="ttc" id="classNRF24_html_a264f427858362e106705d92152bc634e"><div class="ttname"><a href="classNRF24.html#a264f427858362e106705d92152bc634e">NRF24::spiReadRegister</a></div><div class="ttdeci">uint8_t spiReadRegister(uint8_t reg)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:102</div></div>
- <div class="ttc" id="classNRF24_html_a8386e81a9a4b824ab26e785879684c7eacef1d6c037e276e6dadaff2b6056ec0c"><div class="ttname"><a href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacef1d6c037e276e6dadaff2b6056ec0c">NRF24::NRF24TransmitPower0dBm</a></div><div class="ttdoc">0 dBm </div><div class="ttdef"><b>Definition:</b> NRF24.h:457</div></div>
- <div class="ttc" id="classNRF24_html_ae36ca859ea942a6e9480e8747a27921e"><div class="ttname"><a href="classNRF24.html#ae36ca859ea942a6e9480e8747a27921e">NRF24::waitAvailableTimeout</a></div><div class="ttdeci">bool waitAvailableTimeout(uint16_t timeout)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:295</div></div>
- <div class="ttc" id="classNRF24_html_a52d7af9188397d4a6f5dab55d4f04742a774c99f9cf1c98cb883d4a01c1444c52"><div class="ttname"><a href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742a774c99f9cf1c98cb883d4a01c1444c52">NRF24::NRF24DataRate1Mbps</a></div><div class="ttdoc">1 Mbps </div><div class="ttdef"><b>Definition:</b> NRF24.h:444</div></div>
- <div class="ttc" id="classNRF24_html_a3fa90005f98eb2744a533899f9b7e023"><div class="ttname"><a href="classNRF24.html#a3fa90005f98eb2744a533899f9b7e023">NRF24::setChannel</a></div><div class="ttdeci">boolean setChannel(uint8_t channel)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:138</div></div>
- <div class="ttc" id="classNRF24_html_a8562055be6ba65ca8fc292be5f8abc5a"><div class="ttname"><a href="classNRF24.html#a8562055be6ba65ca8fc292be5f8abc5a">NRF24::spiBurstWriteRegister</a></div><div class="ttdeci">uint8_t spiBurstWriteRegister(uint8_t reg, uint8_t *src, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:117</div></div>
- <div class="ttc" id="classNRF24_html_a5260f3e5eeb911e720290e652f628ab5"><div class="ttname"><a href="classNRF24.html#a5260f3e5eeb911e720290e652f628ab5">NRF24::waitAvailable</a></div><div class="ttdeci">void waitAvailable()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:285</div></div>
- <div class="ttc" id="classNRF24_html_a52d7af9188397d4a6f5dab55d4f04742aca0c89dd1b40bdc57b7026d8da54de9a"><div class="ttname"><a href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742aca0c89dd1b40bdc57b7026d8da54de9a">NRF24::NRF24DataRate2Mbps</a></div><div class="ttdoc">2 Mbps </div><div class="ttdef"><b>Definition:</b> NRF24.h:445</div></div>
- <div class="ttc" id="classNRF24_html_a8386e81a9a4b824ab26e785879684c7e"><div class="ttname"><a href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7e">NRF24::NRF24TransmitPower</a></div><div class="ttdeci">NRF24TransmitPower</div><div class="ttdoc">Convenient values for setting transmitter power in setRF() These are designed to agree with the value...</div><div class="ttdef"><b>Definition:</b> NRF24.h:452</div></div>
- <div class="ttc" id="classNRF24_html_a448aad6cda19f068009106aa5f6a7e6a"><div class="ttname"><a href="classNRF24.html#a448aad6cda19f068009106aa5f6a7e6a">NRF24::spiBurstRead</a></div><div class="ttdeci">void spiBurstRead(uint8_t command, uint8_t *dest, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:81</div></div>
- <div class="ttc" id="classNRF24_html_ab2f002c33ec719dfdd3ae70d70559254"><div class="ttname"><a href="classNRF24.html#ab2f002c33ec719dfdd3ae70d70559254">NRF24::spiRead</a></div><div class="ttdeci">uint8_t spiRead(uint8_t command)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:63</div></div>
- <div class="ttc" id="classNRF24_html_a01161d0ba54c409e62ad670b9eceb73d"><div class="ttname"><a href="classNRF24.html#a01161d0ba54c409e62ad670b9eceb73d">NRF24::spiBurstWrite</a></div><div class="ttdeci">uint8_t spiBurstWrite(uint8_t command, uint8_t *src, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:91</div></div>
- <div class="ttc" id="classNRF24_html_a78a011cddedb14b8764ad5ea760c28ae"><div class="ttname"><a href="classNRF24.html#a78a011cddedb14b8764ad5ea760c28ae">NRF24::waitPacketSent</a></div><div class="ttdeci">boolean waitPacketSent()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:233</div></div>
- <div class="ttc" id="classNRF24_html_a5f40f4c8dcb3b5e097510dc6396c7f9b"><div class="ttname"><a href="classNRF24.html#a5f40f4c8dcb3b5e097510dc6396c7f9b">NRF24::powerDown</a></div><div class="ttdeci">boolean powerDown()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:202</div></div>
- <div class="ttc" id="classNRF24_html_a28b29969592f9f59c267ae7ffa020b2b"><div class="ttname"><a href="classNRF24.html#a28b29969592f9f59c267ae7ffa020b2b">NRF24::setPipeAddress</a></div><div class="ttdeci">boolean setPipeAddress(uint8_t pipe, uint8_t *address, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:148</div></div>
- <div class="ttc" id="classNRF24_html_ab6b14a05c78e40f0491793dcb73c8274"><div class="ttname"><a href="classNRF24.html#ab6b14a05c78e40f0491793dcb73c8274">NRF24::printRegisters</a></div><div class="ttdeci">boolean printRegisters()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:258</div></div>
- <div class="ttc" id="classNRF24_html_a3453db8390d5be4aa99d8c7fde3062a4"><div class="ttname"><a href="classNRF24.html#a3453db8390d5be4aa99d8c7fde3062a4">NRF24::setRF</a></div><div class="ttdeci">boolean setRF(uint8_t data_rate, uint8_t power)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:183</div></div>
- <div class="ttc" id="classNRF24_html_a52d7af9188397d4a6f5dab55d4f04742"><div class="ttname"><a href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742">NRF24::NRF24DataRate</a></div><div class="ttdeci">NRF24DataRate</div><div class="ttdoc">Defines convenient values for setting data rates in setRF() </div><div class="ttdef"><b>Definition:</b> NRF24.h:442</div></div>
- <div class="ttc" id="classNRF24_html"><div class="ttname"><a href="classNRF24.html">NRF24</a></div><div class="ttdoc">Send and receive addressed, reliable, acknowledged datagrams by nRF24L01. </div><div class="ttdef"><b>Definition:</b> NRF24.h:437</div></div>
- <div class="ttc" id="classNRF24_html_a796cb1901211284a958197d657d6f164"><div class="ttname"><a href="classNRF24.html#a796cb1901211284a958197d657d6f164">NRF24::powerUpTx</a></div><div class="ttdeci">boolean powerUpTx()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:216</div></div>
- <div class="ttc" id="classNRF24_html_a9e15babbfa487da3425b19c60a93c057"><div class="ttname"><a href="classNRF24.html#a9e15babbfa487da3425b19c60a93c057">NRF24::powerUpRx</a></div><div class="ttdeci">boolean powerUpRx()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:209</div></div>
- <div class="ttc" id="classNRF24_html_a9940479d33d554cab35d50b99112a166"><div class="ttname"><a href="classNRF24.html#a9940479d33d554cab35d50b99112a166">NRF24::statusRead</a></div><div class="ttdeci">uint8_t statusRead()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:122</div></div>
- <div class="ttc" id="classNRF24_html_adb2fbd1d1aadaad1e9b268508149b6c8"><div class="ttname"><a href="classNRF24.html#adb2fbd1d1aadaad1e9b268508149b6c8">NRF24::setPayloadSize</a></div><div class="ttdeci">boolean setPayloadSize(uint8_t size)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:176</div></div>
- <div class="ttc" id="classNRF24_html_a6e98cf508939240c1805245170a995f6"><div class="ttname"><a href="classNRF24.html#a6e98cf508939240c1805245170a995f6">NRF24::init</a></div><div class="ttdeci">boolean init()</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:16</div></div>
- <div class="ttc" id="classNRF24_html_ade21e0bd4f92d0dfa45909bbbb0e4b01"><div class="ttname"><a href="classNRF24.html#ade21e0bd4f92d0dfa45909bbbb0e4b01">NRF24::setThisAddress</a></div><div class="ttdeci">boolean setThisAddress(uint8_t *address, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:160</div></div>
- <div class="ttc" id="classNRF24_html_a790d69e5cb1039fb2924f9405e30e250"><div class="ttname"><a href="classNRF24.html#a790d69e5cb1039fb2924f9405e30e250">NRF24::setConfiguration</a></div><div class="ttdeci">boolean setConfiguration(uint8_t configuration)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:143</div></div>
- <div class="ttc" id="classNRF24_html_a8386e81a9a4b824ab26e785879684c7eaf8351d714335d0c24bcbb8d3c983d5c7"><div class="ttname"><a href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eaf8351d714335d0c24bcbb8d3c983d5c7">NRF24::NRF24TransmitPowerm6dBm</a></div><div class="ttdoc">-6 dBm </div><div class="ttdef"><b>Definition:</b> NRF24.h:456</div></div>
- <div class="ttc" id="classNRF24_html_a7b40c4c481bddf343acdac5179fddc75"><div class="ttname"><a href="classNRF24.html#a7b40c4c481bddf343acdac5179fddc75">NRF24::setTransmitAddress</a></div><div class="ttdeci">boolean setTransmitAddress(uint8_t *address, uint8_t len)</div><div class="ttdef"><b>Definition:</b> NRF24.cpp:168</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.5
- </small></address>
- </body>
- </html>
|