visus
/
framework-arduinoteensy-cxx20
關注 1
收藏 0
複製 0
程式碼 問題 0 合併請求 0 版本發佈 0 Wiki 活動
PlatformIO package of the Teensy core framework compatible with GCC 10 & C++20
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 提交
1 分支
目錄樹: daa7cc5a30
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'daa7cc5a30'
${ noResults }
framework-arduinoteensy-cxx20/libraries/RadioHead/RadioHead.h

971 line
53KB
原始文件 Blame 歷史記錄 

  1. // RadioHead.h

  2. // Author: Mike McCauley (mikem@airspayce.com) DO NOT CONTACT THE AUTHOR DIRECTLY

  3. // Copyright (C) 2014 Mike McCauley

  4. // $Id: RadioHead.h,v 1.56 2016/07/07 00:02:53 mikem Exp mikem $

  5. 

  6. /// \mainpage RadioHead Packet Radio library for embedded microprocessors

  7. ///

  8. /// This is the RadioHead Packet Radio library for embedded microprocessors.

  9. /// It provides a complete object-oriented library for sending and receiving packetized messages

  10. /// via a variety of common data radios and other transports on a range of embedded microprocessors.

  11. ///

  12. /// The version of the package that this documentation refers to can be downloaded 

  13. /// from http://www.airspayce.com/mikem/arduino/RadioHead/RadioHead-1.61.zip

  14. /// You can find the latest version at http://www.airspayce.com/mikem/arduino/RadioHead

  15. ///

  16. /// You can also find online help and discussion at 

  17. /// http://groups.google.com/group/radiohead-arduino

  18. /// Please use that group for all questions and discussions on this topic. 

  19. /// Do not contact the author directly, unless it is to discuss commercial licensing.

  20. /// Before asking a question or reporting a bug, please read 

  21. /// - http://en.wikipedia.org/wiki/Wikipedia:Reference_desk/How_to_ask_a_software_question

  22. /// - http://www.catb.org/esr/faqs/smart-questions.html

  23. /// - http://www.chiark.greenend.org.uk/~shgtatham/bugs.html

  24. ///

  25. /// \par Overview

  26. ///

  27. /// RadioHead consists of 2 main sets of classes: Drivers and Managers.

  28. ///

  29. /// - Drivers provide low level access to a range of different packet radios and other packetized message transports.

  30. /// - Managers provide high level message sending and receiving facilities for a range of different requirements.

  31. ///

  32. /// Every RadioHead program will have an instance of a Driver to provide access to the data radio or transport, 

  33. /// and a Manager that uses that driver to send and receive messages for the application. The programmer is required

  34. /// to instantiate a Driver and a Manager, and to initialise the Manager. Thereafter the facilities of the Manager

  35. /// can be used to send and receive messages.

  36. ///

  37. /// It is also possible to use a Driver on its own, without a Manager, although this only allows unaddressed, 

  38. /// unreliable transport via the Driver's facilities.

  39. ///

  40. /// In some specialised use cases, it is possible to instantiate more than one Driver and more than one Manager.

  41. ///

  42. /// A range of different common embedded microprocessor platforms are supported, allowing your project to run

  43. /// on your choice of processor.

  44. ///

  45. /// Example programs are included to show the main modes of use.

  46. ///

  47. /// \par Drivers

  48. ///

  49. /// The following Drivers are provided:

  50. ///

  51. /// - RH_RF22

  52. /// Works with Hope-RF

  53. /// RF22B and RF23B based transceivers, and compatible chips and modules, 

  54. /// including the RFM22B transceiver module such as 

  55. /// this bare module: http://www.sparkfun.com/products/10153

  56. /// and this shield: http://www.sparkfun.com/products/11018 

  57. /// and this board: http://www.anarduino.com/miniwireless

  58. /// and RF23BP modules such as: http://www.anarduino.com/details.jsp?pid=130

  59. /// Supports GFSK, FSK and OOK. Access to other chip 

  60. /// features such as on-chip temperature measurement, analog-digital 

  61. /// converter, transmitter power control etc is also provided.

  62. ///

  63. /// - RH_RF24

  64. /// Works with Silicon Labs Si4460/4461/4463/4464 family of transceivers chip, and the equivalent

  65. /// HopeRF RF24/26/27 family of chips and the HopeRF RFM24W/26W/27W modules.

  66. /// Supports GFSK, FSK and OOK. Access to other chip 

  67. /// features such as on-chip temperature measurement, analog-digital 

  68. /// converter, transmitter power control etc is also provided.

  69. ///

  70. /// - RH_RF69 

  71. /// Works with Hope-RF

  72. /// RF69B based radio modules, such as the RFM69 module, (as used on the excellent Moteino and Moteino-USB 

  73. /// boards from LowPowerLab http://lowpowerlab.com/moteino/ )

  74. /// and compatible chips and modules such as RFM69W, RFM69HW, RFM69CW, RFM69HCW (Semtech SX1231, SX1231H).

  75. /// Also works with Anarduino MiniWireless -CW and -HW boards http://www.anarduino.com/miniwireless/ including

  76. /// the marvellous high powered MinWireless-HW (with 20dBm output for excellent range).

  77. /// Supports GFSK, FSK.

  78. ///

  79. /// - RH_NRF24

  80. /// Works with Nordic nRF24 based 2.4GHz radio modules, such as nRF24L01 and others.

  81. /// Also works with Hope-RF RFM73 

  82. /// and compatible devices (such as BK2423). nRF24L01 and RFM73 can interoperate

  83. /// with each other.

  84. ///

  85. /// - RH_NRF905

  86. /// Works with Nordic nRF905 based 433/868/915 MHz radio modules.

  87. ///

  88. /// - RH_NRF51

  89. /// Works with Nordic nRF51 compatible 2.4 GHz SoC/devices such as the nRF51822.

  90. ///

  91. /// - RH_RF95

  92. /// Works with Semtech SX1276/77/78/79, Modtronix inAir4 and inAir9,

  93. /// and HopeRF RFM95/96/97/98 and other similar LoRa capable radios.

  94. /// Supports Long Range (LoRa) with spread spectrum frequency hopping, large payloads etc.

  95. /// FSK/GFSK/OOK modes are not (yet) supported.

  96. ///

  97. /// - RH_MRF89

  98. /// Works with Microchip MRF89XA and compatible transceivers.

  99. /// and modules such as MRF89XAM9A.

  100. ///

  101. /// - RH_CC110

  102. /// Works with Texas Instruments CC110L transceivers and compatible modules such as Anaren AIR BoosterPack 430BOOST-CC110L

  103. ///

  104. /// - RH_ASK

  105. /// Works with a range of inexpensive ASK (amplitude shift keying) RF transceivers such as RX-B1 

  106. /// (also known as ST-RX04-ASK) receiver; TX-C1 transmitter and DR3100 transceiver; FS1000A/XY-MK-5V transceiver;

  107. /// HopeRF RFM83C / RFM85. Supports ASK (OOK).

  108. ///

  109. /// - RH_Serial

  110. /// Works with RS232, RS422, RS485, RS488 and other point-to-point and multidropped serial connections, 

  111. /// or with TTL serial UARTs such as those on Arduino and many other processors,

  112. /// or with data radios with a 

  113. /// serial port interface. RH_Serial provides packetization and error detection over any hardware or 

  114. /// virtual serial connection. Also builds and runs on Linux and OSX.

  115. ///

  116. /// - RH_TCP

  117. /// For use with simulated sketches compiled and running on Linux.

  118. /// Works with tools/etherSimulator.pl to pass messages between simulated sketches, allowing

  119. /// testing of Manager classes on Linux and without need for real radios or other transport hardware.

  120. ///

  121. /// Drivers can be used on their own to provide unaddressed, unreliable datagrams. 

  122. /// All drivers have the same identical API.

  123. /// Or you can use any Driver with any of the Managers described below.

  124. ///

  125. /// We welcome contributions of well tested and well documented code to support other transports.

  126. ///

  127. /// \par Managers

  128. ///

  129. /// The following Mangers are provided:

  130. ///

  131. /// - RHDatagram

  132. /// Addressed, unreliable variable length messages, with optional broadcast facilities.

  133. ///

  134. /// - RHReliableDatagram

  135. /// Addressed, reliable, retransmitted, acknowledged variable length messages.

  136. ///

  137. /// - RHRouter

  138. /// Multi-hop delivery from source node to destination node via 0 or more intermediate nodes, with manual routing.

  139. ///

  140. /// - RHMesh

  141. /// Multi-hop delivery with automatic route discovery and rediscovery.

  142. ///

  143. /// Any Manager may be used with any Driver.

  144. ///

  145. /// \par Platforms

  146. /// 

  147. /// A range of platforms is supported:

  148. ///

  149. /// - Arduino and the Arduino IDE (version 1.0 to 1.6.5 and later)

  150. /// Including Diecimila, Uno, Mega, Leonardo, Yun, Due, Zero etc. http://arduino.cc/, Also similar boards such as 

  151. ///  - Moteino http://lowpowerlab.com/moteino/ 

  152. ///  - Anarduino Mini http://www.anarduino.com/mini/ 

  153. ///  - RedBearLab Blend V1.0 http://redbearlab.com/blend/ (with Arduino 1.0.5 and RedBearLab Blend Add-On version 20140701) 

  154. ///  -  MoteinoMEGA https://lowpowerlab.com/shop/moteinomega 

  155. ///     (with Arduino 1.0.5 and the MoteinoMEGA Arduino Core 

  156. ///     https://github.com/LowPowerLab/Moteino/tree/master/MEGA/Core)

  157. ///  - ESP8266 on Arduino IDE and Boards Manager per https://github.com/esp8266/Arduino 

  158. ///    Tested using Arduino 1.6.8 with esp8266 by ESP8266 Community version 2.1.0

  159. ///    Examples serial_reliable_datagram_* and ask_* are shown to work. 

  160. ///    CAUTION: The GHz radio included in the ESP8266 is

  161. ///    not yet supported. 

  162. ///  - etc.

  163. ///

  164. /// - ChipKIT Core with Arduino IDE on any ChipKIT Core supported Digilent processor (tested on Uno32)

  165. /// http://chipkit.net/wiki/index.php?title=ChipKIT_core

  166. ///

  167. /// - Maple and Flymaple boards with libmaple and the Maple-IDE development environment

  168. /// http://leaflabs.com/devices/maple/ and http://www.open-drone.org/flymaple

  169. ///

  170. /// - Teensy including Teensy 3.1 and earlier built using Arduino IDE 1.0.5 to 1.6.4 and later with 

  171. ///   teensyduino addon 1.18 to 1.23 and later.

  172. ///   http://www.pjrc.com/teensy

  173. ///

  174. /// - Particle Photon https://store.particle.io/collections/photon and ARM3 based CPU with built-in 

  175. ///   Wi-Fi transceiver and extensive IoT software suport. RadioHead does not support the built-in transceiver

  176. ///   bt can be used to control other SPI based radios, Serial ports etc.

  177. ///   See below for details on how to build RadioHead for Photon

  178. ///

  179. /// - ATtiny built using Arduino IDE 1.0.5 with the arduino-tiny support from https://code.google.com/p/arduino-tiny/

  180. ///   and Digispark built with Arduino 1.6.5.

  181. ///   (Caution: these are very small processors and not all RadioHead features may be available, depending on memory requirements)

  182. ///

  183. /// - nRF51 compatible Arm chips such as nRF51822 with Arduino 1.6.4 and later using the procedures

  184. ///   in http://redbearlab.com/getting-started-nrf51822/

  185. ///

  186. /// - Raspberry Pi

  187. ///   Uses BCM2835 library for GPIO http://www.airspayce.com/mikem/bcm2835/

  188. ///   Currently works only with RH_NRF24 driver or other drivers that do not require interrupt support.

  189. ///   Contributed by Mike Poublon.

  190. ///

  191. /// - Linux and OSX

  192. ///   Using the RHutil/HardwareSerial class, the RH_Serial driver and any manager will

  193. ///   build and run on Linux and OSX. These can be used to build programs that talk securely and reliably to

  194. ///   Arduino and other processors or to other Linux or OSX hosts on a reliable, error detected datagram

  195. ///   protocol over a serial line.

  196. ///

  197. /// Other platforms are partially supported, such as Generic AVR 8 bit processors, MSP430. 

  198. /// We welcome contributions that will expand the range of supported platforms. 

  199. ///

  200. /// RadioHead is available (through the efforts of others) 

  201. /// for PlatformIO. PlatformIO is a cross-platform code builder and the missing library manager.

  202. /// http://platformio.org/#!/lib/show/124/RadioHead

  203. ///

  204. /// \par History

  205. ///

  206. /// RadioHead was created in April 2014, substantially based on code from some of our other earlier Radio libraries:

  207. ///

  208. /// - RHMesh, RHRouter, RHReliableDatagram and RHDatagram are derived from the RF22 library version 1.39.

  209. /// - RH_RF22 is derived from the RF22 library version 1.39.

  210. /// - RH_RF69 is derived from the RF69 library version 1.2.

  211. /// - RH_ASK is based on the VirtualWire library version 1.26, after significant conversion to C++.

  212. /// - RH_Serial was new.

  213. /// - RH_NRF24 is based on the NRF24 library version 1.12, with some significant changes.

  214. ///

  215. /// During this combination and redevelopment, we have tried to retain all the processor dependencies and support from

  216. /// the libraries that were contributed by other people. However not all platforms can be tested by us, so if you

  217. /// find that support from some platform has not been successfully migrated, please feel free to fix it and send us a 

  218. /// patch.

  219. ///

  220. /// Users of RHMesh, RHRouter, RHReliableDatagram and RHDatagram in the previous RF22 library will find that their

  221. /// existing code will run mostly without modification. See the RH_RF22 documentation for more details.

  222. ///

  223. /// \par Installation

  224. ///

  225. /// Install in the usual way: unzip the distribution zip file to the libraries

  226. /// sub-folder of your sketchbook. 

  227. /// The example sketches will be visible in in your Arduino, mpide, maple-ide or whatever.

  228. /// http://arduino.cc/en/Guide/Libraries

  229. ///

  230. /// \par Building for Particle Photon

  231. ///

  232. /// The Photon is not supported by the Arduino IDE, so it takes a little effort to set up a build environment.

  233. /// Heres what we did to enable building of RadioHead example sketches on Linux, 

  234. /// but there are other ways to skin this cat.

  235. /// Basic reference for getting stated is: http://particle-firmware.readthedocs.org/en/develop/build/

  236. /// - Download the ARM gcc cross compiler binaries and unpack it in a suitable place:

  237. /// \code

  238. /// cd /tmp

  239. /// wget https://launchpad.net/gcc-arm-embedded/5.0/5-2015-q4-major/+download/gcc-arm-none-eabi-5_2-2015q4-20151219-linux.tar.bz2

  240. /// tar xvf gcc-arm-none-eabi-5_2-2015q4-20151219-linux.tar.bz2

  241. /// \endcode

  242. /// - If dfu-util and friends not installed on your platform, download dfu-util and friends to somewhere in your path

  243. /// \code

  244. /// cd ~/bin

  245. /// wget http://dfu-util.sourceforge.net/releases/dfu-util-0.8-binaries/linux-i386/dfu-util

  246. /// wget http://dfu-util.sourceforge.net/releases/dfu-util-0.8-binaries/linux-i386/dfu-suffix

  247. /// wget http://dfu-util.sourceforge.net/releases/dfu-util-0.8-binaries/linux-i386/dfu-prefix

  248. /// \endcode

  249. /// - Download the Particle firmware (contains headers and libraries require to compile Photon sketches) 

  250. ///   to a suitable place:

  251. /// \code

  252. /// cd /tmp

  253. /// wget https://github.com/spark/firmware/archive/develop.zip

  254. /// unzip develop.zip

  255. /// \endcode

  256. /// - Make a working area containing the RadioHead library source code and your RadioHead sketch. You must

  257. ///   rename the sketch from .pde or .ino to application.cpp

  258. /// \code

  259. /// cd /tmp

  260. /// mkdir RadioHead

  261. /// cd RadioHead

  262. /// cp /usr/local/projects/arduino/libraries/RadioHead/*.h .

  263. /// cp /usr/local/projects/arduino/libraries/RadioHead/*.cpp .

  264. /// cp /usr/local/projects/arduino/libraries/RadioHead/examples/cc110/cc110_client/cc110_client.pde application.cpp

  265. /// \endcode

  266. /// - Edit application.cpp and comment out any #include <SPI.h> so it looks like:

  267. /// \code

  268. ///   // #include <SPI.h>

  269. /// \endcode

  270. /// - Connect your Photon by USB. Put it in DFU mode as descibed in Photon documentation. Light should be flashing yellow

  271. /// - Compile the RadioHead sketch and install it as the user program (this does not update the rest of the

  272. ///   Photon firmware, just the user part:

  273. /// \code

  274. /// cd /tmp/firmware-develop/main

  275. /// PATH=$PATH:/tmp/gcc-arm-none-eabi-5_2-2015q4/bin make APPDIR=/tmp/RadioHead all PLATFORM=photon program-dfu

  276. /// \endcode

  277. /// - You should see RadioHead compile without errors and download the finished sketch into the Photon.

  278. ///

  279. /// \par Compatible Hardware Suppliers

  280. ///

  281. /// We have had good experiences with the following suppliers of RadioHead compatible hardware:

  282. ///

  283. /// - LittleBird http://littlebirdelectronics.com.au in Australia for all manner of Arduinos and radios.

  284. /// - LowPowerLab http://lowpowerlab.com/moteino in USA for the excellent Moteino and Moteino-USB 

  285. ///   boards which include Hope-RF RF69B radios on-board.

  286. /// - Anarduino and HopeRF USA (http://www.hoperfusa.com and http://www.anarduino.com) who have a wide range

  287. ///   of HopeRF radios and Arduino integrated modules.

  288. /// - SparkFun https://www.sparkfun.com/ in USA who design and sell a wide range of Arduinos and radio modules.

  289. ///

  290. /// \par Donations

  291. ///

  292. /// This library is offered under a free GPL license for those who want to use it that way. 

  293. /// We try hard to keep it up to date, fix bugs

  294. /// and to provide free support. If this library has helped you save time or money, please consider donating at

  295. /// http://www.airspayce.com or here:

  296. ///

  297. /// \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="RadioHead" /> <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

  298. /// 

  299. /// \par Trademarks

  300. ///

  301. /// RadioHead is a trademark of AirSpayce Pty Ltd. The RadioHead mark was first used on April 12 2014 for

  302. /// international trade, and is used only in relation to data communications hardware and software and related services.

  303. /// It is not to be confused with any other similar marks covering other goods and services.

  304. ///

  305. /// \par Copyright

  306. ///

  307. /// This software is Copyright (C) 2011-2016 Mike McCauley. Use is subject to license

  308. /// conditions. The main licensing options available are GPL V2 or Commercial:

  309. /// 

  310. /// \par Open Source Licensing GPL V2

  311. ///

  312. /// This is the appropriate option if you want to share the source code of your

  313. /// application with everyone you distribute it to, and you also want to give them

  314. /// the right to share who uses it. If you wish to use this software under Open

  315. /// Source Licensing, you must contribute all your source code to the open source

  316. /// community in accordance with the GPL Version 2 when your application is

  317. /// distributed. See http://www.gnu.org/copyleft/gpl.html

  318. /// 

  319. /// \par Commercial Licensing

  320. ///

  321. /// This is the appropriate option if you are creating proprietary applications

  322. /// and you are not prepared to distribute and share the source code of your

  323. /// application. Contact info@airspayce.com for details (do not use this address for anything other than 

  324. /// commercial license enquiries. For all other queries, using the RadioHead mailing list).

  325. ///

  326. /// \par Revision History

  327. /// \version 1.1 2014-04-14<br>

  328. ///              Initial public release

  329. /// \version 1.2 2014-04-23<br>

  330. ///              Fixed various typos. <br>

  331. ///              Added links to compatible Anarduino products.<br>

  332. ///              Added RHNRFSPIDriver, RH_NRF24 classes to support Nordic NRF24 based radios.

  333. /// \version 1.3 2014-04-28<br>

  334. ///              Various documentation fixups.<br>

  335. ///              RHDatagram::setThisAddress() did not set the local copy of thisAddress. Reported by Steve Childress.<br>

  336. ///              Fixed a problem on Teensy with RF22 and RF69, where the interrupt pin needs to be set for input, <br>

  337. ///              else pin interrupt doesn't work properly. Reported by Steve Childress and patched by 

  338. ///              Adrien van den Bossche. Thanks.<br>

  339. ///              Fixed a problem that prevented RF22 honouring setPromiscuous(true). Reported by Steve Childress.<br>

  340. ///              Updated documentation to clarify some issues to do with maximum message lengths 

  341. ///              reported by Steve Childress.<br>

  342. ///              Added support for yield() on systems that support it (currently Arduino 1.5.5 and later)

  343. ///              so that spin-loops can suport multitasking. Suggested by Steve Childress.<br>

  344. ///              Added RH_RF22::setGpioReversed() so the reversal it can be configured at run-time after

  345. ///              radio initialisation. It must now be called _after_ init(). Suggested by Steve Childress.<br>

  346. /// \version 1.4 2014-04-29<br>

  347. ///              Fixed further problems with Teensy compatibility for RH_RF22. Tested on Teensy 3.1.

  348. ///              The example/rf22_* examples now run out of the box with the wiring connections as documented for Teensy

  349. ///              in RH_RF22.<br>

  350. ///              Added YIELDs to spin-loops in RHRouter, RHMesh and RHReliableDatagram, RH_NRF24.<br>

  351. ///              Tested RH_Serial examples with Teensy 3.1: they now run out of the box.<br>

  352. ///              Tested RH_ASK examples with Teensy 3.1: they now run out of the box.<br>

  353. ///              Reduced default SPI speed for NRF24 from 8MHz to 1MHz on Teensy, to improve reliability when

  354. ///              poor wiring is in use.<br>

  355. ///              on some devices such as Teensy.<br>

  356. ///              Tested RH_NRF24 examples with Teensy 3.1: they now run out of the box.<br>

  357. /// \version 1.5 2014-04-29<br>

  358. ///              Added support for Nordic Semiconductor nRF905 transceiver with RH_NRF905 driver. Also

  359. ///              added examples for nRF905 and tested on Teensy 3.1

  360. /// \version 1.6 2014-04-30<br>

  361. ///              NRF905 examples were missing

  362. /// \version 1.7 2014-05-03<br>

  363. ///              Added support for Arduino Due. Tested with RH_NRF905, RH_Serial, RH_ASK.

  364. ///              IMPORTANT CHANGE to interrupt pins on Arduino with RH_RF22 and RH_RF69 constructors:

  365. ///              previously, you had to specify the interrupt _number_ not the interrupt _pin_. Arduinos and Uno32

  366. ///              are now consistent with all other platforms: you must specify the interrupt pin number. Default

  367. ///              changed to pin 2 (a common choice with RF22 shields).

  368. ///              Removed examples/maple/maple_rf22_reliable_datagram_client and 

  369. ///              examples/maple/maple_rf22_reliable_datagram_client since the rf22 examples now work out

  370. ///              of the box with Flymaple.

  371. ///              Removed examples/uno32/uno32_rf22_reliable_datagram_client and 

  372. ///              examples/uno32/uno32_rf22_reliable_datagram_client since the rf22 examples now work out

  373. ///              of the box with ChipKit Uno32.

  374. /// \version 1.8 2014-05-08 <br>

  375. ///              Added support for YIELD in Teensy 2 and 3, suggested by Steve Childress.<br>

  376. ///              Documentation updates. Clarify use of headers and Flags<br>

  377. ///              Fixed misalignment in RH_RF69 between ModemConfigChoice definitions and the implemented choices

  378. ///              which meant you didnt get the choice you thought and GFSK_Rb55555Fd50 hung the transmitter.<br>

  379. ///              Preliminary work on Linux simulator.

  380. /// \version 1.9 2014-05-14 <br>

  381. ///              Added support for using Timer 2 instead of Timer 1 on Arduino in RH_ASK when

  382. ///              RH_ASK_ARDUINO_USE_TIMER2 is defined. With the kind assistance of

  383. ///              Luc Small. Thanks!<br>

  384. ///              Updated comments in RHReliableDatagram concerning servers, retries, timeouts and delays.

  385. ///              Fixed an error in RHReliableDatagram where recvfrom return value was not checked.

  386. ///              Reported by Steve Childress.<br>

  387. ///              Added Linux simulator support so simple RadioHead sketches can be compiled and run on Linux.<br>

  388. ///              Added RH_TCP driver to permit message passing between simulated sketches on Linux.<br>

  389. ///              Added example simulator sketches.<br>

  390. ///              Added tools/etherSimulator.pl, a simulator of the 'Luminiferous Ether' that passes

  391. ///              messages between simulated sketches and can simulate random message loss etc.<br>

  392. ///              Fixed a number of typos and improved some documentation.<br>

  393. /// \version 1.10 2014-05-15 <br>

  394. ///              Added support for RFM73 modules to RH_NRF24. These 2 radios are very similar, and can interoperate

  395. ///              with each other. Added new RH_NRF24::TransmitPower enums for the RFM73, which has a different 

  396. ///              range of available powers<br>

  397. ///              reduced the default SPI bus speed for RH_NRF24 to 1MHz, since so many modules and CPU have problems

  398. ///              with 8MHz.<br>

  399. /// \version 1.11 2014-05-18<br>

  400. ///              Testing RH_RF22 with RFM23BP and 3.3V Teensy 3.1 and 5V Arduinos. 

  401. ///              Updated documentation with respect to GPIO and antenna

  402. ///              control pins for RFM23. Updated documentation with respect to transmitter power control for RFM23<br>

  403. ///              Fixed a problem with RH_RF22 driver, where GPIO TX and RX pins were not configured during

  404. ///              initialisation, causing poor transmit power and sensitivity on those RF22/RF23 devices where GPIO controls

  405. ///              the antenna selection pins.

  406. /// \version 1.12 2014-05-20<br>

  407. ///              Testing with RF69HW and the RH_RF69 driver. Works well with the Anarduino MiniWireless -CW and -HW 

  408. ///              boards http://www.anarduino.com/miniwireless/ including

  409. ///              the marvellous high powered MinWireless-HW (with 20dBm output for excellent range).<br>

  410. ///              Clarified documentation of RH_RF69::setTxPower values for different models of RF69.<br>

  411. ///              Added RHReliableDatagram::resetRetransmissions().<br>

  412. ///              Retransmission count precision increased to uin32_t.<br>

  413. ///              Added data about actual power measurements from RFM22 module.<br>

  414. /// \version 1.13 2014-05-23<br>

  415. ///              setHeaderFlags(flags) changed to setHeaderFlags(set, clear), enabling any flags to be

  416. ///              individually set and cleared by either RadioHead or application code. Requested by Steve Childress.<br>

  417. ///              Fixed power output setting for boost power on RF69HW for 18, 19 and 20dBm.<br>

  418. ///              Added data about actual power measurements from RFM69W and RFM69HW modules.<br>

  419. /// \version 1.14 2014-05-26<br>

  420. ///              RH_RF69::init() now always sets the PA boost back to the default settings, else can get invalid

  421. ///              PA power modes after uploading new sketches without a power cycle. Reported by Bryan.<br>

  422. ///              Added new macros RH_VERSION_MAJOR RH_VERSION_MINOR, with automatic maintenance in Makefile.<br>

  423. ///              Improvements to RH_TCP: constructor now honours the server argument in the form "servername:port".<br>

  424. ///              Added YIELD to RHReliableDatagram::recvfromAckTimeout. Requested by Steve Childress.<br>

  425. ///              Fixed a problem with RH_RF22 reliable datagram acknowledgements that was introduced in version 1.13.

  426. ///              Reported by Steve Childress.<br>

  427. /// \version 1.15 2014-05-27<br>

  428. ///              Fixed a problem with the RadioHead .zip link.

  429. /// \version 1.16 2014-05-30 <br>

  430. ///              Fixed RH_RF22 so that lastRssi() returns the signal strength in dBm. Suggested by Steve Childress.<br>

  431. ///              Added support for getLastPreambleTime() to RH_RF69. Requested by Steve Childress.<br>

  432. ///              RH_NRF24::init() now checks if there is a device connected and responding, else init() will fail.

  433. ///              Suggested by Steve Brown.<br>

  434. ///              RHSoftwareSPI now initialises default values for SPI pins MOSI = 12, MISO = 11 and SCK = 13.<br>

  435. ///              Fixed some problems that prevented RH_NRF24 working with mixed software and hardware SPI 

  436. ///              on different devices: a race condition

  437. ///              due to slow SPI transfers and fast acknowledgement.<br>

  438. /// \version 1.17 2014-06-02 <br>

  439. ///              Fixed a debug typo in RHReliableDatagram that was introduced in 1.16.<br>

  440. ///              RH_NRF24 now sets default power, data rate and channel in init(), in case another

  441. ///              app has previously set different values without powerdown.<br>

  442. ///              Caution: there are still problems with RH_NRF24 and Software SPI. Do not use.<br>

  443. /// \version 1.18 2014-06-02<br>

  444. ///              Improvements to performance of RH_NRF24 statusRead, allowing RH_NRF24 and Software SPI

  445. ///              to operate on slow devices like Arduino Uno.<br>

  446. /// \version 1.19 2014-06-19<br>

  447. ///              Added examples ask_transmitter.pde and ask_receiver.pde.<br>

  448. ///              Fixed an error in the RH_RF22 doc for connection of Teensy to RF22.<br>

  449. ///              Improved documentation of start symbol bit patterns in RH_ASK.cpp

  450. /// \version 1.20 2014-06-24<br>

  451. ///              Fixed a problem with compiling on platforms such as ATTiny where SS is not defined.<br>

  452. ///              Added YIELD to RHMesh::recvfromAckTimeout().<br>

  453. /// \version 1.21 2014-06-24<br>

  454. ///              Fixed an issue in RH_Serial where characters might be lost with back-to-back frames.

  455. ///              Suggested by Steve Childress.<br>

  456. ///              Brought previous RHutil/crc16.h code into mainline RHCRC.cpp to prevent name collisions

  457. ///              with other similarly named code in other libraries. Suggested by Steve Childress.<br>

  458. ///              Fix SPI bus speed errors on 8MHz Arduinos.

  459. /// \version 1.22 2014-07-01<br>

  460. ///              Update RH_ASK documentation for common wiring connections.<br>

  461. ///              Testing RH_ASK with HopeRF RFM83C/RFM85 courtesy Anarduino http://www.anarduino.com/<br>

  462. ///              Testing RH_NRF24 with Itead Studio IBoard Pro http://imall.iteadstudio.com/iboard-pro.html

  463. ///              using both hardware SPI on the ITDB02 Parallel LCD Module Interface pins and software SPI

  464. ///              on the nRF24L01+ Module Interface pins. Documented wiring required.<br>

  465. ///              Added support for AVR 1284 and 1284p, contributed by Peter Scargill.

  466. ///              Added support for Semtech SX1276/77/78 and HopeRF RFM95/96/97/98 and other similar LoRa capable radios

  467. ///              in LoRa mode only. Tested with the excellent MiniWirelessLoRa from 

  468. ///              Anarduino http://www.anarduino.com/miniwireless<br>

  469. /// \version 1.23 2014-07-03<br>

  470. ///              Changed the default modulation for RH_RF69 to GFSK_Rb250Fd250, since the previous default

  471. ///              was not very reliable.<br>

  472. ///              Documented RH_RF95 range tests.<br>

  473. ///              Improvements to RH_RF22 RSSI readings so that lastRssi correctly returns the last message in dBm.<br>

  474. /// \version 1.24 2014-07-18

  475. ///              Added support for building RadioHead for STM32F4 Discovery boards, using the native STM Firmware libraries,

  476. ///              in order to support Codec2WalkieTalkie (http://www.airspayce.com/mikem/Codec2WalkieTalkie)

  477. ///              and other projects. See STM32ArduinoCompat.<br>

  478. ///              Default modulation for RH_RF95 was incorrectly set to a very slow Bw125Cr48Sf4096

  479. /// \version 1.25 2014-07-25

  480. ///              The available() function will longer terminate any current transmission, and force receive mode. 

  481. ///              Now, if there is no unprocessed incoming message and an outgoing message is currently being transmitted, 

  482. ///              available() will return false.<br>

  483. ///              RHRouter::sendtoWait(uint8_t*, uint8_t, uint8_t, uint8_t) renamed to sendtoFromSourceWait due to conflicts

  484. ///              with new sendtoWait() with optional flags.<br>

  485. ///              RHMEsh and RHRouter already supported end-to-end application layer flags, but RHMesh::sendtoWait() 

  486. ///              and RHRouter::sendToWait have now been extended to expose a way to send optional application layer flags.

  487. /// \version 1.26 2014-08-12

  488. ///              Fixed a Teensy 2.0 compile problem due yield() not available on Teensy < 3.0. <br>

  489. ///              Adjusted the algorithm of RH_RF69::temperatureRead() to more closely reflect reality.<br>

  490. ///              Added functions to RHGenericDriver to get driver packet statistics: rxBad(), rxGood(), txGood().<br>

  491. ///              Added RH_RF69::printRegisters().<br>

  492. ///              RH_RF95::printRegisters() was incorrectly printing the register index instead of the address.

  493. ///              Reported by Phang Moh Lim.<br>

  494. ///              RH_RF95, added definitions for some more registers that are usable in LoRa mode.<br>

  495. ///              RH_RF95::setTxPower now uses RH_RF95_PA_DAC_ENABLE to achieve 21, 22 and 23dBm.<br>

  496. ///              RH_RF95, updated power output measurements.<br>

  497. ///              Testing RH_RF69 on Teensy 3.1 with RF69 on PJRC breakout board. OK.<br>

  498. ///              Improvements so RadioHead will build under Arduino where SPI is not supported, such as 

  499. ///              ATTiny.<br>

  500. ///              Improvements so RadioHead will build for ATTiny using Arduino IDE and tinycore arduino-tiny-0100-0018.zip.<br>

  501. ///              Testing RH_ASK on ATTiny85. Reduced RAM footprint. 

  502. ///              Added helpful documentation. Caution: RAM memory is *very* tight on this platform.<br>

  503. ///              RH_RF22 and RH_RF69, added setIdleMode() function to allow the idle mode radio operating state

  504. ///              to be controlled for lower idle power consumption at the expense of slower transitions to TX and RX.<br>

  505. /// \version 1.27 2014-08-13

  506. ///              All RH_RF69 modulation schemes now have data whitening enabled by default.<br>

  507. ///              Tested and added a number of OOK modulation schemes to RH_RF69 Modem config table.<br>

  508. ///              Minor improvements to a number of the faster RH_RF69 modulation schemes, but some slower ones

  509. ///              are still not working correctly.<br>

  510. /// \version 1.28 2014-08-20

  511. ///              Added new RH_RF24 driver to support Si446x, RF24/26/26, RFM24/26/27 family of transceivers.

  512. ///              Tested with the excellent

  513. ///              Anarduino Mini and RFM24W and RFM26W with the generous assistance of the good people at 

  514. ///              Anarduino http://www.anarduino.com.

  515. /// \version 1.29 2014-08-21

  516. ///              Fixed a compile error in RH_RF24 introduced at the last minute in hte previous release.<br>

  517. ///              Improvements to RH_RF69 modulation schemes: now include the AFCBW in teh ModemConfig.<br>

  518. ///              ModemConfig RH_RF69::FSK_Rb2Fd5 and RH_RF69::GFSK_Rb2Fd5 are now working.<br> 

  519. /// \version 1.30 2014-08-25

  520. ///              Fixed some compile problems with ATtiny84 on Arduino 1.5.5 reported by Glen Cook.<br>

  521. /// \version 1.31 2014-08-27

  522. ///              Changed RH_RF69 FSK and GFSK modulations from Rb2_4Fd2_4 to Rb2_4Fd4_8 and FSK_Rb4_8Fd4_8 to FSK_Rb4_8Fd9_6

  523. ///              since the previous ones were unreliable (they had modulation indexes of 1).<br>

  524. /// \version 1.32 2014-08-28

  525. ///              Testing with RedBearLab Blend board http://redbearlab.com/blend/. OK.<br>

  526. ///              Changed more RH_RF69 FSK and GFSK slowish modulations to have modulation index of 2 instead of 1. 

  527. ///              This required chnaging the symbolic names.<br>

  528. /// \version 1.33 2014-09-01

  529. ///              Added support for sleep mode in RHGeneric driver, with new mode 

  530. ///              RHModeSleep and new virtual function sleep().<br>

  531. ///              Added support for sleep to RH_RF69, RH_RF22, RH_NRF24, RH_RF24, RH_RF95 drivers.<br>

  532. /// \version 1.34 2014-09-19

  533. ///              Fixed compile errors in example rf22_router_test.<br>

  534. ///              Fixed a problem with RH_NRF24::setNetworkAddress, also improvements to RH_NRF24 register printing.

  535. ///              Patched by Yveaux.<br>

  536. ///              Improvements to RH_NRF24 initialisation for version 2.0 silicon.<br>

  537. ///              Fixed problem with ambigiguous print call in RH_RFM69 when compiling for Codec2.<br>

  538. ///              Fixed a problem with RH_NRF24 on RFM73 where the LNA gain was not set properly, reducing the sensitivity

  539. ///              of the receiver.

  540. /// \version 1.35 2014-09-19

  541. ///              Fixed a problem with interrupt setup on RH_RF95 with Teensy3.1. Reported by AD.<br>

  542. /// \version 1.36 2014-09-22

  543. ///              Improvements to interrupt pin assignments for __AVR_ATmega1284__ and__AVR_ATmega1284P__, provided by

  544. ///              Peter Scargill.<br>

  545. ///              Work around a bug in Arduino 1.0.6 where digitalPinToInterrupt is defined but NOT_AN_INTERRUPT is not.<br>

  546. ///  \version 1.37 2014-10-19

  547. ///              Updated doc for connecting RH_NRF24 to Arduino Mega.<br>

  548. ///              Changes to RHGenericDriver::setHeaderFlags(), so that the default for the clear argument

  549. ///              is now RH_FLAGS_APPLICATION_SPECIFIC, which is less surprising to users.

  550. ///              Testing with the excellent MoteinoMEGA from LowPowerLab 

  551. ///              https://lowpowerlab.com/shop/moteinomega with on-board RFM69W.

  552. ///  \version 1.38 2014-12-29

  553. ///              Fixed compile warning on some platforms where RH_RF24::send and RH_RF24::writeTxFifo 

  554. ///              did not return a value.<br>

  555. ///              Fixed some more compiler warnings in RH_RF24 on some platforms.<br>

  556. ///              Refactored printRegisters for some radios. Printing to Serial

  557. ///              is now controlled by the definition of RH_HAVE_SERIAL.<br>

  558. ///              Added partial support for ARM M4 w/CMSIS with STM's Hardware Abstraction lib for 

  559. ///              Steve Childress.<br>

  560. ///  \version 1.39 2014-12-30

  561. ///              Fix some compiler warnings under IAR.<br>

  562. ///              RH_HAVE_SERIAL and Serial.print calls removed for ATTiny platforms.<br>

  563. ///  \version 1.40 2015-03-09

  564. ///              Added notice about availability on PlatformIO, thanks to Ivan Kravets.<br>

  565. ///              Fixed a problem with RH_NRF24 where short packet lengths would occasionally not be trasmitted

  566. ///              due to a race condition with RH_NRF24_TX_DS. Reported by Mark Fox.<br>

  567. ///  \version 1.41 2015-03-29

  568. ///              RH_RF22, RH_RF24, RH_RF69 and RH_RF95 improved to allow driver.init() to be called multiple

  569. ///              times without reallocating a new interrupt, allowing the driver to be reinitialised

  570. ///              after sleeping or powering down.

  571. ///  \version 1.42 2015-05-17

  572. ///              Added support for RH_NRF24 driver on Raspberry Pi, using BCM2835

  573. ///              library for GPIO pin IO. Contributed by Mike Poublon.<br>

  574. ///              Tested RH_NRF24 module with NRF24L01+PA+LNA SMA Antenna Wireless Transceiver modules

  575. ///              similar to: http://www.elecfreaks.com/wiki/index.php?title=2.4G_Wireless_nRF24L01p_with_PA_and_LNA

  576. ///              works with no software changes. Measured max power output 18dBm.<br>

  577. ///  \version 1.43 2015-08-02

  578. ///              Added RH_NRF51 driver to support Nordic nRF51 family processor with 2.4GHz radio such 

  579. ///              as nRF51822, to be built on Arduino 1.6.4 and later. Tested with RedBearLabs nRF51822 board

  580. ///              and BLE Nano kit<br>

  581. ///  \version 1.44 2015-08-08

  582. ///              Fixed errors with compiling on some platforms without serial, such as ATTiny. 

  583. ///              Reported by Friedrich Müller.<br>

  584. ///  \version 1.45 2015-08-13

  585. ///              Added support for using RH_Serial on Linux and OSX (new class RHutil/HardwareSerial

  586. ///              encapsulates serial ports on those platforms). Example examples/serial upgraded

  587. ///              to build and run on Linux and OSX using the tools/simBuild builder.

  588. ///              RHMesh, RHRouter and RHReliableDatagram updated so they can use RH_Serial without

  589. ///              polling loops on Linux and OSX for CPU efficiency.<br>

  590. ///  \version 1.46 2015-08-14

  591. ///              Amplified some doc concerning Linux and OSX RH_Serial. Added support for 230400

  592. ///              baud rate in HardwareSerial.<br>

  593. ///              Added sample sketches nrf51_audio_tx and nrf51_audio_rx which show how to

  594. ///              build an audio TX/RX pair with RedBear nRF51822 boards and a SparkFun MCP4725 DAC board.

  595. ///              Uses the built-in ADC of the nRF51822 to sample audio at 5kHz and transmit packets

  596. ///              to the receiver which plays them via the DAC.<br>

  597. /// \version 1.47 2015-09-18

  598. ///              Removed top level Makefile from distribution: its only used by the developer and 

  599. ///              its presence confuses some people.<br>

  600. ///              Fixed a problem with RHReliableDatagram with some versions of Raspberry Pi random() that causes 

  601. ///              problems: random(min, max) sometimes exceeds its max limit.

  602. /// \version 1.48 2015-09-30

  603. ///              Added support for Arduino Zero. Tested on Arduino Zero Pro.

  604. /// \version 1.49 2015-10-01

  605. ///              Fixed problems that prevented interrupts working correctly on Arduino Zero and Due.

  606. ///              Builds and runs with 1.6.5 (with 'Arduino SAMD Boards' for Zero version 1.6.1) from arduino.cc.

  607. ///              Arduino version 1.7.7 from arduino.org is not currently supported.

  608. /// \version 1.50 2015-10-25

  609. ///              Verified correct building and operation with Arduino 1.7.7 from arduino.org.

  610. ///              Caution: You must burn the bootloader from 1.7.7 to the Arduino Zero before it will 

  611. ///              work with Arduino 1.7.7 from arduino.org. Conversely, you must burn the bootloader from 1.6.5 

  612. ///              to the Arduino Zero before it will 

  613. ///              work with Arduino 1.6.5 from arduino.cc. Sigh.

  614. ///              Fixed a problem with RH_NRF905 that prevented the power and frequency ranges being set

  615. ///              properly. Reported by Alan Webber.

  616. /// \version 1.51 2015-12-11

  617. ///              Changes to RH_RF6::setTxPower() to be compatible with SX1276/77/78/79 modules that

  618. ///              use RFO transmitter pins instead of PA_BOOST, such as the excellent

  619. ///              Modtronix inAir4 http://modtronix.com/inair4.html 

  620. ///              and inAir9 modules http://modtronix.com/inair9.html. With the kind assistance of 

  621. ///              David from Modtronix.

  622. /// \version 1.52 2015-12-17

  623. ///              Added RH_MRF89 module to suport Microchip MRF89XA and compatible transceivers.

  624. ///              and modules.<br>

  625. /// \version 1.53 2016-01-02

  626. ///              Added RH_CC110 module to support Texas Instruments CC110L and compatible transceivers and modules.<br>

  627. /// \version 1.54 2016-01-29

  628. ///              Added support for ESP8266 processor on Arduino IDE. Examples serial_reliable_datagram_* are shown to work. 

  629. ///              CAUTION: SPI not supported yet. Timers used by RH_ASK are not tested. 

  630. ///              The GHz radio included in the ESP8266 is not yet supported. 

  631. /// \version 1.55 2016-02-12

  632. ///              Added macros for htons() and friends to RadioHead.h.

  633. ///              Added example sketch serial_gateway.pde. Acts as a transparent gateway between RH_RF22 and RH_Serial, 

  634. ///              and with minor mods acts as a universal gateway between any 2 RadioHead driver networks.

  635. ///              Initial work on supporting STM32 F2 on Particle Photon: new platform type defined.

  636. ///              Fixed many warnings exposed by test building for Photon.

  637. ///              Particle Photon tested support for RH_Serial, RH_ASK, SPI, RH_CC110 etc.

  638. ///              Added notes on how to build RadioHead sketches for Photon.

  639. /// \version 1.56 2016-02-18 

  640. ///              Implemented timers for RH_ASK on ESP8266, added some doc on IO pin selection.

  641. /// \version 1.57 2016-02-23

  642. ///              Fixed an issue reported by S3B, where RH_RF22 would sometimes not clear the rxbufvalid flag.

  643. /// \version 1.58 2-16-04-04

  644. ///              Tested RH_RF69 with Arduino Due. OK. Updated doc.<br>

  645. ///              Added support for all ChipKIT Core supported boards 

  646. ///              http://chipkit.net/wiki/index.php?title=ChipKIT_core

  647. ///              Tested on ChipKIT Uno32.<br>

  648. ///              Digilent Uno32 under the old MPIDE is no longer formally 

  649. ///              supported but may continue to work for some time.<br>

  650. /// \version 1.59 2016-04-12

  651. ///              Testing with the excellent Rocket Scream Mini Ultra Pro with the RFM95W and RFM69HCW modules from

  652. ///              http://www.rocketscream.com/blog/product/mini-ultra-pro-with-radio/  (915MHz versions). Updated

  653. ///              documentation with hints to suit. Caution: requires Arduino 1.6.8 and Arduino SAMD Boards 1.6.5.

  654. ///              See also http://www.rocketscream.com/blog/2016/03/10/radio-range-test-with-rfm69hcw/

  655. ///              for the vendors tests and range with the RFM69HCW version.

  656. ///              These boards are highly recommended. They also include battery charging support.

  657. /// \version 1.60 2016-06-25

  658. ///              Tested with the excellent talk2 Whisper Node boards 

  659. ///             (https://talk2.wisen.com.au/ and https://bitbucket.org/talk2/), 

  660. ///              an Arduino Nano compatible board, which include an on-board RF69 radio, external antenna, 

  661. ///              run on 2xAA batteries and support low power operations. RF69 examples work without modification.

  662. ///              Added support for ESP8266 SPI, provided by David Skinner.

  663. /// \version 1.61 2016-07-07

  664. ///              Patch to RH_ASK.cpp for ESP8266, to prevent crashes in interrupt handlers. Patch from Alexander Mamchits.

  665. ///

  666. /// \author  Mike McCauley. DO NOT CONTACT THE AUTHOR DIRECTLY. USE THE MAILING LIST GIVEN ABOVE

  667. 

  668. #ifndef RadioHead_h

  669. #define RadioHead_h

  670. 

  671. // Official version numbers are maintained automatically by Makefile:

  672. #define RH_VERSION_MAJOR 1

  673. #define RH_VERSION_MINOR 61

  674. 

  675. // Symbolic names for currently supported platform types

  676. #define RH_PLATFORM_ARDUINO          1

  677. #define RH_PLATFORM_MSP430           2

  678. #define RH_PLATFORM_STM32            3

  679. #define RH_PLATFORM_GENERIC_AVR8     4

  680. #define RH_PLATFORM_UNO32            5

  681. #define RH_PLATFORM_UNIX             6

  682. #define RH_PLATFORM_STM32STD         7

  683. #define RH_PLATFORM_STM32F4_HAL      8 

  684. #define RH_PLATFORM_RASPI            9

  685. #define RH_PLATFORM_NRF51            10

  686. #define RH_PLATFORM_ESP8266          11

  687. #define RH_PLATFORM_STM32F2          12

  688. #define RH_PLATFORM_CHIPKIT_CORE     13

  689. 

  690. ////////////////////////////////////////////////////

  691. // Select platform automatically, if possible

  692. #ifndef RH_PLATFORM

  693.  #if (MPIDE>=150 && defined(ARDUINO))

  694.   // Using ChipKIT Core on Arduino IDE

  695.   #define RH_PLATFORM RH_PLATFORM_CHIPKIT_CORE

  696.  #elif defined(MPIDE)

  697.   // Uno32 under old MPIDE, which has been discontinued:

  698.   #define RH_PLATFORM RH_PLATFORM_UNO32

  699.  #elif defined(NRF51)

  700.   #define RH_PLATFORM RH_PLATFORM_NRF51

  701.  #elif defined(ESP8266)

  702.   #define RH_PLATFORM RH_PLATFORM_ESP8266

  703.  #elif defined(ARDUINO)

  704.   #define RH_PLATFORM RH_PLATFORM_ARDUINO

  705.  #elif defined(__MSP430G2452__) || defined(__MSP430G2553__)

  706.   #define RH_PLATFORM RH_PLATFORM_MSP430

  707.  #elif defined(MCU_STM32F103RE)

  708.   #define RH_PLATFORM RH_PLATFORM_STM32

  709.  #elif defined(STM32F2XX)

  710.   #define RH_PLATFORM RH_PLATFORM_STM32F2

  711.  #elif defined(USE_STDPERIPH_DRIVER)

  712.   #define RH_PLATFORM RH_PLATFORM_STM32STD

  713.  #elif defined(RASPBERRY_PI)

  714.   #define RH_PLATFORM RH_PLATFORM_RASPI

  715. #elif defined(__unix__) // Linux

  716.   #define RH_PLATFORM RH_PLATFORM_UNIX

  717. #elif defined(__APPLE__) // OSX

  718.   #define RH_PLATFORM RH_PLATFORM_UNIX

  719.  #else

  720.   #error Platform not defined! 	

  721.  #endif

  722. #endif

  723. 

  724. #if defined(__AVR_ATtiny84__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtinyX4__) || defined(__AVR_ATtinyX5__) || defined(__AVR_ATtiny2313__) || defined(__AVR_ATtiny4313__) || defined(__AVR_ATtinyX313__)

  725.  #define RH_PLATFORM_ATTINY

  726. #endif

  727. 

  728. ////////////////////////////////////////////////////

  729. // Platform specific headers:

  730. #if (RH_PLATFORM == RH_PLATFORM_ARDUINO)

  731.  #if (ARDUINO >= 100)

  732.   #include <Arduino.h>

  733.  #else

  734.   #include <wiring.h>

  735.  #endif

  736.  #ifdef RH_PLATFORM_ATTINY

  737.   #warning Arduino TinyCore does not support hardware SPI. Use software SPI instead.

  738.  #else

  739.   #include <SPI.h>

  740.   #define RH_HAVE_HARDWARE_SPI

  741.   #define RH_HAVE_SERIAL

  742.  #endif

  743. 

  744. #elif (RH_PLATFORM == RH_PLATFORM_ESP8266) // ESP8266 processor on Arduino IDE

  745.  #include <Arduino.h>

  746.  #include <SPI.h>

  747.  #define RH_HAVE_HARDWARE_SPI

  748.  #define RH_HAVE_SERIAL

  749. #elif (RH_PLATFORM == RH_PLATFORM_MSP430) // LaunchPad specific

  750.  #include "legacymsp430.h"

  751.  #include "Energia.h"

  752.  #include <SPI.h>

  753.  #define RH_HAVE_HARDWARE_SPI

  754.  #define RH_HAVE_SERIAL

  755. 

  756. #elif (RH_PLATFORM == RH_PLATFORM_UNO32 || RH_PLATFORM == RH_PLATFORM_CHIPKIT_CORE)

  757.  #include <WProgram.h>

  758.  #include <string.h>

  759.  #include <SPI.h>

  760.  #define RH_HAVE_HARDWARE_SPI

  761.  #define memcpy_P memcpy

  762.  #define RH_HAVE_SERIAL

  763. 

  764. #elif (RH_PLATFORM == RH_PLATFORM_STM32) // Maple, Flymaple etc

  765.  #include <wirish.h>	

  766.  #include <stdint.h>

  767.  #include <string.h>

  768.  #include <HardwareSPI.h>

  769.  #define RH_HAVE_HARDWARE_SPI

  770.  // Defines which timer to use on Maple

  771.  #define MAPLE_TIMER 1

  772.  #define PROGMEM

  773.  #define memcpy_P memcpy

  774.  #define Serial SerialUSB

  775.  #define RH_HAVE_SERIAL

  776. 

  777. #elif (RH_PLATFORM == RH_PLATFORM_STM32F2) // Particle Photon with firmware-develop

  778.  #include <stm32f2xx.h>

  779.  #include <application.h>

  780.  #include <math.h> // floor

  781.  #define RH_HAVE_SERIAL

  782.  #define RH_HAVE_HARDWARE_SPI

  783. 

  784. #elif (RH_PLATFORM == RH_PLATFORM_STM32STD) // STM32 with STM32F4xx_StdPeriph_Driver 

  785.  #include <stm32f4xx.h>

  786.  #include <wirish.h>	

  787.  #include <stdint.h>

  788.  #include <string.h>

  789.  #include <math.h>

  790.  #include <HardwareSPI.h>

  791.  #define RH_HAVE_HARDWARE_SPI

  792.  #define Serial SerialUSB

  793.  #define RH_HAVE_SERIAL

  794. 

  795. #elif (RH_PLATFORM == RH_PLATFORM_GENERIC_AVR8) 

  796.  #include <avr/io.h>

  797.  #include <avr/interrupt.h>

  798.  #include <util/delay.h>

  799.  #include <string.h>

  800.  #include <stdbool.h>

  801.  #define RH_HAVE_HARDWARE_SPI

  802.  #include <SPI.h>

  803. 

  804. // For Steve Childress port to ARM M4 w/CMSIS with STM's Hardware Abstraction lib. 

  805. // See ArduinoWorkarounds.h (not supplied)

  806. #elif (RH_PLATFORM == RH_PLATFORM_STM32F4_HAL) 

  807.  #include <ArduinoWorkarounds.h>

  808.  #include <stm32f4xx.h> // Also using ST's CubeMX to generate I/O and CPU setup source code for IAR/EWARM, not GCC ARM.

  809.  #include <stdint.h>

  810.  #include <string.h>

  811.  #include <math.h>

  812.  #define RH_HAVE_HARDWARE_SPI // using HAL (Hardware Abstraction Libraries from ST along with CMSIS, not arduino libs or pins concept.

  813. 

  814. #elif (RH_PLATFORM == RH_PLATFORM_RASPI)

  815.  #define RH_HAVE_HARDWARE_SPI

  816.  #define RH_HAVE_SERIAL

  817.  #define PROGMEM

  818.  #include <RHutil/RasPi.h>

  819.  #include <string.h>

  820.  //Define SS for CS0 or pin 24

  821.  #define SS 8

  822. 

  823. #elif (RH_PLATFORM == RH_PLATFORM_NRF51)

  824.  #define RH_HAVE_SERIAL

  825.  #define PROGMEM

  826.   #include <Arduino.h>

  827. 

  828. #elif (RH_PLATFORM == RH_PLATFORM_UNIX) 

  829.  // Simulate the sketch on Linux and OSX

  830.  #include <RHutil/simulator.h>

  831.  #define RH_HAVE_SERIAL

  832. #include <netinet/in.h> // For htons and friends

  833. 

  834. #else

  835.  #error Platform unknown!

  836. #endif

  837. 

  838. ////////////////////////////////////////////////////

  839. // This is an attempt to make a portable atomic block

  840. #if (RH_PLATFORM == RH_PLATFORM_ARDUINO)

  841. #if defined(__arm__)

  842.   #include <RHutil/atomic.h>

  843.  #else

  844.   #include <util/atomic.h>

  845.  #endif

  846.  #define ATOMIC_BLOCK_START     ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {

  847.  #define ATOMIC_BLOCK_END }

  848. #elif (RH_PLATFORM == RH_PLATFORM_CHIPKIT_CORE)

  849.  // UsingChipKIT Core on Arduino IDE

  850.  #define ATOMIC_BLOCK_START unsigned int __status = disableInterrupts(); {

  851.  #define ATOMIC_BLOCK_END } restoreInterrupts(__status);

  852. #elif (RH_PLATFORM == RH_PLATFORM_UNO32)

  853.  // Under old MPIDE, which has been discontinued:

  854.  #include <peripheral/int.h>

  855.  #define ATOMIC_BLOCK_START unsigned int __status = INTDisableInterrupts(); {

  856.  #define ATOMIC_BLOCK_END } INTRestoreInterrupts(__status);

  857. #elif (RH_PLATFORM == RH_PLATFORM_STM32F2) // Particle Photon with firmware-develop

  858.  #define ATOMIC_BLOCK_START { int __prev = HAL_disable_irq();

  859.  #define ATOMIC_BLOCK_END  HAL_enable_irq(__prev); }

  860. #elif (RH_PLATFORM == RH_PLATFORM_ESP8266)

  861. // See hardware/esp8266/2.0.0/cores/esp8266/Arduino.h

  862.  #define ATOMIC_BLOCK_START { uint32_t __savedPS = xt_rsil(15);

  863.  #define ATOMIC_BLOCK_END xt_wsr_ps(__savedPS);}

  864. #else 

  865.  // TO BE DONE:

  866.  #define ATOMIC_BLOCK_START

  867.  #define ATOMIC_BLOCK_END

  868. #endif

  869. 

  870. ////////////////////////////////////////////////////

  871. // Try to be compatible with systems that support yield() and multitasking

  872. // instead of spin-loops

  873. // Recent Arduino IDE or Teensy 3 has yield()

  874. #if (RH_PLATFORM == RH_PLATFORM_ARDUINO && ARDUINO >= 155 && !defined(RH_PLATFORM_ATTINY)) || (TEENSYDUINO && defined(__MK20DX128__))

  875.  #define YIELD yield();

  876. #elif (RH_PLATFORM == RH_PLATFORM_ESP8266)

  877. // ESP8266 also hash it

  878.  #define YIELD yield();

  879. #else

  880.  #define YIELD

  881. #endif

  882. 

  883. ////////////////////////////////////////////////////

  884. // digitalPinToInterrupt is not available prior to Arduino 1.5.6 and 1.0.6

  885. // See http://arduino.cc/en/Reference/attachInterrupt

  886. #ifndef NOT_AN_INTERRUPT

  887.  #define NOT_AN_INTERRUPT -1

  888. #endif

  889. #ifndef digitalPinToInterrupt

  890.  #if (RH_PLATFORM == RH_PLATFORM_ARDUINO) && !defined(__arm__)

  891. 

  892.   #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)

  893.    // Arduino Mega, Mega ADK, Mega Pro

  894.    // 2->0, 3->1, 21->2, 20->3, 19->4, 18->5

  895.    #define digitalPinToInterrupt(p) ((p) == 2 ? 0 : ((p) == 3 ? 1 : ((p) >= 18 && (p) <= 21 ? 23 - (p) : NOT_AN_INTERRUPT)))

  896. 

  897.   #elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) 

  898.    // Arduino 1284 and 1284P - See Manicbug and Optiboot

  899.    // 10->0, 11->1, 2->2

  900.    #define digitalPinToInterrupt(p) ((p) == 10 ? 0 : ((p) == 11 ? 1 : ((p) == 2 ? 2 : NOT_AN_INTERRUPT)))

  901. 

  902.   #elif defined(__AVR_ATmega32U4__)

  903.    // Leonardo, Yun, Micro, Pro Micro, Flora, Esplora

  904.    // 3->0, 2->1, 0->2, 1->3, 7->4

  905.    #define digitalPinToInterrupt(p) ((p) == 0 ? 2 : ((p) == 1 ? 3 : ((p) == 2 ? 1 : ((p) == 3 ? 0 : ((p) == 7 ? 4 : NOT_AN_INTERRUPT)))))

  906. 

  907.   #else

  908.    // All other arduino except Due:

  909.    // Serial Arduino, Extreme, NG, BT, Uno, Diecimila, Duemilanove, Nano, Menta, Pro, Mini 04, Fio, LilyPad, Ethernet etc

  910.    // 2->0, 3->1

  911.    #define digitalPinToInterrupt(p)  ((p) == 2 ? 0 : ((p) == 3 ? 1 : NOT_AN_INTERRUPT))

  912. 

  913.   #endif

  914.   

  915.  #elif (RH_PLATFORM == RH_PLATFORM_UNO32) || (RH_PLATFORM == RH_PLATFORM_CHIPKIT_CORE)

  916.   // Hmmm, this is correct for Uno32, but what about other boards on ChipKIT Core?

  917.   #define digitalPinToInterrupt(p) ((p) == 38 ? 0 : ((p) == 2 ? 1 : ((p) == 7 ? 2 : ((p) == 8 ? 3 : ((p) == 735 ? 4 : NOT_AN_INTERRUPT)))))

  918. 

  919.  #else

  920.   // Everything else (including Due and Teensy) interrupt number the same as the interrupt pin number

  921.   #define digitalPinToInterrupt(p) (p)

  922.  #endif

  923. #endif

  924. 

  925. // On some platforms, attachInterrupt() takes a pin number, not an interrupt number

  926. #if (RH_PLATFORM == RH_PLATFORM_ARDUINO) && defined (__arm__) && (defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_SAM_DUE))

  927.  #define RH_ATTACHINTERRUPT_TAKES_PIN_NUMBER

  928. #endif

  929. 

  930. // Slave select pin, some platforms such as ATTiny do not define it.

  931. #ifndef SS

  932.  #define SS 10

  933. #endif

  934. 

  935. // These defs cause trouble on some versions of Arduino

  936. #undef abs

  937. #undef round

  938. #undef double

  939. 

  940. // Sigh: there is no widespread adoption of htons and friends in the base code, only in some WiFi headers etc

  941. // that have a lot of excess baggage

  942. #if RH_PLATFORM != RH_PLATFORM_UNIX && !defined(htons)

  943. // #ifndef htons

  944. // These predefined macros availble on modern GCC compilers

  945.  #if   __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__

  946.   // Atmel processors

  947.   #define htons(x) ( ((x)<<8) | (((x)>>8)&0xFF) )

  948.   #define ntohs(x) htons(x)

  949.   #define htonl(x) ( ((x)<<24 & 0xFF000000UL) | \

  950.                    ((x)<< 8 & 0x00FF0000UL) | \

  951.                    ((x)>> 8 & 0x0000FF00UL) | \

  952.                    ((x)>>24 & 0x000000FFUL) )

  953.   #define ntohl(x) htonl(x)

  954. 

  955.  #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__

  956.   // Others

  957.   #define htons(x) (x)

  958.   #define ntohs(x) (x)

  959.   #define htonl(x) (x)

  960.   #define ntohl(x) (x)

  961. 

  962.  #else

  963.   #error "Dont know how to define htons and friends for this processor" 

  964.  #endif

  965. #endif

  966. 

  967. // This is the address that indicates a broadcast

  968. #define RH_BROADCAST_ADDRESS 0xff

  969. 

  970. #endif