Initial commit of Arduino libraries

2025-05-23 10:47:41 +10:00
commit 5bfce5fc3e
2476 changed files with 1108481 additions and 0 deletions
--- a/RadioLib/examples/APRS/APRS_MicE/APRS_MicE.ino
+++ b/RadioLib/examples/APRS/APRS_MicE/APRS_MicE.ino
@@ -0,0 +1,123 @@
+/*
+  RadioLib APRS Mic-E Example
+
+  This example sends APRS position reports
+  encoded in the Mic-E format using SX1278's
+  FSK modem. The data is modulated as AFSK
+  at 1200 baud using Bell 202 tones.
+
+  DO NOT transmit in APRS bands unless
+  you have a ham radio license!
+
+  Other modules that can be used for APRS:
+  - SX127x/RFM9x
+  - RF69
+  - SX1231
+  - CC1101
+  - nRF24
+  - Si443x/RFM2x
+  - SX126x/LLCC68
+
+  For default module settings, see the wiki page
+  https://github.com/jgromes/RadioLib/wiki/Default-configuration
+
+  For full API reference, see the GitHub Pages
+  https://jgromes.github.io/RadioLib/
+*/
+
+// include the library
+#include <RadioLib.h>
+
+// SX1278 has the following connections:
+// NSS pin:   10
+// DIO0 pin:  2
+// RESET pin: 9
+// DIO1 pin:  3
+SX1278 radio = new Module(10, 2, 9, 3);
+
+// or detect the pinout automatically using RadioBoards
+// https://github.com/radiolib-org/RadioBoards
+/*
+#define RADIO_BOARD_AUTO
+#include <RadioBoards.h>
+Radio radio = new RadioModule();
+*/
+
+// create AFSK client instance using the FSK module
+// this requires connection to the module direct
+// input pin, here connected to Arduino pin 5
+// SX127x/RFM9x:  DIO2
+// RF69:          DIO2
+// SX1231:        DIO2
+// CC1101:        GDO2
+// Si443x/RFM2x:  GPIO
+// SX126x/LLCC68: DIO2
+AFSKClient audio(&radio, 5);
+
+// create AX.25 client instance using the AFSK instance
+AX25Client ax25(&audio);
+
+// create APRS client instance using the AX.25 client
+APRSClient aprs(&ax25);
+
+void setup() {
+  Serial.begin(9600);
+
+  // initialize SX1278
+  // NOTE: moved to ISM band on purpose
+  //       DO NOT transmit in APRS bands without ham radio license!
+  Serial.print(F("[SX1278] Initializing ... "));
+  int state = radio.beginFSK();
+
+  // when using one of the non-LoRa modules for AX.25
+  // (RF69, CC1101, Si4432 etc.), use the basic begin() method
+  // int state = radio.begin();
+
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+
+  // initialize AX.25 client
+  Serial.print(F("[AX.25] Initializing ... "));
+  // source station callsign:     "N7LEM"
+  // source station SSID:         0
+  // preamble length:             8 bytes
+  state = ax25.begin("N7LEM");
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+
+  // initialize APRS client
+  Serial.print(F("[APRS] Initializing ... "));
+  // symbol:                      '>' (car)
+  state = aprs.begin('>');
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+}
+
+void loop() {
+  Serial.print(F("[APRS] Sending Mic-E position ... "));
+  int state = aprs.sendMicE(49.1945, 16.6000, 120, 10, RADIOLIB_APRS_MIC_E_TYPE_EN_ROUTE);
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+  }
+
+  // wait one minute before transmitting again
+  delay(60000);
+}
--- a/RadioLib/examples/APRS/APRS_Position/APRS_Position.ino
+++ b/RadioLib/examples/APRS/APRS_Position/APRS_Position.ino
@@ -0,0 +1,157 @@
+/*
+  RadioLib APRS Position Example
+
+  This example sends APRS position reports 
+  using SX1278's FSK modem. The data is
+  modulated as AFSK at 1200 baud using Bell 
+  202 tones.
+
+  DO NOT transmit in APRS bands unless
+  you have a ham radio license!
+
+  Other modules that can be used for APRS:
+  - SX127x/RFM9x
+  - RF69
+  - SX1231
+  - CC1101
+  - nRF24
+  - Si443x/RFM2x
+  - SX126x/LLCC68
+
+  For default module settings, see the wiki page
+  https://github.com/jgromes/RadioLib/wiki/Default-configuration
+
+  For full API reference, see the GitHub Pages
+  https://jgromes.github.io/RadioLib/
+*/
+
+// include the library
+#include <RadioLib.h>
+
+// SX1278 has the following connections:
+// NSS pin:   10
+// DIO0 pin:  2
+// RESET pin: 9
+// DIO1 pin:  3
+SX1278 radio = new Module(10, 2, 9, 3);
+
+// or detect the pinout automatically using RadioBoards
+// https://github.com/radiolib-org/RadioBoards
+/*
+#define RADIO_BOARD_AUTO
+#include <RadioBoards.h>
+Radio radio = new RadioModule();
+*/
+
+// create AFSK client instance using the FSK module
+// this requires connection to the module direct
+// input pin, here connected to Arduino pin 5
+// SX127x/RFM9x:  DIO2
+// RF69:          DIO2
+// SX1231:        DIO2
+// CC1101:        GDO2
+// Si443x/RFM2x:  GPIO
+// SX126x/LLCC68: DIO2
+AFSKClient audio(&radio, 5);
+
+// create AX.25 client instance using the AFSK instance
+AX25Client ax25(&audio);
+
+// create APRS client instance using the AX.25 client
+APRSClient aprs(&ax25);
+
+void setup() {
+  Serial.begin(9600);
+
+  // initialize SX1278
+  // NOTE: moved to ISM band on purpose
+  //       DO NOT transmit in APRS bands without ham radio license!
+  Serial.print(F("[SX1278] Initializing ... "));
+  int state = radio.beginFSK(434.0);
+
+  // when using one of the non-LoRa modules for AX.25
+  // (RF69, CC1101, Si4432 etc.), use the basic begin() method
+  // int state = radio.begin();
+
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+
+  // initialize AX.25 client
+  Serial.print(F("[AX.25] Initializing ... "));
+  // source station callsign:     "N7LEM"
+  // source station SSID:         0
+  // preamble length:             8 bytes
+  state = ax25.begin("N7LEM");
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+
+  // initialize APRS client
+  Serial.print(F("[APRS] Initializing ... "));
+  // symbol:                      '>' (car)
+  state = aprs.begin('>');
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+}
+
+void loop() {
+  Serial.println(F("[APRS] Sending location reports"));
+  
+  // send a location without message or timestamp
+  char destination[] = "N0CALL";
+  char latitude[] = "4911.67N";
+  char longitude[] = "01635.96E";
+  int state = aprs.sendPosition(destination, 0, latitude, longitude);
+  if(state != RADIOLIB_ERR_NONE) {
+    Serial.print(F("[APRS] Failed to send location, code "));
+    Serial.println(state);
+  }
+  delay(500);
+  
+  // send a location with message and without timestamp
+  char message[] = "I'm here!";
+  state = aprs.sendPosition(destination, 0, latitude, longitude, message);
+  if(state != RADIOLIB_ERR_NONE) {
+    Serial.print(F("[APRS] Failed to send location and message code "));
+    Serial.println(state);
+  }
+  delay(500);
+
+  // you can also set repeater callsigns and SSIDs
+  // up to 8 repeaters may be used
+  // sendPosition will be sent with "WIDE2-2" path
+  char* repeaterCallsigns[] = { "WIDE2" };
+  uint8_t repeaterSSIDs[] = { 2 };
+  aprs.useRepeaters(repeaterCallsigns, repeaterSSIDs, 1);
+  
+  // send a location with message and timestamp
+  char timestamp[] = "093045z";
+  state = aprs.sendPosition(destination, 0, latitude, longitude, message, timestamp);
+  if(state != RADIOLIB_ERR_NONE) {
+    Serial.print(F("[APRS] Failed to send location, message and timestamp code "));
+    Serial.println(state);
+  }
+  delay(500);
+
+  // when repeaters are no longer needed, they can be dropped
+  aprs.dropRepeaters();
+
+  // wait one minute before transmitting again
+  Serial.println(F("[APRS] All done!"));
+  delay(60000);
+}
+
--- a/RadioLib/examples/APRS/APRS_Position_LoRa/APRS_Position_LoRa.ino
+++ b/RadioLib/examples/APRS/APRS_Position_LoRa/APRS_Position_LoRa.ino
@@ -0,0 +1,106 @@
+/*
+  RadioLib APRS Position over LoRa Example
+
+  This example sends APRS position reports 
+  using SX1278's LoRa modem.
+
+  Other modules that can be used for APRS:
+  - SX127x/RFM9x
+  - SX126x/LLCC68
+  - SX128x
+  - LR11x0
+
+  For default module settings, see the wiki page
+  https://github.com/jgromes/RadioLib/wiki/Default-configuration
+
+  For full API reference, see the GitHub Pages
+  https://jgromes.github.io/RadioLib/
+*/
+
+// include the library
+#include <RadioLib.h>
+
+// SX1278 has the following connections:
+// NSS pin:   10
+// DIO0 pin:  2
+// RESET pin: 9
+// DIO1 pin:  3
+SX1278 radio = new Module(10, 2, 9, 3);
+
+// or detect the pinout automatically using RadioBoards
+// https://github.com/radiolib-org/RadioBoards
+/*
+#define RADIO_BOARD_AUTO
+#include <RadioBoards.h>
+Radio radio = new RadioModule();
+*/
+
+// create APRS client instance using the LoRa radio
+APRSClient aprs(&radio);
+
+void setup() {
+  Serial.begin(9600);
+
+  // initialize SX1278 with the settings necessary for LoRa iGates
+  Serial.print(F("[SX1278] Initializing ... "));
+  // frequency:                   433.775 MHz
+  // bandwidth:                   125 kHz
+  // spreading factor:            12
+  // coding rate:                 4/5
+  int state = radio.begin(433.775, 125, 12, 5);
+
+  // when using one of the non-LoRa modules for AX.25
+  // (RF69, CC1101, Si4432 etc.), use the basic begin() method
+  // int state = radio.begin();
+
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+
+  // initialize APRS client
+  Serial.print(F("[APRS] Initializing ... "));
+  // symbol:                      '>' (car)
+  // callsign                     "N7LEM"
+  // SSID                         1
+  char source[] = "N7LEM";
+  state = aprs.begin('>', source, 1);
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+    while (true) { delay(10); }
+  }
+}
+
+void loop() {
+  Serial.print(F("[APRS] Sending position ... "));
+  
+  // send a location with message and timestamp
+  // SSID is set to 1, as APRS over LoRa uses WIDE1-1 path by default
+  char destination[] = "GPS";
+  char latitude[] = "4911.67N";
+  char longitude[] = "01635.96E";
+  char message[] = "I'm here!";
+  char timestamp[] = "093045z";
+  int state = aprs.sendPosition(destination, 1, latitude, longitude, message, timestamp);
+  delay(500);
+
+  // you can also send Mic-E encoded messages
+  state |= state = aprs.sendMicE(49.1945, 16.6000, 120, 10, RADIOLIB_APRS_MIC_E_TYPE_EN_ROUTE);
+  delay(500);
+
+  if(state == RADIOLIB_ERR_NONE) {
+    Serial.println(F("success!"));
+  } else {
+    Serial.print(F("failed, code "));
+    Serial.println(state);
+  }
+
+  // wait one minute before transmitting again
+  delay(60000);
+}