One radio library to rule them all! Universal wireless communication library for embedded devices: rtty, sstv, ax25, aprs, 4fsk
 
 
 
Go to file
jgromes 88af8aeb12 [CC1101] Added missing comment 2019-05-24 20:29:22 +02:00
examples [XBee] Fixed typos in examples 2019-05-24 14:35:01 +02:00
extras Changed name to RadioLib 2019-02-08 15:58:29 +01:00
src [CC1101] Added missing comment 2019-05-24 20:29:22 +02:00
.gitignore Update gitignore 2019-05-12 19:19:40 +02:00
.travis.yml Travis fix 2019-05-24 16:04:21 +02:00
Doxyfile Added DoxyGen 2019-05-24 15:13:04 +02:00
README.md Update readme 2019-05-19 17:10:11 +02:00
keywords.txt [SX126x] Added FSK modulation parameters check 2019-05-21 11:19:16 +02:00
library.properties Added DoxyGen 2019-05-24 15:13:04 +02:00
license.txt Rename LICENSE to license.txt 2018-04-18 20:35:49 +02:00

README.md

RadioLib Build Status

One radio library to rule them all!

Universal wireless communication library for Arduino

RadioLib allows its users to integrate all sorts of different wireless communication modules into a single consistent system. Want to add a Bluetooth interface to your ZigBee network? Sure thing! Need to connect LoRa network to the Internet with a GSM module? RadioLib has got your back!

RadioLib was originally created as a driver for RadioShield, but it can be used to control as many different wireless modules as you like - or at least as many as your Arduino can handle!

Supported modules:

  • CC1101 FSK radio module
  • ES8266 WiFi module
  • HC05 Bluetooth module
  • JDY08 BLE module
  • RF69 FSK/OOK radio module
  • RFM9x series LoRa modules (RFM95, RM96, RFM97, RFM98)
  • SX127x series LoRa modules (SX1272, SX1273, SX1276, SX1277, SX1278, SX1279)
  • SX126x series LoRa modules (SX1261, SX1262, SX1268)
  • SX1231 FSK/OOK radio module
  • XBee modules (S2B)

Supported protocols:

  • MQTT for modules: ESP8266
  • HTTP for modules: ESP8266
  • RTTY for modules: SX127x, RFM9x, SX126x, RF69, SX1231 and CC1101
  • Morse Code for modules: SX127x, RFM9x, SX126x, RF69, SX1231 and CC1101

In development:

  • SIM800C GSM module
  • nRF24L01 2.4 GHz module
  • LoRaWAN protocol for SX127x, RFM9x and SX126x modules
  • and more!

Frequently Asked Questions

Where should I start?

First of all, take a look at the examples and the Wiki - especially the Basics page. There's a lot of useful information over there. Also, you should check out RadioShield - open source Arduino shield that will allow you to easily connect any two wireless modules supported by RadioLib!

RadioLib doesn't support my module! What should I do?

Start by creating new issue (if it doesn't exist yet). If you have some experience with Arduino and C/C++ in general, you can try to add the support yourself! Use the template files in /extras/ folder to get started. This is by far the fastest way to implement new modules into RadioLib, since I can't be working on everything all the time. If you don't trust your programming skills enough to have a go at it yourself, don't worry. I will try to implement all requested modules, but it will take me a while.