nrf24_ping_client_8pde-example.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.5"/>
  7. <title>NRF24: nrf24_ping_client.pde</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">NRF24
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.5 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="annotated.html"><span>Classes</span></a></li>
  33. <li><a href="files.html"><span>Files</span></a></li>
  34. <li><a href="examples.html"><span>Examples</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="headertitle">
  40. <div class="title">nrf24_ping_client.pde</div> </div>
  41. </div><!--header-->
  42. <div class="contents">
  43. <p>Example sketch showing how to create a simple messageing client with the <a class="el" href="classNRF24.html" title="Send and receive addressed, reliable, acknowledged datagrams by nRF24L01. ">NRF24</a> class. It is designed to work with the example nrf24_ping_server It also works with ping_server from the Mirf library</p>
  44. <div class="fragment"><div class="line"><span class="comment">// nrf24_ping_client.pde</span></div>
  45. <div class="line"><span class="comment">// -*- mode: C++ -*-</span></div>
  46. <div class="line"><span class="comment">// Example sketch showing how to create a simple messageing client</span></div>
  47. <div class="line"><span class="comment">// with the NRF24 class. </span></div>
  48. <div class="line"><span class="comment">// It is designed to work with the example nrf24_ping_server</span></div>
  49. <div class="line"><span class="comment">// It also works with ping_server from the Mirf library</span></div>
  50. <div class="line"></div>
  51. <div class="line"><span class="preprocessor">#include &lt;NRF24.h&gt;</span></div>
  52. <div class="line"><span class="preprocessor">#include &lt;SPI.h&gt;</span></div>
  53. <div class="line"></div>
  54. <div class="line"></div>
  55. <div class="line"><span class="comment">// Singleton instance of the radio</span></div>
  56. <div class="line"><a name="_a0"></a><a class="code" href="classNRF24.html">NRF24</a> nrf24;</div>
  57. <div class="line"><span class="comment">// NRF24 nrf24(8, 7); // use this to be electrically compatible with Mirf</span></div>
  58. <div class="line"><span class="comment">// NRF24 nrf24(8, 10);// For Leonardo, need explicit SS pin</span></div>
  59. <div class="line"></div>
  60. <div class="line"><span class="keywordtype">void</span> setup() </div>
  61. <div class="line">{</div>
  62. <div class="line"> Serial.begin(9600);</div>
  63. <div class="line"></div>
  64. <div class="line"> <span class="keywordflow">while</span> (!Serial) </div>
  65. <div class="line"> ; <span class="comment">// wait for serial port to connect. Needed for Leonardo only</span></div>
  66. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a1"></a><a class="code" href="classNRF24.html#a6e98cf508939240c1805245170a995f6">init</a>())</div>
  67. <div class="line"> Serial.println(<span class="stringliteral">&quot;NRF24 init failed&quot;</span>);</div>
  68. <div class="line"> <span class="comment">// Defaults after init are 2.402 GHz (channel 2)</span></div>
  69. <div class="line"> <span class="comment">// Now be compatible with Mirf ping_server</span></div>
  70. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a2"></a><a class="code" href="classNRF24.html#a3fa90005f98eb2744a533899f9b7e023">setChannel</a>(1))</div>
  71. <div class="line"> Serial.println(<span class="stringliteral">&quot;setChannel failed&quot;</span>);</div>
  72. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a3"></a><a class="code" href="classNRF24.html#ade21e0bd4f92d0dfa45909bbbb0e4b01">setThisAddress</a>((uint8_t*)<span class="stringliteral">&quot;clie1&quot;</span>, 5))</div>
  73. <div class="line"> Serial.println(<span class="stringliteral">&quot;setThisAddress failed&quot;</span>);</div>
  74. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a4"></a><a class="code" href="classNRF24.html#adb2fbd1d1aadaad1e9b268508149b6c8">setPayloadSize</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>)))</div>
  75. <div class="line"> Serial.println(<span class="stringliteral">&quot;setPayloadSize failed&quot;</span>);</div>
  76. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a5"></a><a class="code" href="classNRF24.html#a3453db8390d5be4aa99d8c7fde3062a4">setRF</a>(<a name="a6"></a><a class="code" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742aca0c89dd1b40bdc57b7026d8da54de9a">NRF24::NRF24DataRate2Mbps</a>, <a name="a7"></a><a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacef1d6c037e276e6dadaff2b6056ec0c">NRF24::NRF24TransmitPower0dBm</a>))</div>
  77. <div class="line"> Serial.println(<span class="stringliteral">&quot;setRF failed&quot;</span>); </div>
  78. <div class="line"></div>
  79. <div class="line"> Serial.println(<span class="stringliteral">&quot;initialised&quot;</span>);</div>
  80. <div class="line">}</div>
  81. <div class="line"></div>
  82. <div class="line"><span class="comment">// With printing commented and delay removed, this can achieve about 666 round trips per second</span></div>
  83. <div class="line"><span class="keywordtype">void</span> loop()</div>
  84. <div class="line">{</div>
  85. <div class="line"><span class="comment">// Serial.println(&quot;send&quot;);</span></div>
  86. <div class="line"> </div>
  87. <div class="line"> <span class="comment">// Send some data to the server</span></div>
  88. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a8"></a><a class="code" href="classNRF24.html#a7b40c4c481bddf343acdac5179fddc75">setTransmitAddress</a>((uint8_t*)<span class="stringliteral">&quot;serv1&quot;</span>, 5))</div>
  89. <div class="line"> Serial.println(<span class="stringliteral">&quot;setTransmitAddress failed&quot;</span>);</div>
  90. <div class="line"></div>
  91. <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> time = millis();</div>
  92. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a9"></a><a class="code" href="classNRF24.html#aad280539b80b28e55ab3187714bc7f2f">send</a>((uint8_t*)&amp;time, <span class="keyword">sizeof</span>(time)))</div>
  93. <div class="line"> Serial.println(<span class="stringliteral">&quot;send failed&quot;</span>); </div>
  94. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a10"></a><a class="code" href="classNRF24.html#a78a011cddedb14b8764ad5ea760c28ae">waitPacketSent</a>())</div>
  95. <div class="line"> Serial.println(<span class="stringliteral">&quot;waitPacketSent failed&quot;</span>); </div>
  96. <div class="line"><span class="comment">// Serial.println(&quot;Sent&quot;); </span></div>
  97. <div class="line"> </div>
  98. <div class="line"> <span class="keywordflow">if</span> (nrf24.<a name="a11"></a><a class="code" href="classNRF24.html#ae36ca859ea942a6e9480e8747a27921e">waitAvailableTimeout</a>(100))</div>
  99. <div class="line"> {</div>
  100. <div class="line"> <span class="comment">// Server should send the same time back to us</span></div>
  101. <div class="line"></div>
  102. <div class="line"> <span class="comment">// Serial.println(&quot;available&quot;);</span></div>
  103. <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> data;</div>
  104. <div class="line"> uint8_t len = <span class="keyword">sizeof</span>(data);</div>
  105. <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a12"></a><a class="code" href="classNRF24.html#a12799e0afcb52f2a8cb7418dca9e0eab">recv</a>((uint8_t*)&amp;data, &amp;len))</div>
  106. <div class="line"> Serial.println(<span class="stringliteral">&quot;read failed&quot;</span>);</div>
  107. <div class="line"></div>
  108. <div class="line"> <span class="comment">// Compute the round trip time. This is the time to send one (acknowledged) message (with data) </span></div>
  109. <div class="line"> <span class="comment">// to the server and </span></div>
  110. <div class="line"> <span class="comment">// for the server to send one (acknowledged) reply (with data) back to us</span></div>
  111. <div class="line"> <span class="comment">// Typical reported RTT is 1- 2 ms</span></div>
  112. <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> rtt = millis() - data;</div>
  113. <div class="line"> Serial.print(<span class="stringliteral">&quot;Ping: &quot;</span>);</div>
  114. <div class="line"> Serial.println(rtt);</div>
  115. <div class="line"></div>
  116. <div class="line"> }</div>
  117. <div class="line"> <span class="keywordflow">else</span></div>
  118. <div class="line"> Serial.println(<span class="stringliteral">&quot;No reply from server&quot;</span>);</div>
  119. <div class="line"></div>
  120. <div class="line"> delay(1000); </div>
  121. <div class="line">}</div>
  122. <div class="line"></div>
  123. </div><!-- fragment --> </div><!-- contents -->
  124. <!-- start footer part -->
  125. <hr class="footer"/><address class="footer"><small>
  126. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  127. <img class="footer" src="doxygen.png" alt="doxygen"/>
  128. </a> 1.8.5
  129. </small></address>
  130. </body>
  131. </html>