This is the RadioHead Packet Radio library for embedded microprocessors. It provides a complete object-oriented library for sending and receiving packetized messages via a variety of common data radios and other transports on a range of embedded microprocessors.
The version of the package that this documentation refers to can be downloaded from http://www.airspayce.com/mikem/arduino/RadioHead/RadioHead-1.37.zip You can find the latest version at http://www.airspayce.com/mikem/arduino/RadioHead
You can also find online help and disussion at http://groups.google.com/group/radiohead-arduino Please use that group for all questions and discussions on this topic. Do not contact the author directly, unless it is to discuss commercial licensing. Before asking a question or reporting a bug, please read http://www.catb.org/esr/faqs/smart-questions.html
RadioHead consists of 2 main sets of classes: Drivers and Managers.
- Drivers provide low level access to a range of different packet radios and other packetized message transports.
- Managers provide high level message sending and receiving facilities for a range of different requirements.
Every RadioHead program will have an instance of a Driver to provide access to the data radio or transport, and a Manager that uses that driver to send and receive messages for the application. The programmer is required to instantiate a Driver and a Manager, and to initialise the Manager. Thereafter the facilities of the Manager can be used to send and receive messages.
It is also possible to use a Driver on its own, without a Manager, although this only allows unaddressed, unreliable transport via the Driver's facilities.
In some specialised use cases, it is possible to instantiate more than one Driver and more than one Manager.
A range of different common embedded microprocessor platforms are supported, allowing your project to run on your choice of processor.
Example programs are included to show the main modes of use.
The following Drivers are provided:
- RH_RF22 Works with Hope-RF RF22B and RF23B based transceivers, and compatible chips and modules, including the RFM22B transceiver module such as this bare module: http://www.sparkfun.com/products/10153 and this shield: http://www.sparkfun.com/products/11018 and this board: http://www.anarduino.com/miniwireless and RF23BP modules such as: http://www.anarduino.com/details.jsp?pid=130 Supports GFSK, FSK and OOK. Access to other chip features such as on-chip temperature measurement, analog-digital converter, transmitter power control etc is also provided.
- RH_RF24 Works with Silicon Labs Si4460/4461/4463/4464 family of transceivers chip, and the equivalent HopeRF RF24/26/27 family of chips and the HopeRF RFM24W/26W/27W modules. Supports GFSK, FSK and OOK. Access to other chip features such as on-chip temperature measurement, analog-digital converter, transmitter power control etc is also provided.
- RH_RF69 Works with Hope-RF RF69B based radio modules, such as the RFM69 module, (as used on the excellent Moteino and Moteino-USB boards from LowPowerLab http://lowpowerlab.com/moteino/ ) and compatible chips and modules such as RFM69W, RFM69HW, RFM69CW, RFM69HCW (Semtech SX1231, SX1231H). Also works with Anarduino MiniWireless -CW and -HW boards http://www.anarduino.com/miniwireless/ including the marvellous high powered MinWireless-HW (with 20dBm output for excellent range). Supports GFSK, FSK.
- RH_NRF24 Works with Nordic nRF24 based 2.4GHz radio modules, such as nRF24L01 and others. Also works with Hope-RF RFM73 and compatible devices (such as BK2423). nRF24L01 and RFM73 can interoperate with each other.
- RH_NRF905 Works with Nordic nRF905 based 433/868/915 MHz radio modules.
- RH_RF95 Works with Semtech SX1276/77/78 and HopeRF RFM95/96/97/98 and other similar LoRa capable radios. Supports Long Range (LoRa) with spread spectrum frequency hopping, large payloads etc. FSK/GFSK/OOK modes are not (yet) supported.
- RH_ASK Works with a range of inexpensive ASK (amplitude shift keying) RF transceivers such as RX-B1 (also known as ST-RX04-ASK) receiver; TX-C1 transmitter and DR3100 transceiver; FS1000A/XY-MK-5V transceiver; HopeRF RFM83C / RFM85. Supports ASK (OOK).
- RH_Serial Works with RS232, RS422, RS485, RS488 and other point-to-point and multidropped serial connections, or with TTL serial UARTs such as those on Arduino and many other processors, or with data radios with a serial port interface. RH_Serial provides packetization and error detection over any hardware or virtual serial connection.
- RH_TCP For use with simulated sketches compiled and running on Linux. Works with tools/etherSimulator.pl to pass messages between simulated sketches, allowing testing of Manager classes on Linux and without need for real radios or other transport hardware.
Drivers can be used on their own to provide unaddressed, unreliable datagrams. All drivers have the same identical API. Or you can use any Driver with any of the Managers described below.
We welcome contributions of well tested and well documented code to support other transports.
The following Mangers are provided:
- RHDatagram Addressed, unreliable variable length messages, with optional broadcast facilities.
- RHReliableDatagram Addressed, reliable, retransmitted, acknowledged variable length messages.
- RHRouter Multi-hop delivery from source node to destination node via 0 or more intermediate nodes, with manual routing.
- RHMesh Multi-hop delivery with automatic route discovery and rediscovery.
Any Manager may be used with any Driver.
A range of platforms is supported:
Other platforms are partially supported, such as Generic AVR 8 bit processors, MSP430. We welcome contributions that will expand the range of supported platforms.
RadioHead was created in April 2014, substantially based on code from some of our other earlier libraries:
- RHMesh, RHRouter, RHReliableDatagram and RHDatagram are derived from the RF22 library version 1.39.
- RH_RF22 is derived from the RF22 library version 1.39.
- RH_RF69 is derived from the RF69 library version 1.2.
- RH_ASK is based on the VirtualWire library version 1.26, after significant conversion to C++.
- RH_Serial was new.
- RH_NRF24 is based on the NRF24 library version 1.12, with some significant changes.
During this combination and redevelopment, we have tried to retain all the processor dependencies and support from the libraries that were contributed by other people. However not all platforms can be tested by us, so if you find that support from some platform has not been successfully migrated, please feel free to fix it and send us a patch.
Users of RHMesh, RHRouter, RHReliableDatagram and RHDatagram in the previous RF22 library will find that their existing code will run mostly without modification. See the RH_RF22 documentation for more details.
Install in the usual way: unzip the distribution zip file to the libraries sub-folder of your sketchbook. The example sketches will be visible in in your Arduino, mpide, maple-ide or whatever. http://arduino.cc/en/Guide/Libraries
- Compatible Hardware Suppliers
We have had good experiences with the following suppliers of RadioHead compatible hardware:
This library is offered under a free GPL license for those who want to use it that way. We try hard to keep it up to date, fix bugs and to provide free support. If this library has helped you save time or money, please consider donating at http://www.airspayce.com or here:
RadioHead is a trademark of AirSpayce Pty Ltd. The RadioHead mark was first used on April 12 2014 for international trade, and is used only in relation to data communications hardware and software and related services. It is not to be confused with any other similar marks covering other goods and services.
This software is Copyright (C) 2011-2014 Mike McCauley. Use is subject to license conditions. The main licensing options available are GPL V2 or Commercial:
- Open Source Licensing GPL V2
This is the appropriate option if you want to share the source code of your application with everyone you distribute it to, and you also want to give them the right to share who uses it. If you wish to use this software under Open Source Licensing, you must contribute all your source code to the open source community in accordance with the GPL Version 2 when your application is distributed. See http://www.gnu.org/copyleft/gpl.html
- Commercial Licensing
This is the appropriate option if you are creating proprietary applications and you are not prepared to distribute and share the source code of your application. Contact info@.firstname.lastname@example.org@m.payce.nosp@m..com for details (do not use this address for anything other than commercial license enquiries. For all other queries, using the RadioHead mailing list).
- Revision History
- 1.1 2014-04-14
Initial public release
Fixed various typos.
Added links to compatible Anarduino products.
Added RHNRFSPIDriver, RH_NRF24 classes to support Nordic NRF24 based radios.
Various documentation fixups.
RHDatagram::setThisAddress() did not set the local copy of thisAddress. Reported by Steve Childress.
Fixed a problem on Teensy with RF22 and RF69, where the interrupt pin needs to be set for input,
else pin interrupt doesn't work properly. Reported by Steve Childress and patched by Adrien van den Bossche. Thanks.
Fixed a problem that prevented RF22 honouring setPromiscuous(true). Reported by Steve Childress.
Updated documentation to clarify some issues to do with maximum message lengths reported by Steve Childress.
Added support for yield() on systems that support it (currently Arduino 1.5.5 and later) so that spin-loops can suport multitasking. Suggested by Steve Childress.
Added RH_RF22::setGpioReversed() so the reversal it can be configured at run-time after radio initialisation. It must now be called after init(). Suggested by Steve Childress.
Fixed further problems with Teensy compatibility for RH_RF22. Tested on Teensy 3.1. The example/rf22_* examples now run out of the box with the wiring connections as documented for Teensy in RH_RF22.
Added YIELDs to spin-loops in RHRouter, RHMesh and RHReliableDatagram, RH_NRF24.
Tested RH_Serial examples with Teensy 3.1: they now run out of the box.
Tested RH_ASK examples with Teensy 3.1: they now run out of the box.
Reduced default SPI speed for NRF24 from 8MHz to 1MHz on Teensy, to improve reliability when poor wiring is in use.
on some devices such as Teensy.
Tested RH_NRF24 examples with Teensy 3.1: they now run out of the box.
Added support for Nordic Semiconductor nRF905 transceiver with RH_NRF905 driver. Also added examples for nRF905 and tested on Teensy 3.1
NRF905 examples were missing
Added support for Arduino Due. Tested with RH_NRF905, RH_Serial, RH_ASK. IMPORTANT CHANGE to interrupt pins on Arduino with RH_RF22 and RH_RF69 constructors: previously, you had to specify the interrupt number not the interrupt pin. Arduinos and Uno32 are now consistent with all other platforms: you must specify the interrupt pin number. Default changed to pin 2 (a common choice with RF22 shields). Removed examples/maple/maple_rf22_reliable_datagram_client and examples/maple/maple_rf22_reliable_datagram_client since the rf22 examples now work out of the box with Flymaple. Removed examples/uno32/uno32_rf22_reliable_datagram_client and examples/uno32/uno32_rf22_reliable_datagram_client since the rf22 examples now work out of the box with ChipKit Uno32.
Added support for YIELD in Teensy 2 and 3, suggested by Steve Childress.
Documentation updates. Clarify use of headers and Flags
Fixed misalignment in RH_RF69 between ModemConfigChoice definitions and the implemented choices which meant you didnt get the choice you thought and GFSK_Rb55555Fd50 hung the transmitter.
Preliminary work on Linux simulator.
Added support for using Timer 2 instead of Timer 1 on Arduino in RH_ASK when RH_ASK_ARDUINO_USE_TIMER2 is defined. With the kind assistance of Luc Small. Thanks!
Updated comments in RHReliableDatagram concerning servers, retries, timeouts and delays. Fixed an error in RHReliableDatagram where recvfrom return value was not checked. Reported by Steve Childress.
Added Linux simulator support so simple RadioHead sketches can be compiled and run on Linux.
Added RH_TCP driver to permit message passing between simulated sketches on Linux.
Added example simulator sketches.
Added tools/etherSimulator.pl, a simulator of the 'Luminiferous Ether' that passes messages between simulated sketches and can simulate random message loss etc.
Fixed a number of typos and improved some documentation.
Added support for RFM73 modules to RH_NRF24. These 2 radios are very similar, anc can interoperate with each other. Added new RH_NRF24::TransmitPower enums for the RFM73, which has a different range of available powers
reduced the default SPI bus speed for RH_NRF24 to 1MHz, since so many modules and CPU have problems with 8MHz.
Testing RH_RF22 with RFM23BP and 3.3V Teensy 3.1 and 5V Arduinos. Updated documentation with respect to GPIO and antenna control pins for RFM23. Updated documentation with respect to transmitter power control for RFM23
Fixed a problem with RH_RF22 driver, where GPIO TX and RX pins were not configured during initialisation, causing poor transmit power and sensitivity on those RF22/RF23 devices where GPIO controls the antenna selection pins.
Testing with RF69HW and the RH_RF69 driver. Works well with the Anarduino MiniWireless -CW and -HW boards http://www.anarduino.com/miniwireless/ including the marvellous high powered MinWireless-HW (with 20dBm output for excellent range).
Clarified documentation of RH_RF69::setTxPower values for different models of RF69.
Retransmission count precision increased to uin32_t.
Added data about actual power measurements from RFM22 module.
setHeaderFlags(flags) changed to setHeaderFlags(set, clear), enabling any flags to be individually set and cleared by either RadioHead or application code. Requested by Steve Childress.
Fixed power output setting for boost power on RF69HW for 18, 19 and 20dBm.
Added data about actual power measurements from RFM69W and RFM69HW modules.
RH_RF69::init() now always sets the PA boost back to the default settings, else can get invalid PA power modes after uploading new sketches without a power cycle. Reported by Bryan.
Added new macros RH_VERSION_MAJOR RH_VERSION_MINOR, with automatic maintenance in Makefile.
Improvements to RH_TCP: constructor now honours the server argument in the form "servername:port".
Added YIELD to RHReliableDatagram::recvfromAckTimeout. Requested by Steve Childress.
Fixed a problem with RH_RF22 reliable datagram acknowledgements that was introduced in version 1.13. Reported by Steve Childress.
Fixed a problem with the RadioHead .zip link.
Fixed RH_RF22 so that lastRssi() returns the signal strength in dBm. Suggested by Steve Childress.
Added support for getLastPreambleTime() to RH_RF69. Requested by Steve Childress.
RH_NRF24::init() now checks if there is a device connected and responding, else init() will fail. Suggested by Steve Brown.
RHSoftwareSPI now initialises default values for SPI pins MOSI = 12, MISO = 11 and SCK = 13.
Fixed some problems that prevented RH_NRF24 working with mixed software and hardware SPI on different devices: a race condition due to slow SPI transfers and fast acknowledgement.
Fixed a debug typo in RHReliableDatagram that was introduced in 1.16.
RH_NRF24 now sets default power, data rate and channel in init(), in case another app has previously set different values without powerdown.
Caution: there are still problems with RH_NRF24 and Software SPI. Do not use.
Improvements to performance of RH_NRF24 statusRead, allowing RH_NRF24 and Software SPI to operate on slow devices like Arduino Uno.
Added examples ask_transmitter.pde and ask_receiver.pde.
Fixed an error in the RH_RF22 doc for connection of Teensy to RF22.
Improved documentation of start symbol bit patterns in RH_ASK.cpp
Fixed a problem with compiling on platforms such as ATTiny where SS is not defined.
Added YIELD to RHMesh::recvfromAckTimeout().
Fixed an issue in RH_Serial where characters might be lost with back-to-back frames. Suggested by Steve Childress.
Brought previous RHutil/crc16.h code into mainline RHCRC.cpp to prevent name collisions with other similarly named code in other libraries. Suggested by Steve Childress.
Fix SPI bus speed errors on 8MHz Arduinos.
Update RH_ASK documentation for common wiring connections.
Testing RH_ASK with HopeRF RFM83C/RFM85 courtesy Anarduino http://www.anarduino.com/
Testing RH_NRF24 with Itead Studio IBoard Pro http://imall.iteadstudio.com/iboard-pro.html using both hardware SPI on the ITDB02 Parallel LCD Module Interface pins and software SPI on the nRF24L01+ Module Interface pins. Documented wiring required.
Added support for AVR 1284 and 1284p, contributed by Peter Scargill. Added support for Semtech SX1276/77/78 and HopeRF RFM95/96/97/98 and other similar LoRa capable radios in LoRa mode only. Tested with the excellent MiniWirelessLoRa from Anarduino http://www.anarduino.com/miniwireless
Changed the default modulation for RH_RF69 to GFSK_Rb250Fd250, since the previous default was not very reliable.
Documented RH_RF95 range tests.
Improvements to RH_RF22 RSSI readings so that lastRssi correctly returns the last message in dBm.
1.24 2014-07-18 Added support for building RadioHead for STM32F4 Discovery boards, using the native STM Firmware libraries, in order to support Codec2WalkieTalkie (http://www.airspayce.com/mikem/Codec2WalkieTalkie) and other projects. See STM32ArduinoCompat.
Default modulation for RH_RF95 was incorrectly set to a very slow Bw125Cr48Sf4096
1.25 2014-07-25 The available() function will longer terminate any current transmission, and force receive mode. Now, if there is no unprocessed incoming message abd an outgoing message is currently being transmitted, available() will return false.
RHRouter::sendtoWait(uint8_t*, uint8_t, uint8_t, uint8_t) renamed to sendtoFromSourceWait due to conflicts with new sendtoWait() with optional flags.
RHMEsh and RHRouter already supported end-to-end application layer flags, but RHMesh::sendtoWait() and RHRouter::sendToWait have now been extended to expose a way to send optional application layer flags.
1.26 2014-08-12 Fixed a Teensy 2.0 compile problem due yield() not available on Teensy < 3.0.
Adjusted the algorithm of RH_RF69::temperatureRead() to more closely reflect reality.
Added functions to RHGenericDriver to get driver packet statistics: rxBad(), rxGood(), txGood().
RH_RF95::printRegisters() was incorrectly printing the register index instead of the address. Reported by Phang Moh Lim.
RH_RF95, added definitions for some more registers that are usable in LoRa mode.
RH_RF95::setTxPower now uses RH_RF95_PA_DAC_ENABLE to achieve 21, 22 and 23dBm.
RH_RF95, updated power output measurements.
Testing RH_RF69 on Teensy 3.1 with RF69 on PJRC breakout board. OK.
Improvements so RadioHead will build under Arduino where SPI is not supported, such as ATTiny.
Improvements so RadioHead will build for ATTiny using Arduino IDE and tinycore arduino-tiny-0100-0018.zip.
Testing RH_ASK on ATTiny85. Reduced RAM footprint. Added helpful documentation. Caution: RAM memory is very tight on this platform.
RH_RF22 and RH_RF69, added setIdleMode() function to allow the idle mode radio operating state to be controlled for lower idle power consumption at the expense of slower transitions to TX and RX.
1.27 2014-08-13 All RH_RF69 modulation schemes now have data whitening enabled by default.
Tested and added a number of OOK modulation schemes to RH_RF69 Modem config table.
Minor improvements to a number of the faster RH_RF69 modulation schemes, but some slower ones are still not working correctly.
1.28 2014-08-20 Added new RH_RF24 driver to support Si446x, RF24/26/26, RFM24/26/27 family of transceivers. Tested with the excellent Anarduino Mini and RFM24W and RFM26W with the generous assistance of the good people at Anarduino http://www.anarduino.com.
1.29 2014-08-21 Fixed a compile error in RH_RF24 introduced at the last minute in hte previous release.
Improvements to RH_RF69 modulation schemes: now include the AFCBW in teh ModemConfig.
ModemConfig RH_RF69::FSK_Rb2Fd5 and RH_RF69::GFSK_Rb2Fd5 are now working.
1.30 2014-08-25 Fixed some compile problems with ATtiny84 on Arduino 1.5.5 reported by Glen Cook.
1.31 2014-08-27 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 since the previous ones were unreliable (they had modulation indexes of 1).
1.32 2014-08-28 Testing with RedBearLab Blend board http://redbearlab.com/blend/. OK.
Changed more RH_RF69 FSK and GFSK slowish modulations to have modulation index of 2 instead of 1. This required chnaging the symbolic names.
1.33 2014-09-01 Added support for sleep mode in RHGeneric driver, with new mode RHModeSleep and new virtual function sleep().
Added support for sleep to RH_RF69, RH_RF22, RH_NRF24, RH_RF24, RH_RF95 drivers.
1.34 2014-09-19 Fixed compile errors in example rf22_router_test.
Fixed a problem with RH_NRF24::setNetworkAddress, also improvements to RH_NRF24 register printing. Patched by Yveaux.
Improvements to RH_NRF24 initialisation for version 2.0 silicon.
Fixed problem with ambigiguous print call in RH_RFM69 when compiling for Codec2.
Fixed a problem with RH_NRF24 on RFM73 where the LNA gain was not set properly, reducing the sensitivity of the receiver.
1.35 2014-09-19 Fixed a problem with interrupt setup on RH_RF95 with Teensy3.1. Reported by AD.
1.36 2014-09-22 Improvements to interrupt pin assignments for AVR_ATmega1284 and__AVR_ATmega1284P__, provided by Peter Scargill.
Work around a bug in Arduino 1.0.6 where digitalPinToInterrupt is defined but NOT_AN_INTERRUPT is not.
1.37 2014-10-19 Updated doc for connecting RH_NRF24 to Arduino Mega.
Changes to RHGenericDriver::setHeaderFlags(), so that the default for the clear argument is now RH_FLAGS_APPLICATION_SPECIFIC, which is less surprising to users. Testing with the excellent MoteinoMEGA from LowPowerLab https://lowpowerlab.com/shop/moteinomega with on-board RFM69W.
- Mike McCauley. DO NOT CONTACT THE AUTHOR DIRECTLY. USE THE MAILING LIST GIVEN ABOVE