Restructure examples folder

Author: chandrawi

examples/SX126x_LoRa_simple_gateway/SX126x_LoRa_simple_gateway.ino renamed to examples/Network/LoRa_simple_gateway/LoRa_simple_gateway.ino

@@ -1,6 +1,14 @@
 #include <SX126x.h>
+#include <SX127x.h>
 
+// #define SX126X
+#define SX127X
+
+#if defined(SX126X)
 SX126x LoRa;
+#elif defined(SX127X)
+SX127x LoRa;
+#endif
 
 // gateway ID
 uint8_t gatewayId = 0xCC;
@@ -21,27 +29,34 @@ void setup() {
  // Begin serial communication
  Serial.begin(38400);
 
+#if defined(SX126X)
  // Begin LoRa radio and set NSS, reset, busy, IRQ, txen, and rxen pin with connected arduino pins
  Serial.println("Begin LoRa radio");
  int8_t nssPin = 10, resetPin = 9, busyPin = 4, irqPin = 2, txenPin = 8, rxenPin = 7;
  if (!LoRa.begin(nssPin, resetPin, busyPin, irqPin, txenPin, rxenPin)){
  Serial.println("Something wrong, can't begin LoRa radio");
  while(1);
  }
-
  // Configure TCXO used in RF module
  Serial.println("Set RF module to use TCXO as clock reference");
- uint8_t dio3Voltage = SX126X_DIO3_OUTPUT_1_8;
- uint32_t tcxoDelay = SX126X_TCXO_DELAY_10;
- LoRa.setDio3TcxoCtrl(dio3Voltage, tcxoDelay);
- 
+ LoRa.setDio3TcxoCtrl(SX126X_DIO3_OUTPUT_1_8, SX126X_TCXO_DELAY_10);
+#elif defined(SX127X)
+ // Begin LoRa radio and set NSS, reset, IRQ, txen, and rxen pin with connected arduino pins
+ Serial.println("Begin LoRa radio");
+ int8_t nssPin = 10, resetPin = 9, irqPin = 2, txenPin = 8, rxenPin = 7;
+ if (!LoRa.begin(nssPin, resetPin, irqPin, txenPin, rxenPin)){
+ Serial.println("Something wrong, can't begin LoRa radio");
+ while(1);
+ }
+#endif
+
  // Set frequency to 915 Mhz
  Serial.println("Set frequency to 915 Mhz");
  LoRa.setFrequency(915000000);
 
- // Set RX gain
+ // Set RX gain to boosted gain
  Serial.println("Set RX gain to boosted gain");
- LoRa.setRxGain(SX126X_RX_GAIN_BOOSTED);
+ LoRa.setRxGain(LORA_RX_GAIN_BOOSTED);
 
  // Configure modulation parameter including spreading factor (SF), bandwidth (BW), and coding rate (CR)
  Serial.println("Set modulation parameters:\n\tSpreading factor = 7\n\tBandwidth = 125 kHz\n\tCoding rate = 4/5");
@@ -52,30 +67,27 @@ void setup() {
 
  // Configure packet parameter including header type, preamble length, payload length, and CRC type
  Serial.println("Set packet parameters:\n\tImplicit header type\n\tPreamble length = 12\n\tPayload Length = message length\n\tCRC on");
- uint8_t headerType = SX126X_HEADER_IMPLICIT;
+ uint8_t headerType = LORA_HEADER_IMPLICIT;
  uint16_t preambleLength = 12;
  uint8_t payloadLength = messageLen;
  bool crcType = true;
  LoRa.setLoRaPacket(headerType, preambleLength, payloadLength, crcType);
 
- // Set syncronize word for private network (0x1424)
- Serial.println("Set syncronize word to 0x1424");
- LoRa.setSyncWord(0x1424);
+ // Set syncronize word for public network (0x3444)
+ Serial.println("Set syncronize word to 0x3444");
+ LoRa.setSyncWord(0x3444);
 
  Serial.print("\nGateway ID : 0x");
  if (gatewayId < 0x10) Serial.print("0");
  Serial.println(gatewayId, HEX);
- Serial.println("-- LoRa Gateway --\n");
+ Serial.println("-- LORA GATEWAY --\n");
 
 }
 
 void loop() {
 
- // Set RF module to listen mode with 30 ms RX mode and 10 ms sleep
- // Some LoRa packet will not be received if sleep period too long or preamble length too short
- uint32_t rxPeriod = 30;
- uint32_t sleepPeriod = 10;
- LoRa.listen(rxPeriod, sleepPeriod);
+ // Set RF module to receive mode
+ LoRa.request();
 
  // Wait incoming signal and demodulation process for receiving packet finish
  LoRa.wait();
@@ -113,9 +125,9 @@ void loop() {
  Serial.println(" dB");
 
  // Show received status in case CRC or header error occur
- uint8_t Status = LoRa.status();
- if (Status == SX126X_STATUS_CRC_ERR) Serial.println("CRC error");
- if (Status == SX126X_STATUS_HEADER_ERR) Serial.println("Packet header error");
+ uint8_t status = LoRa.status();
+ if (status == LORA_STATUS_CRC_ERR) Serial.println("CRC error");
+ if (status == LORA_STATUS_HEADER_ERR) Serial.println("Packet header error");
  Serial.println();
 
 }

examples/SX126x_LoRa_simple_node/SX126x_LoRa_simple_node.ino renamed to examples/Network/LoRa_simple_node/LoRa_simple_node.ino

@@ -1,6 +1,14 @@
 #include <SX126x.h>
+#include <SX127x.h>
 
+// #define SX126X
+#define SX127X
+
+#if defined(SX126X)
 SX126x LoRa;
+#elif defined(SX127X)
+SX127x LoRa;
+#endif
 
 // gateway ID and node ID
 uint8_t gatewayId = 0xCC;
@@ -22,27 +30,34 @@ void setup() {
  // Begin serial communication
  Serial.begin(38400);
 
+#if defined(SX126X)
  // Begin LoRa radio and set NSS, reset, busy, IRQ, txen, and rxen pin with connected arduino pins
  Serial.println("Begin LoRa radio");
  int8_t nssPin = 10, resetPin = 9, busyPin = 4, irqPin = 2, txenPin = 8, rxenPin = 7;
  if (!LoRa.begin(nssPin, resetPin, busyPin, irqPin, txenPin, rxenPin)){
  Serial.println("Something wrong, can't begin LoRa radio");
  while(1);
  }
-
  // Configure TCXO used in RF module
  Serial.println("Set RF module to use TCXO as clock reference");
- uint8_t dio3Voltage = SX126X_DIO3_OUTPUT_1_8;
- uint32_t tcxoDelay = SX126X_TCXO_DELAY_10;
- LoRa.setDio3TcxoCtrl(dio3Voltage, tcxoDelay);
- 
+ LoRa.setDio3TcxoCtrl(SX126X_DIO3_OUTPUT_1_8, SX126X_TCXO_DELAY_10);
+#elif defined(SX127X)
+ // Begin LoRa radio and set NSS, reset, IRQ, txen, and rxen pin with connected arduino pins
+ Serial.println("Begin LoRa radio");
+ int8_t nssPin = 10, resetPin = 9, irqPin = 2, txenPin = 8, rxenPin = 7;
+ if (!LoRa.begin(nssPin, resetPin, irqPin, txenPin, rxenPin)){
+ Serial.println("Something wrong, can't begin LoRa radio");
+ while(1);
+ }
+#endif
+
  // Set frequency to 915 Mhz
  Serial.println("Set frequency to 915 Mhz");
  LoRa.setFrequency(915000000);
 
- // Set TX power
- Serial.println("Set TX power to +22 dBm");
- LoRa.setTxPower(SX126X_TX_POWER_SX1262_22);
+ // Set TX power to 17 dBm
+ Serial.println("Set TX power to +17 dBm");
+ LoRa.setTxPower(17);
 
  // Configure modulation parameter including spreading factor (SF), bandwidth (BW), and coding rate (CR)
  Serial.println("Set modulation parameters:\n\tSpreading factor = 7\n\tBandwidth = 125 kHz\n\tCoding rate = 4/5");
@@ -53,17 +68,17 @@ void setup() {
 
  // Configure packet parameter including header type, preamble length, payload length, and CRC type
  Serial.println("Set packet parameters:\n\tImplicit header type\n\tPreamble length = 12\n\tPayload Length = message length\n\tCRC on");
- uint8_t headerType = SX126X_HEADER_IMPLICIT;
+ uint8_t headerType = LORA_HEADER_IMPLICIT;
  uint16_t preambleLength = 12;
  uint8_t payloadLength = messageLen;
  bool crcType = true;
  LoRa.setLoRaPacket(headerType, preambleLength, payloadLength, crcType);
 
- // Set syncronize word for private network (0x1424)
- Serial.println("Set syncronize word to 0x1424");
- LoRa.setSyncWord(0x1424);
+ // Set syncronize word for private network (0x3444)
+ Serial.println("Set syncronize word to 0x3444");
+ LoRa.setSyncWord(0x3444);
 
- Serial.println("\n-- LoRa Node --\n");
+ Serial.println("\n-- LORA NODE --\n");
 
  // Assign gateway Id and node Id to message object
  message.gatewayId = gatewayId;
@@ -80,11 +95,9 @@ void loop() {
  message.messageId++;
 
  // Transmit message object
- // Set transmit timeout to 250 ms
- uint32_t timeout = 250;
  LoRa.beginPacket();
  LoRa.put(message);
- LoRa.endPacket(timeout);
+ LoRa.endPacket();
 
  // Print message in serial
  Serial.print("Gateway ID : 0x");
@@ -109,9 +122,6 @@ void loop() {
  Serial.println(" ms");
  Serial.println();
 
- // Print status timeout when transmit process terminated due to timeout
- if (LoRa.status() == SX126X_STATUS_TX_TIMEOUT) Serial.println("Transmit timeout");
-
  // Put RF module to sleep in a few seconds
  LoRa.sleep();
  delay(5000);

examples/SX126x_LoRa_receiver/SX126x_LoRa_receiver.ino renamed to examples/SX126x/SX126x_LoRa_receiver/SX126x_LoRa_receiver.ino

@@ -33,7 +33,7 @@ void setup() {
  Serial.println("Set frequency to 915 Mhz");
  LoRa.setFrequency(915000000);
 
- // Set RX gain. RX gain option are power saving gain or boosted gain 
+ // Set RX gain. RX gain option are power saving gain or boosted gain
  Serial.println("Set RX gain to power saving gain");
  LoRa.setRxGain(SX126X_RX_GAIN_POWER_SAVING); // Power saving gain
 
@@ -59,7 +59,7 @@ void setup() {
  Serial.println("Set syncronize word to 0x3444");
  LoRa.setSyncWord(0x3444);
 
- Serial.println("\n-- LoRa RECEIVER --\n");
+ Serial.println("\n-- LORA RECEIVER --\n");
 
 }
 
@@ -95,8 +95,9 @@ void loop() {
  Serial.println(" dB");
 
  // Show received status in case CRC or header error occur
- if (LoRa.status() == SX126X_STATUS_CRC_ERR) Serial.println("CRC error");
- if (LoRa.status() == SX126X_STATUS_HEADER_ERR) Serial.println("Packet header error");
+ uint8_t status = LoRa.status();
+ if (status == SX126X_STATUS_CRC_ERR) Serial.println("CRC error");
+ else if (status == SX126X_STATUS_HEADER_ERR) Serial.println("Packet header error");
  Serial.println();
 
 }

examples/SX126x_LoRa_receiver_callback/SX126x_LoRa_receiver_callback.ino renamed to examples/SX126x/SX126x_LoRa_receiver_continuous/SX126x_LoRa_receiver_continuous.ino

@@ -2,11 +2,6 @@
 
 SX126x LoRa;
 
-// receive data length and pointer
-const uint8_t packetLength = 15;
-uint8_t packetData[packetLength];
-volatile bool flag = false;
-
 void setup() {
 
  // Begin serial communication
@@ -20,7 +15,7 @@ void setup() {
  while(1);
  }
 
- // Configure TCXO used in RF module
+ // Configure TCXO or XTAL used in RF module
  Serial.println("Set RF module to use TCXO as clock reference");
  uint8_t dio3Voltage = SX126X_DIO3_OUTPUT_1_8;
  uint32_t tcxoDelay = SX126X_TCXO_DELAY_10;
@@ -30,9 +25,9 @@ void setup() {
  Serial.println("Set frequency to 915 Mhz");
  LoRa.setFrequency(915000000);
 
- // Set RX gain
+ // Set RX gain to boosted gain
  Serial.println("Set RX gain to power saving gain");
- LoRa.setRxGain(SX126X_RX_GAIN_POWER_SAVING);
+ LoRa.setRxGain(SX126X_RX_GAIN_BOOSTED);
 
  // Configure modulation parameter including spreading factor (SF), bandwidth (BW), and coding rate (CR)
  Serial.println("Set modulation parameters:\n\tSpreading factor = 7\n\tBandwidth = 125 kHz\n\tCoding rate = 4/5");
@@ -53,42 +48,46 @@ void setup() {
  Serial.println("Set syncronize word to 0x3444");
  LoRa.setSyncWord(0x3444);
 
- Serial.println("\n-- LoRa RECEIVER CALLBACK --\n");
-
- // Register callback function to be called every RX done
- LoRa.onReceive(getReceiveData);
-
- // Begin request LoRa packet in continuous mode
+ Serial.println("\n-- LORA RECEIVER CONTINUOUS --\n");
+ 
+ // Request for receiving new LoRa packet in RX continuous mode
  LoRa.request(SX126X_RX_CONTINUOUS);
+ 
 }
 
 void loop() {
 
- if (flag) {
- // Print received package
- Serial.write(packetData, packetLength - 1);
+ // Check for incoming LoRa packet
+ const uint8_t msgLen = LoRa.available();
+ if (msgLen) {
+
+ // Put received packet to message and counter variable
+ char message[msgLen-1];
+ uint8_t counter;
+ uint8_t i=0;
+ while (LoRa.available() > 1){
+ message[i++] = LoRa.read();
+ }
+ counter = LoRa.read();
+ 
+ // Print received message and counter in serial
+ Serial.print(message);
  Serial.print(" ");
- Serial.println(packetData[packetLength - 1]);
+ Serial.println(counter);
 
  // Print packet/signal status including package RSSI and SNR
  Serial.print("Packet status: RSSI = ");
  Serial.print(LoRa.packetRssi());
  Serial.print(" dBm | SNR = ");
  Serial.print(LoRa.snr());
  Serial.println(" dB");
+ 
+ // Show received status in case CRC or header error occur
+ uint8_t status = LoRa.status();
+ if (status == SX126X_STATUS_CRC_ERR) Serial.println("CRC error");
+ else if (status == SX126X_STATUS_HEADER_ERR) Serial.println("Packet header error");
  Serial.println();
 
- // Reset flag
- flag = false;
  }
-}
 
-void getReceiveData() {
-
- // set flag
- flag = true;
- // Store received data
- for (uint8_t i=0; i<packetLength; i++) {
- packetData[i] = LoRa.read();
- }
 }