| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- <!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: crazyflie.ino</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><a href="files.html"><span>Files</span></a></li>
- <li><a href="examples.html"><span>Examples</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">crazyflie.ino</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>This sketch act like a Crazyflie quadcopter <a href="http://www.bitcraze.se/">http://www.bitcraze.se/</a> using the CRTP radiolink protocol: <a href="http://wiki.bitcraze.se/projects:crazyflie:firmware:comm_protocol">http://wiki.bitcraze.se/projects:crazyflie:firmware:comm_protocol</a></p>
- <div class="fragment"><div class="line"><span class="comment">// crazyflie.pde</span></div>
- <div class="line"><span class="comment">// -*- mode: C++ -*-</span></div>
- <div class="line"><span class="comment">//</span></div>
- <div class="line"><span class="comment">// This sketch act like a Crazyflie quadcopter http://www.bitcraze.se/</span></div>
- <div class="line"><span class="comment">// using the CRTP radiolink protocol:</span></div>
- <div class="line"><span class="comment">// http://wiki.bitcraze.se/projects:crazyflie:firmware:comm_protocol</span></div>
- <div class="line"><span class="comment">//</span></div>
- <div class="line"><span class="comment">// Requires </span></div>
- <div class="line"><span class="comment">// - NRF24 radio module such as the sparkfun WRL-00691 http://www.sparkfun.com/products/691</span></div>
- <div class="line"><span class="comment">// - Arduino such as Uno</span></div>
- <div class="line"><span class="comment">// - A Crazyflie transmitter, such as the Carzyflie PC client+CrazyRadio module</span></div>
- <div class="line"><span class="comment">// or</span></div>
- <div class="line"><span class="comment">// the NRF24 crazyflie client part of the NRF24 library</span></div>
- <div class="line"><span class="comment">//</span></div>
- <div class="line"><span class="comment">// Uses NRF24 library to comunicate with the Crazyflie, </span></div>
- <div class="line"><span class="comment">// http://www.airspayce.com/mikem/arduino/NRF24</span></div>
- <div class="line"><span class="comment">//</span></div>
- <div class="line"><span class="comment">// Receives and decodes varion message types from teh Crazyflie transmitter, although</span></div>
- <div class="line"><span class="comment">// only the link echo and commander messages are fully implemented</span></div>
- <div class="line"><span class="comment">//</span></div>
- <div class="line"><span class="comment">// Author: Mike McCauley</span></div>
- <div class="line"><span class="comment">// Copyright (C) 2012 Mike McCauley</span></div>
- <div class="line"></div>
- <div class="line"><span class="preprocessor">#include <NRF24.h></span></div>
- <div class="line"><span class="preprocessor">#include <SPI.h></span></div>
- <div class="line"></div>
- <div class="line"><span class="comment">// Structure of Crazyflie commander messages</span></div>
- <div class="line"><span class="preprocessor">#pragma pack(1);</span></div>
- <div class="line"><span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">struct </span></div>
- <div class="line">{</div>
- <div class="line"> <span class="keywordtype">float</span> roll;</div>
- <div class="line"> <span class="keywordtype">float</span> pitch;</div>
- <div class="line"> <span class="keywordtype">float</span> yaw;</div>
- <div class="line"> uint16_t thrust;</div>
- <div class="line">} CommanderCrtpValues;</div>
- <div class="line"><span class="preprocessor">#pragma pack()</span></div>
- <div class="line"><span class="preprocessor"></span></div>
- <div class="line"><span class="comment">// Useful macros for CRTP message contents and formatting</span></div>
- <div class="line"><span class="preprocessor">#define CRTP_HEADER(port, channel) (((port & 0x0F) << 4) | (channel & 0x0F))</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define CRTP_HEADER_PORT(h) ((h >> 4) & 0xf)</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define CRTP_HEADER_CHANNEL(h) (h & 0x3)</span></div>
- <div class="line"><span class="preprocessor"></span></div>
- <div class="line"><span class="comment">// Param channels</span></div>
- <div class="line"><span class="preprocessor">#define PARAM_TOC_CH 0</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define PARAM_READ_CH 1</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define PARAM_WRITE_CH 2</span></div>
- <div class="line"><span class="preprocessor"></span></div>
- <div class="line"><span class="comment">// Log channels</span></div>
- <div class="line"><span class="preprocessor">#define LOG_TOC_CH 0</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define LOG_CONTROL_CH 1</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define LOG_LOG_CH 2</span></div>
- <div class="line"><span class="preprocessor"></span><span class="comment">// Log packet parameters storage</span></div>
- <div class="line"><span class="preprocessor">#define LOG_MAX_OPS 64</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define LOG_MAX_BLOCKS 8</span></div>
- <div class="line"><span class="preprocessor"></span></div>
- <div class="line"><span class="comment">// Port definitions</span></div>
- <div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
- <div class="line"> CRTP_PORT_CONSOLE = 0x00,</div>
- <div class="line"> CRTP_PORT_PARAM = 0x02,</div>
- <div class="line"> CRTP_PORT_COMMANDER = 0x03,</div>
- <div class="line"> CRTP_PORT_LOG = 0x05,</div>
- <div class="line"> CRTP_PORT_LINK = 0x0F,</div>
- <div class="line">} CRTPPort;</div>
- <div class="line"></div>
- <div class="line"><span class="comment">// Common command numbers</span></div>
- <div class="line"><span class="preprocessor">#define CMD_GET_ITEM 0</span></div>
- <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define CMD_GET_INFO 1</span></div>
- <div class="line"><span class="preprocessor"></span></div>
- <div class="line"><span class="comment">// Singleton instance of the radio</span></div>
- <div class="line"><a name="_a0"></a><a class="code" href="classNRF24.html">NRF24</a> nrf24;</div>
- <div class="line"><span class="comment">// NRF24 nrf24(8, 7); // use this to be electrically compatible with Mirf</span></div>
- <div class="line"><span class="comment">// NRF24 nrf24(8, 10);// For Leonardo, need explicit SS pin</span></div>
- <div class="line"></div>
- <div class="line"><span class="comment">// The address to use for this Crazyflie</span></div>
- <div class="line">uint8_t address[] = { 0xe7, 0xe7, 0xe7, 0xe7, 0xe7 };</div>
- <div class="line"></div>
- <div class="line"><span class="keywordtype">void</span> setup() </div>
- <div class="line">{</div>
- <div class="line"> Serial.begin(115200);</div>
- <div class="line"> <span class="keywordflow">while</span> (!Serial)</div>
- <div class="line"> ; <span class="comment">// Wait for serial port, only required for Leonardo</span></div>
- <div class="line"></div>
- <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a1"></a><a class="code" href="classNRF24.html#a6e98cf508939240c1805245170a995f6">init</a>())</div>
- <div class="line"> Serial.println(<span class="stringliteral">"NRF24 init failed"</span>);</div>
- <div class="line"></div>
- <div class="line"> <span class="comment">// Be Crazyflie radiolink compatible</span></div>
- <div class="line"> <span class="comment">// We use the NRF24 library for convenience, but</span></div>
- <div class="line"> <span class="comment">// we use a different configuration to the default NRF24</span></div>
- <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a2"></a><a class="code" href="classNRF24.html#a3fa90005f98eb2744a533899f9b7e023">setChannel</a>(13))</div>
- <div class="line"> Serial.println(<span class="stringliteral">"setChannel failed"</span>);</div>
- <div class="line"> <span class="comment">// Set data rate to 250k and low power</span></div>
- <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a3"></a><a class="code" href="classNRF24.html#a3453db8390d5be4aa99d8c7fde3062a4">setRF</a>(<a name="a4"></a><a class="code" href="classNRF24.html#a52d7af9188397d4a6f5dab55d4f04742ae4523002495ee537f2731b61a220e3af">NRF24::NRF24DataRate250kbps</a>, <a name="a5"></a><a class="code" href="classNRF24.html#a8386e81a9a4b824ab26e785879684c7eacef1d6c037e276e6dadaff2b6056ec0c">NRF24::NRF24TransmitPower0dBm</a>))</div>
- <div class="line"> Serial.println(<span class="stringliteral">"setRF failed"</span>); </div>
- <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a6"></a><a class="code" href="classNRF24.html#a28b29969592f9f59c267ae7ffa020b2b">setPipeAddress</a>(0, address, <span class="keyword">sizeof</span>(address)))</div>
- <div class="line"> Serial.println(<span class="stringliteral">"setPipeAddress failed"</span>); </div>
- <div class="line"> <span class="comment">// Be compatible with Crazyflie: No interrupts, 2 bytes CRC</span></div>
- <div class="line"> nrf24.<a name="a7"></a><a class="code" href="classNRF24.html#a790d69e5cb1039fb2924f9405e30e250">setConfiguration</a>(NRF24_MASK_RX_DR | NRF24_MASK_TX_DS | NRF24_MASK_MAX_RT | NRF24_EN_CRC | NRF24_CRCO);</div>
- <div class="line"> nrf24.<a name="a8"></a><a class="code" href="classNRF24.html#a81931bc1679b213b1cb1ae65b8357985">spiWriteRegister</a>(NRF24_REG_1D_FEATURE, NRF24_EN_DPL | NRF24_EN_ACK_PAY); <span class="comment">// Dynamic size payload + ack</span></div>
- <div class="line"> nrf24.<a class="code" href="classNRF24.html#a81931bc1679b213b1cb1ae65b8357985">spiWriteRegister</a>(NRF24_REG_1C_DYNPD, NRF24_DPL_P0); <span class="comment">// Dynamic payload on pipe 0</span></div>
- <div class="line"> <span class="keywordflow">if</span> (!nrf24.<a name="a9"></a><a class="code" href="classNRF24.html#a1ac9bfce3833725b8b66d9875a8bc00e">setRetry</a>(6, 3)) <span class="comment">// 1500us and 3 retries</span></div>
- <div class="line"> Serial.println(<span class="stringliteral">"setRetry failed"</span>); </div>
- <div class="line"></div>
- <div class="line"> Serial.println(<span class="stringliteral">"initialised"</span>);</div>
- <div class="line">}</div>
- <div class="line"></div>
- <div class="line"><span class="comment">// Debugging data dumper</span></div>
- <div class="line"><span class="keywordtype">void</span> dump(<span class="keywordtype">char</span>* prompt, uint8_t* data, uint8_t len)</div>
- <div class="line">{</div>
- <div class="line"> Serial.print(prompt);</div>
- <div class="line"> Serial.print(<span class="stringliteral">": "</span>); </div>
- <div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < len; i++)</div>
- <div class="line"> {</div>
- <div class="line"> Serial.print(data[i], HEX);</div>
- <div class="line"> Serial.print(<span class="stringliteral">" "</span>);</div>
- <div class="line"> }</div>
- <div class="line"> Serial.println(<span class="stringliteral">""</span>);</div>
- <div class="line">}</div>
- <div class="line"></div>
- <div class="line"><span class="comment">// Send an ACK with a payload on pipe 0</span></div>
- <div class="line"><span class="keywordtype">void</span> sendAckPayload(uint8_t* data, uint8_t len)</div>
- <div class="line">{</div>
- <div class="line"> nrf24.<a name="a10"></a><a class="code" href="classNRF24.html#a01161d0ba54c409e62ad670b9eceb73d">spiBurstWrite</a>(NRF24_COMMAND_W_ACK_PAYLOAD(0), data, len);</div>
- <div class="line"> nrf24.<a name="a11"></a><a class="code" href="classNRF24.html#a78a011cddedb14b8764ad5ea760c28ae">waitPacketSent</a>();</div>
- <div class="line">}</div>
- <div class="line"></div>
- <div class="line"><span class="comment">// ACK with no payload on pipe 0</span></div>
- <div class="line"><span class="keywordtype">void</span> sendAck()</div>
- <div class="line">{</div>
- <div class="line"> sendAckPayload(0, 0);</div>
- <div class="line">}</div>
- <div class="line"></div>
- <div class="line"><span class="keywordtype">void</span> loop()</div>
- <div class="line">{</div>
- <div class="line"> uint8_t buf[100];</div>
- <div class="line"> uint8_t buflen = <span class="keyword">sizeof</span>(buf);</div>
- <div class="line"> <span class="keyword">static</span> uint32_t last_second = 0;</div>
- <div class="line"> </div>
- <div class="line"> <span class="comment">// enable receiver again, after transmit and wait for a message</span></div>
- <div class="line"> nrf24.<a name="a12"></a><a class="code" href="classNRF24.html#a5260f3e5eeb911e720290e652f628ab5">waitAvailable</a>();</div>
- <div class="line"> <span class="keywordflow">if</span> (nrf24.<a name="a13"></a><a class="code" href="classNRF24.html#a12799e0afcb52f2a8cb7418dca9e0eab">recv</a>(buf, &buflen))</div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// Decode incoming messages from client based on port number in the header byte</span></div>
- <div class="line"> <span class="comment">// dump("msg", buf, buflen);</span></div>
- <div class="line"> <span class="keywordflow">if</span> (CRTP_HEADER_PORT(buf[0]) == CRTP_PORT_LINK) <span class="comment">// Link Echo</span></div>
- <div class="line"> {</div>
- <div class="line"> sendAck(); <span class="comment">// Just ack, no payload</span></div>
- <div class="line"> }</div>
- <div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (CRTP_HEADER_PORT(buf[0]) == CRTP_PORT_COMMANDER) <span class="comment">// Commander</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// Commander message to set control positions</span></div>
- <div class="line"> CommanderCrtpValues *p = (CommanderCrtpValues*)(buf+1);</div>
- <div class="line"> Serial.println(p->roll); <span class="comment">// -30.0 to 30.0</span></div>
- <div class="line"> Serial.println(p->pitch); <span class="comment">// -28.0 to 32.0</span></div>
- <div class="line"> Serial.println(p->yaw); <span class="comment">// -200.0 to 200.0</span></div>
- <div class="line"> Serial.println(p->thrust); <span class="comment">// 0 to 45755</span></div>
- <div class="line"> sendAck(); <span class="comment">// Just ack, no payload</span></div>
- <div class="line"><span class="comment">// dump("commander", buf, buflen);</span></div>
- <div class="line"> }</div>
- <div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (CRTP_HEADER_PORT(buf[0]) == CRTP_PORT_PARAM) <span class="comment">// Parameter</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="keywordflow">if</span> (buf[1] == CMD_GET_INFO) <span class="comment">// Param GET_INFO</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// pc client only fetches item data if the CRC changes</span></div>
- <div class="line"> <span class="comment">// If you change the contents of your TOC, you must change the CRC</span></div>
- <div class="line"> <span class="comment">// Crazyflie PC client doesnt relaly believe it if you say there are no TOC entries</span></div>
- <div class="line"> uint8_t reply[] = { CRTP_HEADER(CRTP_PORT_PARAM, PARAM_TOC_CH), CMD_GET_INFO, 1, 0, 0, 2, 0}; <span class="comment">// 1 params in toc</span></div>
- <div class="line"> sendAckPayload(reply, <span class="keyword">sizeof</span>(reply));</div>
- <div class="line"> }</div>
- <div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (buf[1] == CMD_GET_ITEM) <span class="comment">// Param GET_ITEM</span></div>
- <div class="line"> { </div>
- <div class="line"> <span class="comment">// Set up a fax param as item 0</span></div>
- <div class="line"> uint8_t reply[] = { CRTP_HEADER(CRTP_PORT_PARAM, PARAM_TOC_CH), CMD_GET_ITEM, 0, 1, <span class="charliteral">'x'</span>, 0, <span class="charliteral">'y'</span>, 0}; <span class="comment">// bogus item 0 uint8_t param</span></div>
- <div class="line"> sendAckPayload(reply, <span class="keyword">sizeof</span>(reply));</div>
- <div class="line"> }</div>
- <div class="line"> <span class="keywordflow">else</span></div>
- <div class="line"> {</div>
- <div class="line"> Serial.print(<span class="stringliteral">"unknown param type "</span>);</div>
- <div class="line"> Serial.println(buf[1]);</div>
- <div class="line"> }</div>
- <div class="line"> <span class="comment">// dump("param", buf, buflen);</span></div>
- <div class="line"> }</div>
- <div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (buf[0] == CRTP_HEADER_PORT(buf[0]) == CRTP_PORT_PARAM) <span class="comment">// Log</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// http://wiki.bitcraze.se/projects:crazyflie:crtp:log</span></div>
- <div class="line"> <span class="keywordflow">if</span> (buf[1] == CMD_GET_INFO) <span class="comment">// Log GET_INFO</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// pc client only fetches item data if the CRC changes</span></div>
- <div class="line"> <span class="comment">// If you change the contents of your TOC, you must change the CRC</span></div>
- <div class="line"> <span class="comment">// Crazyflie PC client doesnt relaly believe it if you say there are no TOC entries</span></div>
- <div class="line"> uint8_t reply[] = { CRTP_HEADER(CRTP_PORT_LOG, LOG_TOC_CH), CMD_GET_INFO, 1, 0, 0, 2, 1, 8, 64}; <span class="comment">// 1 log item in toc</span></div>
- <div class="line"> sendAckPayload(reply, <span class="keyword">sizeof</span>(reply));</div>
- <div class="line"> } </div>
- <div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (buf[1] == CMD_GET_ITEM) <span class="comment">// Log GET_ITEM</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// Set up a fake battery voltage as item 0</span></div>
- <div class="line"> uint8_t reply[] = { CRTP_HEADER(CRTP_PORT_LOG, LOG_TOC_CH), CMD_GET_ITEM, 0, 7, <span class="charliteral">'p'</span>, <span class="charliteral">'m'</span>, 0, <span class="charliteral">'v'</span>, <span class="charliteral">'b'</span>, <span class="charliteral">'a'</span>, <span class="charliteral">'t'</span>, 0}; <span class="comment">// item 0 float pm.vbat</span></div>
- <div class="line"> sendAckPayload(reply, <span class="keyword">sizeof</span>(reply));</div>
- <div class="line"> }</div>
- <div class="line"><span class="comment">// dump("log", buf, buflen);</span></div>
- <div class="line"> }</div>
- <div class="line"> <span class="keywordflow">else</span></div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// Sometimes get bogus type 0x93</span></div>
- <div class="line"> <span class="comment">// dump("unknown", buf, buflen);</span></div>
- <div class="line"> }</div>
- <div class="line"> }</div>
- <div class="line"> </div>
- <div class="line"> <span class="comment">// Do once per second tasks</span></div>
- <div class="line"> uint32_t this_second = millis() / 1000;</div>
- <div class="line"> <span class="keywordflow">if</span> (this_second != last_second)</div>
- <div class="line"> {</div>
- <div class="line"> <span class="comment">// This is how you would send value data for a log block</span></div>
- <div class="line"> <span class="comment">// with current real-time data</span></div>
- <div class="line"> <span class="comment">// if a log block has ben set up by the client</span></div>
- <div class="line"><span class="comment">// uint8_t msg[] = {CRTP_HEADER(CRTP_PORT_LOG, LOG_LOG_CH), 0, 0, 0, 0, 11, 11, 11, 11};</span></div>
- <div class="line"><span class="comment">// sendAckPayload(msg, sizeof(msg));</span></div>
- <div class="line"></div>
- <div class="line"> last_second = this_second;</div>
- <div class="line"> }</div>
- <div class="line">}</div>
- <div class="line"></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>
|