| SX126x-Arduino 2.0.1

LoRaWanPio\src\main.cpp

LoRaWAN application example.

#include <Arduino.h>
#include <LoRaWan-Arduino.h>
#include <SPI.h>
#define SCHED_MAX_EVENT_DATA_SIZE APP_TIMER_SCHED_EVENT_DATA_SIZE
#define SCHED_QUEUE_SIZE 60
#define LORAWAN_APP_DATA_BUFF_SIZE 64
#define LORAWAN_APP_TX_DUTYCYCLE 10000
#define APP_TX_DUTYCYCLE_RND 1000
#define JOINREQ_NBTRIALS 3
hw_config hwConfig;
#ifdef ESP32
// ESP32 - SX126x pin configuration
int PIN_LORA_RESET = 4; // LORA RESET
int PIN_LORA_NSS = 5; // LORA SPI CS
int PIN_LORA_SCLK = 18; // LORA SPI CLK
int PIN_LORA_MISO = 19; // LORA SPI MISO
int PIN_LORA_DIO_1 = 21; // LORA DIO_1
int PIN_LORA_BUSY = 22; // LORA SPI BUSY
int PIN_LORA_MOSI = 23; // LORA SPI MOSI
int RADIO_TXEN = -1; // LORA ANTENNA TX ENABLE
int RADIO_RXEN = -1; // LORA ANTENNA RX ENABLE
#endif
#ifdef ESP8266
// ESP32 - SX126x pin configuration
int PIN_LORA_RESET = 0; // LORA RESET
int PIN_LORA_NSS = 2; // LORA SPI CS
int PIN_LORA_DIO_1 = 15; // LORA DIO_1
int PIN_LORA_BUSY = 16; // LORA SPI BUSY
int PIN_LORA_SCLK = SCK; // LORA SPI CLK
int PIN_LORA_MISO = MISO; // LORA SPI MISO
int PIN_LORA_MOSI = MOSI; // LORA SPI MOSI
int RADIO_TXEN = -1; // LORA ANTENNA TX ENABLE
int RADIO_RXEN = -1; // LORA ANTENNA RX ENABLE
#endif
#ifdef NRF52_SERIES
// nRF52832 - SX126x pin configuration
int PIN_LORA_RESET = 4; // LORA RESET
int PIN_LORA_NSS = 28; // LORA SPI CS
int PIN_LORA_SCLK = 12; // LORA SPI CLK
int PIN_LORA_MISO = 14; // LORA SPI MISO
int PIN_LORA_DIO_1 = 11; // LORA DIO_1
int PIN_LORA_BUSY = 29; // LORA SPI BUSY
int PIN_LORA_MOSI = 13; // LORA SPI MOSI
int RADIO_TXEN = -1; // LORA ANTENNA TX ENABLE
int RADIO_RXEN = -1; // LORA ANTENNA RX ENABLE
// Replace PIN_SPI_MISO, PIN_SPI_SCK, PIN_SPI_MOSI with your
SPIClass SPI_LORA(NRF_SPIM2, 14, 12, 13);
#endif
// Foward declaration
static void lorawan_has_joined_handler(void);
static void lorawan_rx_handler(lmh_app_data_t *app_data);
static void lorawan_confirm_class_handler(DeviceClass_t Class);
static void lorawan_join_failed_handler(void);
static void send_lora_frame(void);
static uint32_t timers_init(void);
// APP_TIMER_DEF(lora_tx_timer_id); ///< LoRa tranfer timer instance.
TimerEvent_t appTimer;
static uint8_t m_lora_app_data_buffer[LORAWAN_APP_DATA_BUFF_SIZE];
static lmh_app_data_t m_lora_app_data = {m_lora_app_data_buffer, 0, 0, 0, 0};
static lmh_param_t lora_param_init = {LORAWAN_ADR_ON, LORAWAN_DEFAULT_DATARATE, LORAWAN_PUBLIC_NETWORK, JOINREQ_NBTRIALS, LORAWAN_DEFAULT_TX_POWER, LORAWAN_DUTYCYCLE_OFF};
static lmh_callback_t lora_callbacks = {BoardGetBatteryLevel, BoardGetUniqueId, BoardGetRandomSeed,
lorawan_rx_handler, lorawan_has_joined_handler,
lorawan_confirm_class_handler, lorawan_join_failed_handler};
#ifdef NRF52_SERIES
// Start BLE if we compile for nRF52
#include <bluefruit.h>
void initBLE();
extern bool bleUARTisConnected;
extern BLEUart bleuart;
#endif
// Check if the board has an LED port defined
#ifndef LED_BUILTIN
#ifdef ESP32
#define LED_BUILTIN 2
#endif
#ifdef NRF52_SERIES
#define LED_BUILTIN 17
#endif
uint8_t nodeDeviceEUI[8] = {0x00, 0x95, 0x64, 0x1F, 0xDA, 0x91, 0x19, 0x0B};
uint8_t nodeAppEUI[8] = {0x70, 0xB3, 0xD5, 0x7E, 0xD0, 0x02, 0x01, 0xE1};
uint8_t nodeAppKey[16] = {0x07, 0xC0, 0x82, 0x0C, 0x30, 0xB9, 0x08, 0x70, 0x0C, 0x0F, 0x70, 0x06, 0x00, 0xB0, 0xBE, 0x09};
uint32_t nodeDevAddr = 0x260116F8;
uint8_t nodeNwsKey[16] = {0x7E, 0xAC, 0xE2, 0x55, 0xB8, 0xA5, 0xE2, 0x69, 0x91, 0x51, 0x96, 0x06, 0x47, 0x56, 0x9D, 0x23};
uint8_t nodeAppsKey[16] = {0xFB, 0xAC, 0xB6, 0x47, 0xF3, 0x58, 0x45, 0xC7, 0x50, 0x7D, 0xBF, 0x16, 0x8B, 0xA8, 0xC1, 0x7C};
void setup()
{
pinMode(LED_BUILTIN, OUTPUT);
digitalWrite(LED_BUILTIN, LOW);
// Define the HW configuration between MCU and SX126x
hwConfig.CHIP_TYPE = SX1262_CHIP; // Example uses an eByte E22 module with an SX1262
hwConfig.PIN_LORA_RESET = PIN_LORA_RESET; // LORA RESET
hwConfig.PIN_LORA_NSS = PIN_LORA_NSS; // LORA SPI CS
hwConfig.PIN_LORA_SCLK = PIN_LORA_SCLK; // LORA SPI CLK
hwConfig.PIN_LORA_MISO = PIN_LORA_MISO; // LORA SPI MISO
hwConfig.PIN_LORA_DIO_1 = PIN_LORA_DIO_1; // LORA DIO_1
hwConfig.PIN_LORA_BUSY = PIN_LORA_BUSY; // LORA SPI BUSY
hwConfig.PIN_LORA_MOSI = PIN_LORA_MOSI; // LORA SPI MOSI
hwConfig.RADIO_TXEN = RADIO_TXEN; // LORA ANTENNA TX ENABLE
hwConfig.RADIO_RXEN = RADIO_RXEN; // LORA ANTENNA RX ENABLE
hwConfig.USE_DIO2_ANT_SWITCH = true; // Example uses an CircuitRocks Alora RFM1262 which uses DIO2 pins as antenna control
hwConfig.USE_DIO3_TCXO = true; // Example uses an CircuitRocks Alora RFM1262 which uses DIO3 to control oscillator voltage
hwConfig.USE_DIO3_ANT_SWITCH = false; // Only Insight ISP4520 module uses DIO3 as antenna control
// Initialize Serial for debug output
Serial.begin(115200);
Serial.println("=====================================");
Serial.println("SX126x LoRaWan test");
Serial.println("=====================================");
#ifdef NRF52_SERIES
pinMode(30, OUTPUT);
digitalWrite(30, HIGH);
// Start BLE if we compile for nRF52
initBLE();
#endif
// Initialize Scheduler and timer
uint32_t err_code = timers_init();
if (err_code != 0)
{
Serial.printf("timers_init failed - %d\n", err_code);
}
// Initialize LoRa chip.
err_code = lora_hardware_init(hwConfig);
if (err_code != 0)
{
Serial.printf("lora_hardware_init failed - %d\n", err_code);
}
// Setup the EUIs and Keys
lmh_setDevEui(nodeDeviceEUI);
lmh_setAppEui(nodeAppEUI);
lmh_setAppKey(nodeAppKey);
lmh_setNwkSKey(nodeNwsKey);
lmh_setAppSKey(nodeAppsKey);
lmh_setDevAddr(nodeDevAddr);
// Initialize LoRaWan
err_code = lmh_init(&lora_callbacks, lora_param_init, false);
if (err_code != 0)
{
Serial.printf("lmh_init failed - %d\n", err_code);
}
// Use either
// lmh_setSingleChannelGateway
// or
// lmh_setSubBandChannels
//
// DO NOT USE BOTH OR YOUR COMMUNICATION WILL MOST LIKELY NEVER WORK
// Setup connection to a single channel gateway
// lmh_setSingleChannelGateway(0, DR_3);
// For some regions we might need to define the sub band the gateway is listening to
// This must be called AFTER lmh_init()
if (!lmh_setSubBandChannels(1))
{
Serial.println("lmh_setSubBandChannels failed. Wrong sub band requested?");
}
// Start Join procedure
lmh_join();
}
void loop()
{
#ifdef ESP8266 // Handle Radio events
Radio.IrqProcess();
#endif
// We are on FreeRTOS, give other tasks a chance to run
// delay(100);
}
static void lorawan_join_failed_handler(void)
{
Serial.println("OVER_THE_AIR_ACTIVATION failed!");
Serial.println("Check your EUI's and Keys's!");
Serial.println("Check if a Gateway is in range!");
}
static void lorawan_has_joined_handler(void)
{
#if (OVER_THE_AIR_ACTIVATION != 0)
Serial.println("Network Joined");
#else
Serial.println("OVER_THE_AIR_ACTIVATION != 0");
#endif
lmh_class_request(CLASS_A);
TimerSetValue(&appTimer, LORAWAN_APP_TX_DUTYCYCLE);
TimerStart(&appTimer);
}
static void lorawan_rx_handler(lmh_app_data_t *app_data)
{
Serial.printf("LoRa Packet received on port %d, size:%d, rssi:%d, snr:%d\n",
app_data->port, app_data->buffsize, app_data->rssi, app_data->snr);
switch (app_data->port)
{
case 3:
// Port 3 switches the class
if (app_data->buffsize == 1)
{
switch (app_data->buffer[0])
{
case 0:
lmh_class_request(CLASS_A);
break;
case 1:
lmh_class_request(CLASS_B);
break;
case 2:
lmh_class_request(CLASS_C);
break;
default:
break;
}
}
break;
case LORAWAN_APP_PORT:
// YOUR_JOB: Take action on received data
break;
default:
break;
}
}
static void lorawan_confirm_class_handler(DeviceClass_t Class)
{
Serial.printf("switch to class %c done\n", "ABC"[Class]);
// Informs the server that switch has occurred ASAP
m_lora_app_data.buffsize = 0;
m_lora_app_data.port = LORAWAN_APP_PORT;
lmh_send(&m_lora_app_data, LMH_UNCONFIRMED_MSG);
}
static void send_lora_frame(void)
{
if (lmh_join_status_get() != LMH_SET)
{
//Not joined, try again later
Serial.println("Did not join network, skip sending frame");
return;
}
uint32_t i = 0;
m_lora_app_data.port = LORAWAN_APP_PORT;
m_lora_app_data.buffer[i++] = 'H';
m_lora_app_data.buffer[i++] = 'e';
m_lora_app_data.buffer[i++] = 'l';
m_lora_app_data.buffer[i++] = 'l';
m_lora_app_data.buffer[i++] = 'o';
m_lora_app_data.buffer[i++] = ' ';
m_lora_app_data.buffer[i++] = 'w';
m_lora_app_data.buffer[i++] = 'o';
m_lora_app_data.buffer[i++] = 'r';
m_lora_app_data.buffer[i++] = 'l';
m_lora_app_data.buffer[i++] = 'd';
m_lora_app_data.buffer[i++] = '!';
m_lora_app_data.buffsize = i;
lmh_error_status error = lmh_send(&m_lora_app_data, LMH_UNCONFIRMED_MSG);
if (error == LMH_SUCCESS)
{
}
Serial.printf("lmh_send result %d\n", error);
}
static void tx_lora_periodic_handler(void)
{
TimerSetValue(&appTimer, LORAWAN_APP_TX_DUTYCYCLE);
TimerStart(&appTimer);
Serial.println("Sending frame");
send_lora_frame();
}
static uint32_t timers_init(void)
{
appTimer.timerNum = 3;
TimerInit(&appTimer, tx_lora_periodic_handler);
return 0;
}
lmh_app_data_t::buffer
uint8_t * buffer
Definition: LoRaMacHelper.h:76
LORAWAN_DEFAULT_DATARATE
#define LORAWAN_DEFAULT_DATARATE
Definition: LoRaMacHelper.h:39
BoardGetRandomSeed
uint32_t BoardGetRandomSeed(void)
lmh_send
lmh_error_status lmh_send(lmh_app_data_t *app_data, lmh_confirm is_tx_confirmed)
Send data.
Definition: LoRaMacHelper.cpp:927
SPI_LORA
SPIClass SPI_LORA
lmh_join_status_get
lmh_join_status lmh_join_status_get(void)
Check whether the Device is joined to the network.
Definition: LoRaMacHelper.cpp:909
lmh_app_data_t
Application Data structure.
Definition: LoRaMacHelper.h:75
lmh_join
void lmh_join(void)
Join a Lora Network in class A.
Definition: LoRaMacHelper.cpp:867
TimerSetValue
void TimerSetValue(TimerEvent_t *obj, uint32_t value)
Set timer new timeout value.
CLASS_C
@ CLASS_C
Definition: LoRaMac.h:104
TimerInit
void TimerInit(TimerEvent_t *obj, void(*callback)(void))
Initializes the timer object.
TimerStart
void TimerStart(TimerEvent_t *obj)
Starts and adds the timer object to the list of timer events.
TimerEvent_s::timerNum
uint8_t timerNum
Definition: timer.h:57
lmh_app_data_t::buffsize
uint8_t buffsize
Definition: LoRaMacHelper.h:77
lmh_callback_s
LoRaMac Helper Callbacks.
Definition: LoRaMacHelper.h:86
lmh_setAppSKey
void lmh_setAppSKey(uint8_t *userAppSKey)
Set Application Session Key AES encryption/decryption cipher application session key.
Definition: LoRaMacHelper.cpp:127
lmh_app_data_t::snr
uint8_t snr
Definition: LoRaMacHelper.h:80
lmh_class_request
lmh_error_status lmh_class_request(DeviceClass_t newClass)
change Lora Class
Definition: LoRaMacHelper.cpp:1008
BoardGetUniqueId
void BoardGetUniqueId(uint8_t *id)
LMH_UNCONFIRMED_MSG
@ LMH_UNCONFIRMED_MSG
Definition: LoRaMacHelper.h:68
lora_hardware_init
uint32_t lora_hardware_init(hw_config hwConfig)
Initializes the target board peripherals.
Definition: board.cpp:56
LORAWAN_ADR_ON
#define LORAWAN_ADR_ON
Enable or disable LoRaWAN Adaptive Data Rate enabled (the end-device should be static here).
Definition: Commissioning.h:74
LORAWAN_PUBLIC_NETWORK
#define LORAWAN_PUBLIC_NETWORK
Indicates if the end-device is to be connected to a private or public network.
Definition: Commissioning.h:69
DeviceClass_t
enum eDeviceClass DeviceClass_t
Radio
const struct Radio_s Radio
Radio driver.
Definition: radio.cpp:364
lmh_setAppKey
void lmh_setAppKey(uint8_t *userAppKey)
Set Application Key AES encryption/decryption cipher application key.
Definition: LoRaMacHelper.cpp:117
lmh_app_data_t::rssi
int16_t rssi
Definition: LoRaMacHelper.h:79
CLASS_A
@ CLASS_A
Definition: LoRaMac.h:92
lmh_app_data_t::port
uint8_t port
Definition: LoRaMacHelper.h:78
BoardGetBatteryLevel
uint8_t BoardGetBatteryLevel(void)
lmh_setNwkSKey
void lmh_setNwkSKey(uint8_t *userNwkSKey)
Set Network Session Key AES encryption/decryption cipher network session key.
Definition: LoRaMacHelper.cpp:122
SX1262_CHIP
#define SX1262_CHIP
Definition: board.h:56
lmh_setDevAddr
void lmh_setDevAddr(uint32_t userDevAddr)
Set Device address on the network (big endian)
Definition: LoRaMacHelper.cpp:132
LORAWAN_DUTYCYCLE_OFF
#define LORAWAN_DUTYCYCLE_OFF
Definition: Commissioning.h:65
Radio_s::IrqProcess
void(* IrqProcess)(void)
Process radio irq.
Definition: radio.h:362
TimerEvent_s
Timer object description.
Definition: timer.h:56
lmh_setAppEui
void lmh_setAppEui(uint8_t *userAppEui)
Set Application IEEE EUI.
Definition: LoRaMacHelper.cpp:112
CLASS_B
@ CLASS_B
Definition: LoRaMac.h:98
lmh_init
lmh_error_status lmh_init(lmh_callback_t *callbacks, lmh_param_t lora_param, bool otaa, eDeviceClass nodeClass, LoRaMacRegion_t user_region)
Lora Initialisation.
Definition: LoRaMacHelper.cpp:682
lmh_setSubBandChannels
bool lmh_setSubBandChannels(uint8_t subBand)
Set custom channel mask.
Definition: LoRaMacHelper.cpp:144
lmh_setDevEui
void lmh_setDevEui(uint8_t userDevEui[])
Definition: LoRaMacHelper.cpp:107
lmh_param_s
Definition: LoRaMacHelper.h:43
LORAWAN_DEFAULT_TX_POWER
#define LORAWAN_DEFAULT_TX_POWER
Definition: LoRaMacHelper.h:40
LoRaWan-Arduino.h
LMH_SET
@ LMH_SET
Definition: LoRaMacHelper.h:55
LMH_SUCCESS
@ LMH_SUCCESS
Definition: LoRaMacHelper.h:63
LORAWAN_APP_PORT
#define LORAWAN_APP_PORT
Definition: LoRaMacHelper.h:37
lmh_error_status
lmh_error_status
Definition: LoRaMacHelper.h:61