Project

# Introduction to the RFM69HW Transceiver

November 05, 2015 by Benjamin Crabtree

## This handy introduction teaches you all about the RFM69HW transceiver module using two circuits running a wireless version of the "blinky" code.

### RFM69HW Tranceivers

Engineers are designing more and more circuits that make use of some form of wireless communication to achieve a level of convenience and connectivity not feasible with wired options. In the designer’s quest to go wireless, a few options present themselves which perform different features. 2.4GHz transceivers can send and receive large amounts of data and can operate with very small antennas, but they suffer from a comparatively short range with regard to lower frequency transceivers as well as a level of complexity and cost that might be overkill for many projects. For projects where low throughput is acceptable, the RFM69HW series transceivers provide a less complex solution which can interface with everything from the humble PIC up to a modern desktop PC and everything in between. The RFM transceiver can be purchased in 433MHz, 868MHz, or 915Mhz license-free ISM band for about \$4, and can operate using FSK, GFSK, MSK, GMSK and OOK modulations. The power consumption is extremely low, yet these transceivers can communicate over several hundred meters given adequate antennae. These features make this device an excellent candidate for adding wireless connectivity to battery powered or remote projects for a very low cost investment. This project will be part one of a series introducing a range of applications for the RFM transceivers; in this case we will be setting up the transceivers to wirelessly enact the time-honored embedded systems equivalent of “Hello World!”- the “Blinky” program.

### What You Need

For teaching purposes, we will be implementing this code using Atmel328 microprocessors running the Arduino bootloader. I happen to have a stack of 16Mhz Pro Mini V2’s as seen below which will work after jumpering the 3.3 Volt selector, with Arduino you can use pretty much any board and get the same result- however the board you choose must be able to run on 3.3 Volts as the RFM chip can only operate on a maximum of 3.3 Volts. If you absolutely must use a 5 Volt Arduino you will need a logic level converter.

You also need the RFM chip itself, with the 915MHz 69HW model pictured below.

It is not necessary to use this identical model; you may choose other models or frequencies, but you will need to tweak the code to accommodate this. The code will be commented in these places for ease of modification.

You will also need a method of programming and powering the boards; if you are using an UNO or other Arduino with built-in USB then you have this requirement covered. In my case I need to use FTDI serial breakout boards, as the Pro Mini’s are only populated with the processor itself and a few housekeeping components.

In addition to these main components, you will of course need an LED, a resistor (for LED ballast- choose accordingly), a momentary push button, jumper wire, and prototyping boards.

### Setup

Now that we have all the parts, we can assemble the circuit. Below is the wiring diagram:

The momentary button should be bridging pin 3 and ground, the LED should be attached to pin 9, and the data pins NSS, MOSI, MISO, and SCK should connect to pins 10, 11, 12, 13 in that order.  The antenna can be a real antenna, or just a piece of un-terminated wire. Make two of this identical circuit and either device can be set up as the sender or receiver. Your circuits should look something like this:

### Run The Code

With circuits in hand, it’s time to do some programming. You will need two libraries written to run the RFM chips on an Arduino, RFM69.h and LowPower.h; they can be obtained from https://www.github.com/lowpowerlab/rfm69 and https://github.com/lowpowerlab/lowpower respectively. Install these libraries and copy the following code into your IDE:

//RFM69HW Blinky Code
//This program is a highly simplified version of the program by Felix from LowPowerLab
//A button is pushed on the sender unit which toggles an LED on the receiver
#include <RFM69.h>    //get it here: https://www.github.com/lowpowerlab/rfm69
#include <SPI.h>
#include <LowPower.h> //get library from: https://github.com/lowpowerlab/lowpower

//*********************************************************************************************
// *********** IMPORTANT SETTINGS - YOU MUST CHANGE/ONFIGURE TO FIT YOUR HARDWARE *************
//*********************************************************************************************
//This part of the code simply sets up the parameters we want the chip to use
// these parameters allow you to have multiple networks, channels, and encryption keys
#define NETWORKID     100  //the same on all nodes that talk to each other
#define SENDER        2    // you could for example, have multiple senders
#define NODEID        RECEIVER  //change to "SENDER" if this is the sender node (the one with the button)
//#define FREQUENCY     RF69_433MHZ
//#define FREQUENCY     RF69_868MHZ
#define FREQUENCY     RF69_915MHZ
#define ENCRYPTKEY    "sampleEncryptKey" //exactly the same 16 characters/bytes on all nodes!
#define IS_RFM69HW    //uncomment only for RFM69HW! Remove/comment if you have RFM69W!
//*********************************************************************************************
#define SERIAL_BAUD   9600

//This part defines the LED pin and button pin
#define LED             9 //LED on D9
#define BUTTON_INT      1 //user button on interrupt 1 (D3)
#define BUTTON_PIN      3 //user button on interrupt 1 (D3)
#define RX_TOGGLE_PIN   7 //GPIO to toggle on the RECEIVER

