From 2101203d07a4fbf412194dce973fd206f9e31899 Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 8 Feb 2019 15:58:29 +0100 Subject: [PATCH] Changed name to RadioLib --- .travis.yml | 2 +- README.md | 2 +- examples/CC1101_Transmit/CC1101_Transmit.ino | 6 ++--- examples/HC05/HC05.ino | 6 ++--- examples/HTTP_Get/HTTP_Get.ino | 6 ++--- examples/HTTP_Post/HTTP_Post.ino | 6 ++--- examples/JDY08/JDY08.ino | 6 ++--- examples/MQTT_Publish/MQTT_Publish.ino | 6 ++--- examples/MQTT_Subscribe/MQTT_Subscribe.ino | 6 ++--- examples/RF69_Receive/RF69_Receive.ino | 6 ++--- .../RF69_Receive_AES/RF69_Receive_AES.ino | 6 ++--- .../RF69_Receive_Address.ino | 6 ++--- .../RF69_Receive_Interrupt.ino | 19 ++++++++++++-- examples/RF69_Settings/RF69_Settings.ino | 10 +++---- examples/RF69_Transmit/RF69_Transmit.ino | 6 ++--- .../RF69_Transmit_AES/RF69_Transmit_AES.ino | 6 ++--- .../RF69_Transmit_Address.ino | 6 ++--- examples/RTTY_Transmit/RTTY_Transmit.ino | 9 ++++--- examples/SX1231_Receive/SX1231_Receive.ino | 6 ++--- examples/SX1231_Transmit/SX1231_Transmit.ino | 6 ++--- .../SX127x_ChannelActivityDetection.ino | 6 ++--- examples/SX127x_Receive/SX127x_Receive.ino | 6 ++--- .../SX127x_ReceiveInterrupt.ino | 6 ++--- examples/SX127x_Settings/SX127x_Settings.ino | 10 +++---- examples/SX127x_Transmit/SX127x_Transmit.ino | 6 ++--- .../SX127x_TransmitInterrupt.ino | 6 ++--- examples/XBee_Receive/XBee_Receive.ino | 6 ++--- examples/XBee_Transmit/XBee_Transmit.ino | 6 ++--- .../XBee_Transparent/XBee_Transparent.ino | 6 ++--- extras/ModuleTemplate.h | 6 ++--- keywords.txt | 8 +++--- library.properties | 10 +++---- src/ISerial.h | 4 +-- src/KiteLib.cpp | 8 ------ src/Module.h | 4 +-- src/RadioLib.cpp | 8 ++++++ src/{KiteLib.h => RadioLib.h} | 26 +++++++++---------- src/TypeDef.h | 8 +++--- src/modules/CC1101.cpp | 2 +- src/modules/CC1101.h | 4 +-- src/modules/ESP8266.h | 4 +-- src/modules/HC05.h | 4 +-- src/modules/JDY08.h | 4 +-- src/modules/RF69.cpp | 2 +- src/modules/RF69.h | 4 +-- src/modules/RFM95.h | 4 +-- src/modules/RFM96.h | 4 +-- src/modules/RFM97.h | 4 +-- src/modules/SX1231.cpp | 2 +- src/modules/SX1231.h | 4 +-- src/modules/SX1272.h | 4 +-- src/modules/SX1273.h | 4 +-- src/modules/SX1276.h | 4 +-- src/modules/SX1277.h | 4 +-- src/modules/SX1278.h | 4 +-- src/modules/SX1279.h | 4 +-- src/modules/SX127x.cpp | 4 +-- src/modules/SX127x.h | 6 ++--- src/modules/XBee.h | 4 +-- src/protocols/HTTP.h | 4 +-- src/protocols/MQTT.h | 4 +-- src/protocols/PhysicalLayer.h | 4 +-- src/protocols/RTTY.h | 4 +-- src/protocols/TransportLayer.h | 4 +-- 64 files changed, 194 insertions(+), 178 deletions(-) delete mode 100644 src/KiteLib.cpp create mode 100644 src/RadioLib.cpp rename src/{KiteLib.h => RadioLib.h} (69%) diff --git a/.travis.yml b/.travis.yml index 5a07dcd6..b1cb8622 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,7 +15,7 @@ before_install: - export PATH=$PATH:$HOME/arduino-ide install: - mkdir -p $HOME/Arduino/libraries - - ln -s $PWD $HOME/Arduino/libraries/KiteLib + - ln -s $PWD $HOME/Arduino/libraries/RadioLib script: # build all example sketches - cd examples diff --git a/README.md b/README.md index 1b6b4628..ea2df717 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# RadioLib [![Build Status](https://travis-ci.org/jgromes/KiteLib.svg?branch=master)](https://travis-ci.org/jgromes/KiteLib) +# RadioLib [![Build Status](https://travis-ci.org/jgromes/RadioLib.svg?branch=master)](https://travis-ci.org/jgromes/RadioLib) ### _One radio library to rule them all!_ diff --git a/examples/CC1101_Transmit/CC1101_Transmit.ino b/examples/CC1101_Transmit/CC1101_Transmit.ino index c22eea7b..c06c3a94 100644 --- a/examples/CC1101_Transmit/CC1101_Transmit.ino +++ b/examples/CC1101_Transmit/CC1101_Transmit.ino @@ -1,14 +1,14 @@ /* - KiteLib CC1101 Transmit Example + RadioLib CC1101 Transmit Example This example transmits packets using CC1101 FSK radio module. */ // include the library -#include +#include // CC1101 is in slot A on the shield -CC1101 cc = Kite.ModuleA; +CC1101 cc = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/HC05/HC05.ino b/examples/HC05/HC05.ino index 6ef31c98..f9e7e526 100644 --- a/examples/HC05/HC05.ino +++ b/examples/HC05/HC05.ino @@ -1,5 +1,5 @@ /* - KiteLib HC05 Example + RadioLib HC05 Example This example sends data using HC05 Bluetooth module. HC05 works exactly like a Serial line, data are sent to the paired device. @@ -7,10 +7,10 @@ */ // include the library -#include +#include // HC05 module is in slot A on the shield -HC05 bluetooth = Kite.ModuleA; +HC05 bluetooth = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/HTTP_Get/HTTP_Get.ino b/examples/HTTP_Get/HTTP_Get.ino index a4cfa1dd..f36cc226 100644 --- a/examples/HTTP_Get/HTTP_Get.ino +++ b/examples/HTTP_Get/HTTP_Get.ino @@ -1,5 +1,5 @@ /* - KiteLib HTTP GET Example + RadioLib HTTP GET Example This example sends HTTP GET request using ESP8266 WiFi module. @@ -11,10 +11,10 @@ */ // include the library -#include +#include // ESP8266 module is in slot A on the shield -ESP8266 wifi = Kite.ModuleA; +ESP8266 wifi = RadioShield.ModuleA; // create HTTP client instance using the wifi module // the default port used for HTTP is 80 diff --git a/examples/HTTP_Post/HTTP_Post.ino b/examples/HTTP_Post/HTTP_Post.ino index be30c1ad..cda01ae4 100644 --- a/examples/HTTP_Post/HTTP_Post.ino +++ b/examples/HTTP_Post/HTTP_Post.ino @@ -1,5 +1,5 @@ /* - KiteLib HTTP POST Example + RadioLib HTTP POST Example This example sends HTTP POST request using ESP8266 WiFi module. @@ -11,10 +11,10 @@ */ // include the library -#include +#include // ESP8266 module is in slot A on the shield -ESP8266 wifi = Kite.ModuleA; +ESP8266 wifi = RadioShield.ModuleA; // create HTTP client instance using the wifi module // the default port used for HTTP is 80 diff --git a/examples/JDY08/JDY08.ino b/examples/JDY08/JDY08.ino index 41dcec0e..c8777772 100644 --- a/examples/JDY08/JDY08.ino +++ b/examples/JDY08/JDY08.ino @@ -1,14 +1,14 @@ /* - KiteLib JDY08 Example + RadioLib JDY08 Example This example sends data using JDY08 Bluetooth module. */ // include the library -#include +#include // JDY08 module is in slot A on the shield -JDY08 ble = Kite.ModuleA; +JDY08 ble = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/MQTT_Publish/MQTT_Publish.ino b/examples/MQTT_Publish/MQTT_Publish.ino index 7e089148..e5e85051 100644 --- a/examples/MQTT_Publish/MQTT_Publish.ino +++ b/examples/MQTT_Publish/MQTT_Publish.ino @@ -1,5 +1,5 @@ /* - KiteLib MQTT Publish Example + RadioLib MQTT Publish Example This example publishes MQTT messages using ESP8266 WiFi module. @@ -11,10 +11,10 @@ */ // include the library -#include +#include // ESP8266 module is in slot A on the shield -ESP8266 wifi = Kite.ModuleA; +ESP8266 wifi = RadioShield.ModuleA; // create MQTT client instance using the wifi module // the default port used for MQTT is 1883 diff --git a/examples/MQTT_Subscribe/MQTT_Subscribe.ino b/examples/MQTT_Subscribe/MQTT_Subscribe.ino index 546275a7..b1eec142 100644 --- a/examples/MQTT_Subscribe/MQTT_Subscribe.ino +++ b/examples/MQTT_Subscribe/MQTT_Subscribe.ino @@ -1,5 +1,5 @@ /* - KiteLib MQTT Subscribe Example + RadioLib MQTT Subscribe Example This example subscribes to MQTT topic using ESP8266 WiFi module. @@ -11,10 +11,10 @@ */ // include the library -#include +#include // ESP8266 module is in slot A on the shield -ESP8266 wifi = Kite.ModuleA; +ESP8266 wifi = RadioShield.ModuleA; // create MQTT client instance using the wifi module // the default port used for MQTT is 1883 diff --git a/examples/RF69_Receive/RF69_Receive.ino b/examples/RF69_Receive/RF69_Receive.ino index f9069903..15bbef16 100644 --- a/examples/RF69_Receive/RF69_Receive.ino +++ b/examples/RF69_Receive/RF69_Receive.ino @@ -1,14 +1,14 @@ /* - KiteLib RF69 Receive Example + RadioLib RF69 Receive Example This example receives packets using RF69 FSK radio module. */ // include the library -#include +#include // RF69 module is in slot A on the shield -RF69 rf = Kite.ModuleA; +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RF69_Receive_AES/RF69_Receive_AES.ino b/examples/RF69_Receive_AES/RF69_Receive_AES.ino index 54820ccf..1664304d 100644 --- a/examples/RF69_Receive_AES/RF69_Receive_AES.ino +++ b/examples/RF69_Receive_AES/RF69_Receive_AES.ino @@ -1,5 +1,5 @@ /* - KiteLib RF69 Receive with AES Example + RadioLib RF69 Receive with AES Example This example receives packets using RF69 FSK radio module. Packets are decrypted using hardware AES. @@ -7,10 +7,10 @@ */ // include the library -#include +#include // RF69 module is in slot A on the shield -RF69 rf = Kite.ModuleA; +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RF69_Receive_Address/RF69_Receive_Address.ino b/examples/RF69_Receive_Address/RF69_Receive_Address.ino index e4fa2a0e..f55613d5 100644 --- a/examples/RF69_Receive_Address/RF69_Receive_Address.ino +++ b/examples/RF69_Receive_Address/RF69_Receive_Address.ino @@ -1,5 +1,5 @@ /* - KiteLib RF69 Receive with Address Example + RadioLib RF69 Receive with Address Example This example receives packets using RF69 FSK radio module. Packets can have 1-byte address of the destination node. @@ -9,10 +9,10 @@ */ // include the library -#include +#include // RF69 module is in slot A on the shield -RF69 rf = Kite.ModuleA; +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RF69_Receive_Interrupt/RF69_Receive_Interrupt.ino b/examples/RF69_Receive_Interrupt/RF69_Receive_Interrupt.ino index b034cf79..597dc950 100644 --- a/examples/RF69_Receive_Interrupt/RF69_Receive_Interrupt.ino +++ b/examples/RF69_Receive_Interrupt/RF69_Receive_Interrupt.ino @@ -1,6 +1,21 @@ -#include +/* + RadioLib RF69 Receive with Inerrupts Example -RF69 rf = Kite.ModuleA; + This example listens for FSK transmissions and tries to + receive them. Once a packet is received, an interrupt is + triggered. To successfully receive data, the following + settings have to be the same on both transmitter + and receiver: + - carrier frequency + - bandwidth + - spreading factor + - coding rate + - sync word +*/ + +#include + +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RF69_Settings/RF69_Settings.ino b/examples/RF69_Settings/RF69_Settings.ino index 6a995dde..4dd7c3ee 100644 --- a/examples/RF69_Settings/RF69_Settings.ino +++ b/examples/RF69_Settings/RF69_Settings.ino @@ -1,8 +1,8 @@ /* - KiteLib SX127x Settings Example + RadioLib SX127x Settings Example This example shows how to change all the properties of RF69 radio. - KiteLib currently supports the following settings: + RadioLib currently supports the following settings: - pins (SPI slave select, digital IO 0, digital IO 1) - carrier frequency - bit rate @@ -13,12 +13,12 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -RF69 rf1 = Kite.ModuleA; +RF69 rf1 = RadioShield.ModuleA; -// if you're not using Kite shield, you can specify +// if you're not using RadioShield, you can specify // the connection yourself // NSS pin: 6 // DIO0 pin: 4 diff --git a/examples/RF69_Transmit/RF69_Transmit.ino b/examples/RF69_Transmit/RF69_Transmit.ino index 65c92907..da3fb065 100644 --- a/examples/RF69_Transmit/RF69_Transmit.ino +++ b/examples/RF69_Transmit/RF69_Transmit.ino @@ -1,14 +1,14 @@ /* - KiteLib RF69 Transmit Example + RadioLib RF69 Transmit Example This example transmits packets using RF69 FSK radio module. */ // include the library -#include +#include // RF69 module is in slot A on the shield -RF69 rf = Kite.ModuleA; +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RF69_Transmit_AES/RF69_Transmit_AES.ino b/examples/RF69_Transmit_AES/RF69_Transmit_AES.ino index 6910a2a1..8d0be886 100644 --- a/examples/RF69_Transmit_AES/RF69_Transmit_AES.ino +++ b/examples/RF69_Transmit_AES/RF69_Transmit_AES.ino @@ -1,5 +1,5 @@ /* - KiteLib RF69 Transmit with AES Example + RadioLib RF69 Transmit with AES Example This example transmits packets using RF69 FSK radio module. Packets are encrypted using hardware AES. @@ -7,10 +7,10 @@ */ // include the library -#include +#include // RF69 module is in slot A on the shield -RF69 rf = Kite.ModuleA; +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RF69_Transmit_Address/RF69_Transmit_Address.ino b/examples/RF69_Transmit_Address/RF69_Transmit_Address.ino index 4375425d..2132d56a 100644 --- a/examples/RF69_Transmit_Address/RF69_Transmit_Address.ino +++ b/examples/RF69_Transmit_Address/RF69_Transmit_Address.ino @@ -1,5 +1,5 @@ /* - KiteLib RF69 Transmit to Address Example + RadioLib RF69 Transmit to Address Example This example transmits packets using RF69 FSK radio module. Packets can have 1-byte address of the destination node. @@ -9,10 +9,10 @@ */ // include the library -#include +#include // RF69 module is in slot A on the shield -RF69 rf = Kite.ModuleA; +RF69 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/RTTY_Transmit/RTTY_Transmit.ino b/examples/RTTY_Transmit/RTTY_Transmit.ino index 28e2ed28..e49a5560 100644 --- a/examples/RTTY_Transmit/RTTY_Transmit.ino +++ b/examples/RTTY_Transmit/RTTY_Transmit.ino @@ -1,5 +1,5 @@ /* - KiteLib RTTY Transmit Example + RadioLib RTTY Transmit Example This example sends RTTY message using SX1278's FSK modem. @@ -7,14 +7,15 @@ Other modules that can be used for RTTY: - SX1272/73/76/77/79 - RF69 + - SX1231 - CC1101 */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 fsk = Kite.ModuleA; +SX1278 fsk = RadioShield.ModuleA; // create RTTY client instance using the FSK module RTTYClient rtty(&fsk); @@ -63,7 +64,7 @@ void setup() { } /* - // KiteLib also provides ITA2 ("Baudot") support + // RadioLib also provides ITA2 ("Baudot") support rtty.begin(434, 183, 45, ITA2); // All transmissions in loop() (strings and numbers) diff --git a/examples/SX1231_Receive/SX1231_Receive.ino b/examples/SX1231_Receive/SX1231_Receive.ino index de91f7a6..42af27e8 100644 --- a/examples/SX1231_Receive/SX1231_Receive.ino +++ b/examples/SX1231_Receive/SX1231_Receive.ino @@ -1,5 +1,5 @@ /* - KiteLib SX1231 Receive Example + RadioLib SX1231 Receive Example This example receives packets using SX1231 FSK radio module. @@ -9,10 +9,10 @@ */ // include the library -#include +#include // SX1231 module is in slot A on the shield -SX1231 rf = Kite.ModuleA; +SX1231 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/SX1231_Transmit/SX1231_Transmit.ino b/examples/SX1231_Transmit/SX1231_Transmit.ino index aaf1f365..f109ba09 100644 --- a/examples/SX1231_Transmit/SX1231_Transmit.ino +++ b/examples/SX1231_Transmit/SX1231_Transmit.ino @@ -1,5 +1,5 @@ /* - KiteLib SX1231 Transmit Example + RadioLib SX1231 Transmit Example This example transmits packets using SX1231 FSK radio module. @@ -9,10 +9,10 @@ */ // include the library -#include +#include // SX1231 module is in slot A on the shield -SX1231 rf = Kite.ModuleA; +SX1231 rf = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/SX127x_ChannelActivityDetection/SX127x_ChannelActivityDetection.ino b/examples/SX127x_ChannelActivityDetection/SX127x_ChannelActivityDetection.ino index 718b62d2..41ad8c9d 100644 --- a/examples/SX127x_ChannelActivityDetection/SX127x_ChannelActivityDetection.ino +++ b/examples/SX127x_ChannelActivityDetection/SX127x_ChannelActivityDetection.ino @@ -1,5 +1,5 @@ /* - KiteLib SX127x Channel Activity Detection Example + RadioLib SX127x Channel Activity Detection Example This example scans the current LoRa channel and detects valid LoRa preambles. Preamble is the first part of @@ -11,10 +11,10 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 lora = Kite.ModuleA; +SX1278 lora = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/SX127x_Receive/SX127x_Receive.ino b/examples/SX127x_Receive/SX127x_Receive.ino index a98f33e9..d70d1caa 100644 --- a/examples/SX127x_Receive/SX127x_Receive.ino +++ b/examples/SX127x_Receive/SX127x_Receive.ino @@ -1,5 +1,5 @@ /* - KiteLib SX127x Receive Example + RadioLib SX127x Receive Example This example listens for LoRa transmissions using SX127x Lora modules. To successfully receive data, the following settings have to be the same @@ -15,10 +15,10 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 lora = Kite.ModuleA; +SX1278 lora = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/SX127x_ReceiveInterrupt/SX127x_ReceiveInterrupt.ino b/examples/SX127x_ReceiveInterrupt/SX127x_ReceiveInterrupt.ino index cf0efff0..7f59f7e7 100644 --- a/examples/SX127x_ReceiveInterrupt/SX127x_ReceiveInterrupt.ino +++ b/examples/SX127x_ReceiveInterrupt/SX127x_ReceiveInterrupt.ino @@ -1,5 +1,5 @@ /* - KiteLib Receive with Inerrupts Example + RadioLib SX127x Receive with Inerrupts Example This example listens for LoRa transmissions and tries to receive them. Once a packet is received, an interrupt is @@ -16,10 +16,10 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 lora = Kite.ModuleA; +SX1278 lora = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/SX127x_Settings/SX127x_Settings.ino b/examples/SX127x_Settings/SX127x_Settings.ino index f87c2298..d8ee334b 100644 --- a/examples/SX127x_Settings/SX127x_Settings.ino +++ b/examples/SX127x_Settings/SX127x_Settings.ino @@ -1,8 +1,8 @@ /* - KiteLib SX127x Settings Example + RadioLib SX127x Settings Example This example shows how to change all the properties of LoRa transmission. - KiteLib currently supports the following settings: + RadioLib currently supports the following settings: - pins (SPI slave select, digital IO 0, digital IO 1) - carrier frequency - bandwidth @@ -15,13 +15,13 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 loraSX1278 = Kite.ModuleA; +SX1278 loraSX1278 = RadioShield.ModuleA; // SX1272 module is in slot B on the shield -SX1272 loraSX1272 = Kite.ModuleB; +SX1272 loraSX1272 = RadioShield.ModuleB; void setup() { Serial.begin(9600); diff --git a/examples/SX127x_Transmit/SX127x_Transmit.ino b/examples/SX127x_Transmit/SX127x_Transmit.ino index 2f82c6db..6e93f4fb 100644 --- a/examples/SX127x_Transmit/SX127x_Transmit.ino +++ b/examples/SX127x_Transmit/SX127x_Transmit.ino @@ -1,5 +1,5 @@ /* - KiteLib SX127x Transmit Example + RadioLib SX127x Transmit Example This example transmits packets using SX1278 LoRa radio module. Each packet contains up to 256 bytes of data, in the form of: @@ -11,10 +11,10 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 lora = Kite.ModuleA; +SX1278 lora = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/SX127x_TransmitInterrupt/SX127x_TransmitInterrupt.ino b/examples/SX127x_TransmitInterrupt/SX127x_TransmitInterrupt.ino index e6abe241..bd882561 100644 --- a/examples/SX127x_TransmitInterrupt/SX127x_TransmitInterrupt.ino +++ b/examples/SX127x_TransmitInterrupt/SX127x_TransmitInterrupt.ino @@ -1,5 +1,5 @@ /* - KiteLib Transmit with Inerrupts Example + RadioLib Transmit with Inerrupts Example This example transmits LoRa packets with one second delays between them. Each packet contains up to 256 bytes @@ -12,10 +12,10 @@ */ // include the library -#include +#include // SX1278 module is in slot A on the shield -SX1278 lora = Kite.ModuleA; +SX1278 lora = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/XBee_Receive/XBee_Receive.ino b/examples/XBee_Receive/XBee_Receive.ino index 342cd356..1fb91727 100644 --- a/examples/XBee_Receive/XBee_Receive.ino +++ b/examples/XBee_Receive/XBee_Receive.ino @@ -1,5 +1,5 @@ /* - KiteLib XBee API Receive Example + RadioLib XBee API Receive Example This example receives packets using XBee API mode. In API mode, many XBee modules can form a mesh network. @@ -9,10 +9,10 @@ */ // include the library -#include +#include // XBee module is in slot A on the shield -XBee bee = Kite.ModuleA; +XBee bee = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/XBee_Transmit/XBee_Transmit.ino b/examples/XBee_Transmit/XBee_Transmit.ino index 477494ed..8d7c9fc6 100644 --- a/examples/XBee_Transmit/XBee_Transmit.ino +++ b/examples/XBee_Transmit/XBee_Transmit.ino @@ -1,5 +1,5 @@ /* - KiteLib XBee API Transmit Example + RadioLib XBee API Transmit Example This example transmits packets using XBee API mode. In API mode, many XBee modules can form a mesh network. @@ -9,10 +9,10 @@ */ // include the library -#include +#include // XBee module is in slot A on the shield -XBee bee = Kite.ModuleA; +XBee bee = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/examples/XBee_Transparent/XBee_Transparent.ino b/examples/XBee_Transparent/XBee_Transparent.ino index 78df0b06..0eff8881 100644 --- a/examples/XBee_Transparent/XBee_Transparent.ino +++ b/examples/XBee_Transparent/XBee_Transparent.ino @@ -1,5 +1,5 @@ /* - KiteLib XBee Transparent Operation Example + RadioLib XBee Transparent Operation Example This example transmits packets using XBee Transparent mode. In Transparent mode, two XBee modules act like a Serial line. @@ -11,10 +11,10 @@ */ // include the library -#include +#include // XBee module is in slot A on the shield -XBeeSerial bee = Kite.ModuleA; +XBeeSerial bee = RadioShield.ModuleA; void setup() { Serial.begin(9600); diff --git a/extras/ModuleTemplate.h b/extras/ModuleTemplate.h index a331a775..73daec95 100644 --- a/extras/ModuleTemplate.h +++ b/extras/ModuleTemplate.h @@ -1,5 +1,5 @@ /* - KiteLib Module Template header file + RadioLib Module Template header file Before opening pull request, please make sure that: 1. All files MUST be compiled without errors using default Arduino IDE settings. @@ -12,8 +12,8 @@ If at any point you are unsure about the required style, please refer to the rest of the modules. */ -#ifndef _KITELIB__H -#define _KITELIB__H +#ifndef _RADIOLIB__H +#define _RADIOLIB__H /* Header file for each module MUST include Module.h. diff --git a/keywords.txt b/keywords.txt index 95cb7d28..c2187ae0 100644 --- a/keywords.txt +++ b/keywords.txt @@ -1,13 +1,13 @@ ####################################### -# Syntax Coloring Map For KiteLib +# Syntax Coloring Map For RadioLib ####################################### ####################################### # Datatypes (KEYWORD1) ####################################### -KiteLib KEYWORD1 -Kite KEYWORD1 +RadioLib KEYWORD1 +RadioShield KEYWORD1 Module KEYWORD1 CC1101 KEYWORD1 @@ -37,7 +37,7 @@ RTTYClient KEYWORD1 # Methods and Functions (KEYWORD2) ####################################### -# KiteLib +# RadioLib ModuleA KEYWORD2 ModuleB KEYWORD2 Module KEYWORD2 diff --git a/library.properties b/library.properties index 71bfe423..25c71ebc 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=KiteLib +name=RadioLib version=1.0.0 author=Jan Gromes maintainer=Jan Gromes -sentence=Arduino library for the KITE shield -paragraph=Enables user-friendly control of the KITE shield and various wireless modules. +sentence=Universal wireless communication library for Arduino +paragraph=Enables user-friendly control of the RadioShield and various wireless modules. category=Communication -url=https://github.com/jgromes/KiteLib +url=https://github.com/jgromes/RadioLib architectures=* -includes=KiteLib.h +includes=RadioLib.h diff --git a/src/ISerial.h b/src/ISerial.h index bc271078..f822544b 100644 --- a/src/ISerial.h +++ b/src/ISerial.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_ISERIAL_H -#define _KITELIB_ISERIAL_H +#ifndef _RADIOLIB_ISERIAL_H +#define _RADIOLIB_ISERIAL_H #include "Module.h" diff --git a/src/KiteLib.cpp b/src/KiteLib.cpp deleted file mode 100644 index c134af12..00000000 --- a/src/KiteLib.cpp +++ /dev/null @@ -1,8 +0,0 @@ -#include "KiteLib.h" - -KiteShield::KiteShield() { - ModuleA = new Module(KITE_CS_A, KITE_RX_A, KITE_TX_A, KITE_INT_0, KITE_INT_1); - ModuleB = new Module(KITE_CS_B, KITE_RX_B, KITE_TX_B, KITE_INT_0, KITE_INT_1); -} - -KiteShield Kite; diff --git a/src/Module.h b/src/Module.h index 7b50e4b3..2856407f 100644 --- a/src/Module.h +++ b/src/Module.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_MODULE_H -#define _KITELIB_MODULE_H +#ifndef _RADIOLIB_MODULE_H +#define _RADIOLIB_MODULE_H #include //#include diff --git a/src/RadioLib.cpp b/src/RadioLib.cpp new file mode 100644 index 00000000..dcbdb1f3 --- /dev/null +++ b/src/RadioLib.cpp @@ -0,0 +1,8 @@ +#include "RadioLib.h" + +Radio::Radio() { + ModuleA = new Module(RADIOSHIELD_CS_A, RADIOSHIELD_RX_A, RADIOSHIELD_TX_A, RADIOSHIELD_INT_0, RADIOSHIELD_INT_1); + ModuleB = new Module(RADIOSHIELD_CS_B, RADIOSHIELD_RX_B, RADIOSHIELD_TX_B, RADIOSHIELD_INT_0, RADIOSHIELD_INT_1); +} + +Radio RadioShield; diff --git a/src/KiteLib.h b/src/RadioLib.h similarity index 69% rename from src/KiteLib.h rename to src/RadioLib.h index ad3c819a..b95891fd 100644 --- a/src/KiteLib.h +++ b/src/RadioLib.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_H -#define _KITELIB_H +#ifndef _RADIOLIB_H +#define _RADIOLIB_H #include "TypeDef.h" #include "Module.h" @@ -28,18 +28,18 @@ #include "protocols/HTTP.h" #include "protocols/MQTT.h" -#define KITE_CS_A 10 -#define KITE_RX_A 9 -#define KITE_TX_A 8 -#define KITE_CS_B 5 -#define KITE_RX_B 7 -#define KITE_TX_B 6 -#define KITE_INT_0 2 -#define KITE_INT_1 3 +#define RADIOSHIELD_CS_A 10 +#define RADIOSHIELD_RX_A 9 +#define RADIOSHIELD_TX_A 8 +#define RADIOSHIELD_CS_B 5 +#define RADIOSHIELD_RX_B 7 +#define RADIOSHIELD_TX_B 6 +#define RADIOSHIELD_INT_0 2 +#define RADIOSHIELD_INT_1 3 -class KiteShield { +class Radio { public: - KiteShield(); + Radio(); Module* ModuleA; Module* ModuleB; @@ -49,6 +49,6 @@ class KiteShield { }; -extern KiteShield Kite; +extern Radio RadioShield; #endif diff --git a/src/TypeDef.h b/src/TypeDef.h index f50ce999..565489eb 100644 --- a/src/TypeDef.h +++ b/src/TypeDef.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_TYPES_H -#define _KITELIB_TYPES_H +#ifndef _RADIOLIB_TYPES_H +#define _RADIOLIB_TYPES_H #if ARDUINO >= 100 #include "Arduino.h" @@ -7,9 +7,9 @@ #include "WProgram.h" #endif -//#define KITELIB_DEBUG +//#define RADIOLIB_DEBUG -#ifdef KITELIB_DEBUG +#ifdef RADIOLIB_DEBUG #define DEBUG_BEGIN(x) Serial.begin (x) #define DEBUG_PRINT(x) Serial.print (x) #define DEBUG_PRINT_BIN(x) Serial.print (x, BIN) diff --git a/src/modules/CC1101.cpp b/src/modules/CC1101.cpp index 6205056d..773dbded 100644 --- a/src/modules/CC1101.cpp +++ b/src/modules/CC1101.cpp @@ -18,7 +18,7 @@ int16_t CC1101::begin(float freq, float br, float rxBw, float freqDev) { if(version == 0x14) { flagFound = true; } else { - #ifdef KITELIB_DEBUG + #ifdef RADIOLIB_DEBUG Serial.print(F("CC1101 not found! (")); Serial.print(i + 1); Serial.print(F(" of 10 tries) CC1101_REG_VERSION == ")); diff --git a/src/modules/CC1101.h b/src/modules/CC1101.h index 796945ad..fe38d618 100644 --- a/src/modules/CC1101.h +++ b/src/modules/CC1101.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_CC1101_H -#define _KITELIB_CC1101_H +#ifndef _RADIOLIB_CC1101_H +#define _RADIOLIB_CC1101_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/ESP8266.h b/src/modules/ESP8266.h index d66448af..ffd860c5 100644 --- a/src/modules/ESP8266.h +++ b/src/modules/ESP8266.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_ESP8266_H -#define _KITELIB_ESP8266_H +#ifndef _RADIOLIB_ESP8266_H +#define _RADIOLIB_ESP8266_H #include "Module.h" diff --git a/src/modules/HC05.h b/src/modules/HC05.h index d85b2263..fa67b624 100644 --- a/src/modules/HC05.h +++ b/src/modules/HC05.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_HC05_H -#define _KITELIB_HC05_H +#ifndef _RADIOLIB_HC05_H +#define _RADIOLIB_HC05_H #include "ISerial.h" diff --git a/src/modules/JDY08.h b/src/modules/JDY08.h index eb1b62e1..9d4c5857 100644 --- a/src/modules/JDY08.h +++ b/src/modules/JDY08.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_JDY08_H -#define _KITELIB_JDY08_H +#ifndef _RADIOLIB_JDY08_H +#define _RADIOLIB_JDY08_H #include "ISerial.h" diff --git a/src/modules/RF69.cpp b/src/modules/RF69.cpp index ff31112d..0345e0e6 100644 --- a/src/modules/RF69.cpp +++ b/src/modules/RF69.cpp @@ -17,7 +17,7 @@ int16_t RF69::begin(float freq, float br, float rxBw, float freqDev, int8_t powe if(version == 0x24) { flagFound = true; } else { - #ifdef KITELIB_DEBUG + #ifdef RADIOLIB_DEBUG Serial.print(F("RF69 not found! (")); Serial.print(i + 1); Serial.print(F(" of 10 tries) RF69_REG_VERSION == ")); diff --git a/src/modules/RF69.h b/src/modules/RF69.h index 83682757..90fd132e 100644 --- a/src/modules/RF69.h +++ b/src/modules/RF69.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_RF69_H -#define _KITELIB_RF69_H +#ifndef _RADIOLIB_RF69_H +#define _RADIOLIB_RF69_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/RFM95.h b/src/modules/RFM95.h index 2fdc68fa..3865ef83 100644 --- a/src/modules/RFM95.h +++ b/src/modules/RFM95.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_RFM95_H -#define _KITELIB_RFM95_H +#ifndef _RADIOLIB_RFM95_H +#define _RADIOLIB_RFM95_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/RFM96.h b/src/modules/RFM96.h index 18244e83..2190e80d 100644 --- a/src/modules/RFM96.h +++ b/src/modules/RFM96.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_RFM96_H -#define _KITELIB_RFM96_H +#ifndef _RADIOLIB_RFM96_H +#define _RADIOLIB_RFM96_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/RFM97.h b/src/modules/RFM97.h index dc903557..a85e7ab7 100644 --- a/src/modules/RFM97.h +++ b/src/modules/RFM97.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_RFM97_H -#define _KITELIB_RFM97_H +#ifndef _RADIOLIB_RFM97_H +#define _RADIOLIB_RFM97_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/SX1231.cpp b/src/modules/SX1231.cpp index f6fabd46..6a4778ad 100644 --- a/src/modules/SX1231.cpp +++ b/src/modules/SX1231.cpp @@ -17,7 +17,7 @@ int16_t SX1231::begin(float freq, float br, float rxBw, float freqDev, int8_t po flagFound = true; _chipRevision = version; } else { - #ifdef KITELIB_DEBUG + #ifdef RADIOLIB_DEBUG Serial.print(F("SX127x not found! (")); Serial.print(i + 1); Serial.print(F(" of 10 tries) SX127X_REG_VERSION == ")); diff --git a/src/modules/SX1231.h b/src/modules/SX1231.h index 7b36cec7..549a795b 100644 --- a/src/modules/SX1231.h +++ b/src/modules/SX1231.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1231_H -#define _KITELIB_SX1231_H +#ifndef _RADIOLIB_SX1231_H +#define _RADIOLIB_SX1231_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/SX1272.h b/src/modules/SX1272.h index 3c433d39..c2a8707e 100644 --- a/src/modules/SX1272.h +++ b/src/modules/SX1272.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1272_H -#define _KITELIB_SX1272_H +#ifndef _RADIOLIB_SX1272_H +#define _RADIOLIB_SX1272_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/SX1273.h b/src/modules/SX1273.h index 57786007..03c55b6e 100644 --- a/src/modules/SX1273.h +++ b/src/modules/SX1273.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1273_H -#define _KITELIB_SX1273_H +#ifndef _RADIOLIB_SX1273_H +#define _RADIOLIB_SX1273_H #include "TypeDef.h" #include "SX1272.h" diff --git a/src/modules/SX1276.h b/src/modules/SX1276.h index e131be74..fe1fc23d 100644 --- a/src/modules/SX1276.h +++ b/src/modules/SX1276.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1276_H -#define _KITELIB_SX1276_H +#ifndef _RADIOLIB_SX1276_H +#define _RADIOLIB_SX1276_H #include "TypeDef.h" #include "SX1278.h" diff --git a/src/modules/SX1277.h b/src/modules/SX1277.h index 232978ae..73f65610 100644 --- a/src/modules/SX1277.h +++ b/src/modules/SX1277.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1277_H -#define _KITELIB_SX1277_H +#ifndef _RADIOLIB_SX1277_H +#define _RADIOLIB_SX1277_H #include "TypeDef.h" #include "SX1278.h" diff --git a/src/modules/SX1278.h b/src/modules/SX1278.h index 90d8f76b..6349989b 100644 --- a/src/modules/SX1278.h +++ b/src/modules/SX1278.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1278_H -#define _KITELIB_SX1278_H +#ifndef _RADIOLIB_SX1278_H +#define _RADIOLIB_SX1278_H #include "TypeDef.h" #include "Module.h" diff --git a/src/modules/SX1279.h b/src/modules/SX1279.h index 1091f8b2..26607bfd 100644 --- a/src/modules/SX1279.h +++ b/src/modules/SX1279.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX1279_H -#define _KITELIB_SX1279_H +#ifndef _RADIOLIB_SX1279_H +#define _RADIOLIB_SX1279_H #include "TypeDef.h" #include "SX1278.h" diff --git a/src/modules/SX127x.cpp b/src/modules/SX127x.cpp index 99218e39..fc393198 100644 --- a/src/modules/SX127x.cpp +++ b/src/modules/SX127x.cpp @@ -1034,7 +1034,7 @@ bool SX127x::findChip(uint8_t ver) { if(version == ver) { flagFound = true; } else { - #ifdef KITELIB_DEBUG + #ifdef RADIOLIB_DEBUG Serial.print(F("SX127x not found! (")); Serial.print(i + 1); Serial.print(F(" of 10 tries) SX127X_REG_VERSION == ")); @@ -1084,7 +1084,7 @@ void SX127x::clearIRQFlags() { } } -#ifdef KITELIB_DEBUG +#ifdef RADIOLIB_DEBUG void SX127x::regDump() { Serial.println(); Serial.println(F("ADDR\tVALUE")); diff --git a/src/modules/SX127x.h b/src/modules/SX127x.h index b347b9c8..6d9a9e10 100644 --- a/src/modules/SX127x.h +++ b/src/modules/SX127x.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_SX127X_H -#define _KITELIB_SX127X_H +#ifndef _RADIOLIB_SX127X_H +#define _RADIOLIB_SX127X_H #include "TypeDef.h" #include "Module.h" @@ -848,7 +848,7 @@ class SX127x: public PhysicalLayer { */ int16_t disableAddressFiltering(); - #ifdef KITELIB_DEBUG + #ifdef RADIOLIB_DEBUG void regDump(); #endif diff --git a/src/modules/XBee.h b/src/modules/XBee.h index da2c2560..da08127f 100644 --- a/src/modules/XBee.h +++ b/src/modules/XBee.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_XBEE_H -#define _KITELIB_XBEE_H +#ifndef _RADIOLIB_XBEE_H +#define _RADIOLIB_XBEE_H #include "ISerial.h" #include "TypeDef.h" diff --git a/src/protocols/HTTP.h b/src/protocols/HTTP.h index 2dcc7dca..e3d1293f 100644 --- a/src/protocols/HTTP.h +++ b/src/protocols/HTTP.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_HTTP_H -#define _KITELIB_HTTP_H +#ifndef _RADIOLIB_HTTP_H +#define _RADIOLIB_HTTP_H #include "TypeDef.h" #include "TransportLayer.h" diff --git a/src/protocols/MQTT.h b/src/protocols/MQTT.h index c23f0f12..73e10a52 100644 --- a/src/protocols/MQTT.h +++ b/src/protocols/MQTT.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_MQTT_H -#define _KITELIB_MQTT_H +#ifndef _RADIOLIB_MQTT_H +#define _RADIOLIB_MQTT_H #include "TypeDef.h" #include "TransportLayer.h" diff --git a/src/protocols/PhysicalLayer.h b/src/protocols/PhysicalLayer.h index 5ab93f43..6d221e63 100644 --- a/src/protocols/PhysicalLayer.h +++ b/src/protocols/PhysicalLayer.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_PHYSICAL_LAYER_H -#define _KITELIB_PHYSICAL_LAYER_H +#ifndef _RADIOLIB_PHYSICAL_LAYER_H +#define _RADIOLIB_PHYSICAL_LAYER_H #include "TypeDef.h" diff --git a/src/protocols/RTTY.h b/src/protocols/RTTY.h index e9b21062..89fe933b 100644 --- a/src/protocols/RTTY.h +++ b/src/protocols/RTTY.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_RTTY_H -#define _KITELIB_RTTY_H +#ifndef _RADIOLIB_RTTY_H +#define _RADIOLIB_RTTY_H #include "TypeDef.h" #include "PhysicalLayer.h" diff --git a/src/protocols/TransportLayer.h b/src/protocols/TransportLayer.h index 60e18fe0..6e663d88 100644 --- a/src/protocols/TransportLayer.h +++ b/src/protocols/TransportLayer.h @@ -1,5 +1,5 @@ -#ifndef _KITELIB_TRANSPORT_LAYER_H -#define _KITELIB_TRANSPORT_LAYER_H +#ifndef _RADIOLIB_TRANSPORT_LAYER_H +#define _RADIOLIB_TRANSPORT_LAYER_H #include "TypeDef.h"