RFM69-Particle (community library)

Summary

Adjusted to work with Photon. Some updates in 2019 to work with 3rd gen devices but not fully tested. Derived from LowPowerLab's RFM69 library.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

##Forked library for Particle Photon use

• Is confirmed to work with Particle Photon. Some updates have been made to accommodate Gen 3 devices but it has not been fully confirmed if it works, see issues
• It can be used locally or in the Particle Web IDE (it is now included in the Community Libraries to add easily)
• A custom working example for Photon which uses serial and Particle Console Logs for easy verification that it works.
• If you're using ATC or Registers make sure you include these statements in Particle IDE as "using library in app" does not add them automatically: #include "RFM69-Particle/RFM69_ATC.h" #include "RFM69-Particle/RFM69registers.h"
• For ATC to function correctly make sure you use the latest library version (version 0.0.2 or later)

RFM69 Library

By Felix Rusu, LowPowerLab.com
RFM69 library for RFM69W, RFM69HW, RFM69CW, RFM69HCW (semtech SX1231, SX1231H)
The latest examples, new features and bug fixes are found in the original repository of this library.

##License GPL 3.0, please see the License.txt file for details. Be sure to include the same license with any fork or redistribution of this library.

##Features

• easy to use API with a few simple functions for basic usage
• 255 possible nodes on 256 possible networks
• 61 bytes max message length (limited to 61 to support AES hardware encryption)
• customizable transmit power (32 levels) for low-power transmission control
• sleep function for power saving
• automatic ACKs with the sendWithRetry() function
• hardware 128bit AES encryption
• hardware preamble, synch recognition and CRC check
• digital RSSI can be read at any time with readRSSI()
• interrupt driven
• tested on Moteino R3, R4, R4-USB (ATMega328p), MEGA (ATMega1284p)
• works with RFM69W, RFM69HW, RFM69CW, RFM69HCW, Semtech SX1231/SX1231H transceivers
• promiscuous mode allows any node to listen to any packet on same network

###Library Installation (Arduino IDE) Copy the content of this library in the "Arduino/libraries/RFM69" folder.
To find your Arduino folder go to File>Preferences in the Arduino IDE.
See this tutorial on Arduino libraries.

###Hardware & programming The easiest way to get started is with the well documented and supported Moteino microcontroller platform which is easily programmable from the Arduino IDE. This includes the Moteino, MoteinoUSB & MoteinoMEGA. RFM69 transceivers were extensively tested on Moteinos for the purpose of building internet of things (IoT) devices that can be controlled wirelessly. This platform has matured over time and there is now a dedicated page where you can review how these devices can interact with each other via a RaspberryPi gateway interface. Here's a video overview:
https://www.youtube.com/watch?v=YUUZ6k0pBHg
https://www.youtube.com/watch?v=I9MNZQgqKHA
https://www.youtube.com/watch?v=F15dEqZ4pMM

###Basic sample usage

• The Gateway example listens for incoming data from remote nodes and responds to any ACK requests
• The Node example is a loop that sends increasingly longer packets to the gateway and waits for an ACK each time
• More examples are added from time to time, check all the examples, visit the LowPowerLab blog for latest news and projects, and check out the LowPowerLab forums for projects and discussion

##Blog writeup See the library release blog post

##Why RFM69

• I have spent a lot of time developing this library for RFM69W/HW transceivers. I made it open source because I believe a lot of people can benefit from this new powerful transceiver. I hope others will also contribute and build on my work
• I have long researched alternative transceivers for RFM12B which is still an excellent transceiver but it is much lower output power and has limited built in features which need to be implemented in firmware (PREAMBLE, SYNC, CRC, packet engine, encryption etc).
• I wanted a transceiver that could still be very small, easy to use, and have the longer range that I needed
• RFM69 comes in 2 variants that have the same pinout layout: RFM69W (13dBm, 45mA TX) and RFM69HW (20dBm, 130mA TX). Other variants include the RFM69CW (up to 13dBm power) which is pin compatible with RFM12B, and RFM69HCW (20dBm output power).

##RFM69W range and antennas

• I have tested open-air range on these transceivers in various combinations.
• I am happy to say that a range of upwards of 350m can be achieved with the default settings provided in the library.Some users reported upwards of 500m by lowering the bitrate, and a forum user reported 1.5miles at 1.2Kbps: see this forum post and this blog page
• The caveat with these higher RF power units is that they need more DC power when they transmit. For battery powered motes, you will need to keep them powered down and only transmit periodically. Use the sleep() function to put the radios in low power mode and use the LowPower or Narcoleptic libraries to power down your Moteino/Arduino

Browse Library Files