// the setup contains the start-up procedure and some useful serial data
void setup() {
Serial.begin(SERIAL_BAUD);
#ifdef IS_RFM69HW
#endif
char buff[50];
sprintf(buff, "\nListening at %d Mhz...", FREQUENCY==RF69_433MHZ ? 433 : FREQUENCY==RF69_868MHZ ? 868 : 915);
Serial.println(buff);
Serial.flush();
pinMode(BUTTON_PIN, INPUT_PULLUP);
pinMode(LED, OUTPUT);
attachInterrupt(BUTTON_INT, handleButton, FALLING);

pinMode(RX_TOGGLE_PIN, OUTPUT);

}

//******** THIS IS INTERRUPT BASED DEBOUNCING FOR BUTTON ATTACHED TO D3 (INTERRUPT 1)
#define FLAG_INTERRUPT 0x01
volatile int mainEventFlags = 0;
boolean buttonPressed = false;
void handleButton()
{
mainEventFlags |= FLAG_INTERRUPT;
}

byte LEDSTATE=LOW; //LOW=0
void loop() {
//******** THIS IS INTERRUPT BASED DEBOUNCING FOR BUTTON ATTACHED TO D3 (INTERRUPT 1)
if (mainEventFlags & FLAG_INTERRUPT)
{
mainEventFlags &= ~FLAG_INTERRUPT;
buttonPressed=true;
}
}

if (buttonPressed)
{
Serial.println("Button pressed!");
buttonPressed = false;

if (radio.sendWithRetry(RECEIVER, "All About Circuits", 18)) //target node Id, message as string or byte array, message length
delay(100);

}

//check if something was received (could be an interrupt from the radio)
{
Serial.println();

if(LEDSTATE==LOW)
LEDSTATE=HIGH;
else LEDSTATE=LOW;
digitalWrite(LED, LEDSTATE);
digitalWrite(RX_TOGGLE_PIN, LEDSTATE);

//check if sender wanted an ACK
{
Serial.print(" - ACK sent");
}
}

Serial.flush(); //make sure all serial data is clocked out before sleeping the MCU
LowPower.powerDown(SLEEP_8S, ADC_OFF, BOD_ON); //sleep Arduino in low power mode (to save battery)
}


RFM.zip

The code is commented to describe its operation, but here is a basic breakdown of what is going on:

#### 1. Include the libraries

These are the libraries linked to earlier, in addition to the standard SPI.h library for serial communication.

#### 2. Define the constants

Tell the chip who it is, what network it is on, what its encryption code is, whether it is the sender or receiver, which of a possible set of receivers/senders the unit is, etc.

​  This is the housekeeping step where all those parameters we just defined get applied, in addition to setting up the serial monitor for debugging purposes.

#### 4. Go to sleep and wait for an interrupt

Using an interrupt on the button and putting the unit into sleep helps to save power while the unit is idling. Interrupts are a highly efficient tool to wake a device upon an event, and allow a device to do other things in the meantime before and after the interrupt takes place.

#### 5. Transmit upon an interrupt flag

This will send a message to the receiver after the sender's button is pushed. In this case the message is "All About Circuits."

The receiver checks and confirms that it has received a message. It then prints the message to serial, and also prints the RSSI (Received Signal Strength Indicator) to let you know how strong the signal was in dBm. The receiver then toggles the LED to let the user know a message was received.

#### 7. Acknowledge

Send an ACK bit back to the sender to let it know that the message was received.

#### 8. Sleep

Put the device back into a low power sleep mode to conserve battery and wait for another interrupt.

If you hook up your receiving unit to your computer to use the serial monitor terminal you should see this after pressing the button a few times:

In addition, the LED should blink on and off as you press the button. Readers with sharp eyes may have noticed something interesting about this serial monitor box: the baud rate is set to 19200 while the baud rate in the code is set to 9600. This is because the Pro Mini I am using is running at 16MHz with a 3.3 volt supply, and the Arduino IDE on has an option for a Pro Mini running at 8MHz with a 3.3 volt supply. To compensate for this, the baud rate on the serial monitor must be set to double the baud rate defined in the code.

The applications of these modules are tremendous for hobbyists and engineers alike: a simple, cheap, powerful digital transceiver that can be interfaced to almost anything. I have seen these used for home automation modules, remote weather stations, drones and various remote-controlled devices, vehicle proximity detectors-- the list goes on and on. The next article in this series will focus on building a solar powered weather monitor that sends data back to a hub to display on a small screen- stay tuned!

Give this project a try for yourself! Get the BOM.

• R
ralphubok March 16, 2016

Thank you for the article. Very useful article

Like.
• R
ralphubok March 16, 2016

Thank you for the article. Very useful article

Like.
• F
federico70 July 22, 2016

Hi I’ve prepared a Tx (SENDER) and Rx (RECEIVER) but, apart the listening and button press recognition, no message is ever received. Is the code really tested? Best regards, Federico

Like.