From 779e0aa4dd624c23f21351cb783000c255adc2a2 Mon Sep 17 00:00:00 2001 From: jgromes Date: Wed, 29 Jan 2025 20:45:41 +0100 Subject: [PATCH] [SX126x] Rename LR-FHSS modem example to transmit --- .../SX126x_LR_FHSS_Modem.ino | 96 --------------- .../SX126x_LR_FHSS_Transmit_Blocking.ino | 113 ++++++++++++++++++ 2 files changed, 113 insertions(+), 96 deletions(-) delete mode 100644 examples/SX126x/SX126x_LR_FHSS_Modem/SX126x_LR_FHSS_Modem.ino create mode 100644 examples/SX126x/SX126x_LR_FHSS_Transmit_Blocking/SX126x_LR_FHSS_Transmit_Blocking.ino diff --git a/examples/SX126x/SX126x_LR_FHSS_Modem/SX126x_LR_FHSS_Modem.ino b/examples/SX126x/SX126x_LR_FHSS_Modem/SX126x_LR_FHSS_Modem.ino deleted file mode 100644 index 44519d51..00000000 --- a/examples/SX126x/SX126x_LR_FHSS_Modem/SX126x_LR_FHSS_Modem.ino +++ /dev/null @@ -1,96 +0,0 @@ -/* - RadioLib SX126x LR-FHSS Modem Example - - This example shows how to use LR-FHSS modem in SX126x chips. - This modem can only transmit data, and is not able to receive. - - NOTE: The sketch below is just a guide on how to use - LR-FHSS modem, so this code should not be run directly! - Instead, modify the other examples to use LR-FHSS - modem and use the appropriate configuration - methods. - - For default module settings, see the wiki page - https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lr-fhss-modem - - For full API reference, see the GitHub Pages - https://jgromes.github.io/RadioLib/ -*/ - -// include the library -#include - -// SX1262 has the following connections: -// NSS pin: 10 -// IRQ pin: 2 -// NRST pin: 3 -// BUSY pin: 9 -SX1262 radio = new Module(10, 2, 3, 9); - -// or detect the pinout automatically using RadioBoards -// https://github.com/radiolib-org/RadioBoards -/* -#define RADIO_BOARD_AUTO -#include -Radio radio = new RadioModule(); -*/ - -void setup() { - Serial.begin(9600); - - // initialize SX1262 with default settings - Serial.print(F("[SX1262] Initializing ... ")); - int state = radio.beginLRFHSS(); - if (state == RADIOLIB_ERR_NONE) { - Serial.println(F("success!")); - } else { - Serial.print(F("failed, code ")); - Serial.println(state); - while (true) { delay(10); } - } - - // if needed, you can switch between any of the modems - // - // radio.begin() start LoRa modem (and disable LR-FHSS) - // radio.beginLRFHSS() start LR-FHSS modem (and disable LoRa) - - // the following settings can also - // be modified at run-time - state = radio.setFrequency(433.5); - state = radio.setLrFhssConfig(RADIOLIB_SX126X_LR_FHSS_BW_1523_4, // bandwidth - RADIOLIB_SX126X_LR_FHSS_CR_1_2, // coding rate - 3, // header count - 0x13A); // hopping sequence seed - state = radio.setOutputPower(10.0); - uint8_t syncWord[] = {0x01, 0x23, 0x45, 0x67}; - state = radio.setSyncWord(syncWord, 4); - if (state != RADIOLIB_ERR_NONE) { - Serial.print(F("Unable to set configuration, code ")); - Serial.println(state); - while (true) { delay(10); } - } - - #warning "This sketch is just an API guide! Read the note at line 6." -} - -void loop() { - // LR-FHSS modem can only transmit! - // transmit LR-FHSS packet - int state = radio.transmit("Hello World!"); - /* - byte byteArr[] = {0x01, 0x23, 0x45, 0x67, - 0x89, 0xAB, 0xCD, 0xEF}; - int state = radio.transmit(byteArr, 8); - */ - if (state == RADIOLIB_ERR_NONE) { - Serial.println(F("[SX1262] Packet transmitted successfully!")); - } else if (state == RADIOLIB_ERR_PACKET_TOO_LONG) { - Serial.println(F("[SX1262] Packet too long!")); - } else if (state == RADIOLIB_ERR_TX_TIMEOUT) { - Serial.println(F("[SX1262] Timed out while transmitting!")); - } else { - Serial.println(F("[SX1262] Failed to transmit packet, code ")); - Serial.println(state); - } - -} diff --git a/examples/SX126x/SX126x_LR_FHSS_Transmit_Blocking/SX126x_LR_FHSS_Transmit_Blocking.ino b/examples/SX126x/SX126x_LR_FHSS_Transmit_Blocking/SX126x_LR_FHSS_Transmit_Blocking.ino new file mode 100644 index 00000000..4dea005b --- /dev/null +++ b/examples/SX126x/SX126x_LR_FHSS_Transmit_Blocking/SX126x_LR_FHSS_Transmit_Blocking.ino @@ -0,0 +1,113 @@ +/* + RadioLib SX126x LR-FHSS Modem Example + + This example shows how to use LR-FHSS modem in SX126x chips. + This modem can only transmit data, and is not able to receive. + + This example transmits packets using SX1262 LoRa radio module. + Each packet contains up to 256 bytes of data, in the form of: + - Arduino String + - null-terminated char array (C-string) + - arbitrary binary data (byte array) + + Other modules from SX126x family can also be used. + + Using blocking transmit is not recommended, as it will lead + to inefficient use of processor time! + Instead, interrupt transmit is recommended. + + For default module settings, see the wiki page + https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lr-fhss-modem + + For full API reference, see the GitHub Pages + https://jgromes.github.io/RadioLib/ +*/ + +// include the library +#include + +// SX1262 has the following connections: +// NSS pin: 10 +// IRQ pin: 2 +// NRST pin: 3 +// BUSY pin: 9 +SX1262 radio = new Module(10, 2, 3, 9); + +// or detect the pinout automatically using RadioBoards +// https://github.com/radiolib-org/RadioBoards +/* +#define RADIO_BOARD_AUTO +#include +Radio radio = new RadioModule(); +*/ + +void setup() { + Serial.begin(9600); + + // initialize SX1262 with default settings + Serial.print(F("[SX1262] Initializing ... ")); + int state = radio.beginLRFHSS(); + if (state == RADIOLIB_ERR_NONE) { + Serial.println(F("success!")); + } else { + Serial.print(F("failed, code ")); + Serial.println(state); + while (true) { delay(10); } + } + + // some modules have an external RF switch + // controlled via two pins (RX enable, TX enable) + // to enable automatic control of the switch, + // call the following method + // RX enable: 4 + // TX enable: 5 + /* + radio.setRfSwitchPins(4, 5); + */ +} + +// counter to keep track of transmitted packets +int count = 0; + +void loop() { + // LR-FHSS modem can only transmit! + Serial.print(F("[SX1262] Transmitting packet ... ")); + + // you can transmit C-string or Arduino string up to + // 256 characters long + String str = "Hello World! #" + String(count++); + int state = radio.transmit(str); + + // you can also transmit byte array up to 256 bytes long + /* + byte byteArr[] = {0x01, 0x23, 0x45, 0x56, 0x78, 0xAB, 0xCD, 0xEF}; + int state = radio.transmit(byteArr, 8); + */ + + if (state == RADIOLIB_ERR_NONE) { + // the packet was successfully transmitted + Serial.println(F("success!")); + + // print measured data rate + Serial.print(F("[SX1262] Datarate:\t")); + Serial.print(radio.getDataRate()); + Serial.println(F(" bps")); + + } else if (state == RADIOLIB_ERR_PACKET_TOO_LONG) { + // the supplied packet was longer than 256 bytes + Serial.println(F("too long!")); + + } else if (state == RADIOLIB_ERR_TX_TIMEOUT) { + // timeout occurred while transmitting packet + Serial.println(F("timeout!")); + + } else { + // some other error occurred + Serial.print(F("failed, code ")); + Serial.println(state); + + } + + // wait for a second before transmitting again + delay(1000); +}