162 lines
6.2 KiB
C
162 lines
6.2 KiB
C
#ifndef _RADIOLIB_EX_LORAWAN_CONFIG_H
|
|
#define _RADIOLIB_EX_LORAWAN_CONFIG_H
|
|
|
|
#include <RadioLib.h>
|
|
|
|
// first you have to set your radio model and pin configuration
|
|
// this is provided just as a default example
|
|
SX1278 radio = new Module(10, 2, 9, 3);
|
|
|
|
// if you have RadioBoards (https://github.com/radiolib-org/RadioBoards)
|
|
// and are using one of the supported boards, you can do the following:
|
|
/*
|
|
#define RADIO_BOARD_AUTO
|
|
#include <RadioBoards.h>
|
|
|
|
Radio radio = new RadioModule();
|
|
*/
|
|
|
|
// how often to send an uplink - consider legal & FUP constraints - see notes
|
|
const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
|
|
|
|
// joinEUI - previous versions of LoRaWAN called this AppEUI
|
|
// for development purposes you can use all zeros - see wiki for details
|
|
#define RADIOLIB_LORAWAN_JOIN_EUI 0x0000000000000000
|
|
|
|
// the Device EUI & two keys can be generated on the TTN console
|
|
#ifndef RADIOLIB_LORAWAN_DEV_EUI // Replace with your Device EUI
|
|
#define RADIOLIB_LORAWAN_DEV_EUI 0x---------------
|
|
#endif
|
|
#ifndef RADIOLIB_LORAWAN_APP_KEY // Replace with your App Key
|
|
#define RADIOLIB_LORAWAN_APP_KEY 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--
|
|
#endif
|
|
#ifndef RADIOLIB_LORAWAN_NWK_KEY // Put your Nwk Key here
|
|
#define RADIOLIB_LORAWAN_NWK_KEY 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--, 0x--
|
|
#endif
|
|
|
|
// for the curious, the #ifndef blocks allow for automated testing &/or you can
|
|
// put your EUI & keys in to your platformio.ini - see wiki for more tips
|
|
|
|
// regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN470
|
|
const LoRaWANBand_t Region = EU868;
|
|
|
|
// subband choice: for US915/AU915 set to 2, for CN470 set to 1, otherwise leave on 0
|
|
const uint8_t subBand = 0;
|
|
|
|
// ============================================================================
|
|
// Below is to support the sketch - only make changes if the notes say so ...
|
|
|
|
// copy over the EUI's & keys in to the something that will not compile if incorrectly formatted
|
|
uint64_t joinEUI = RADIOLIB_LORAWAN_JOIN_EUI;
|
|
uint64_t devEUI = RADIOLIB_LORAWAN_DEV_EUI;
|
|
uint8_t appKey[] = { RADIOLIB_LORAWAN_APP_KEY };
|
|
uint8_t nwkKey[] = { RADIOLIB_LORAWAN_NWK_KEY };
|
|
|
|
// create the LoRaWAN node
|
|
LoRaWANNode node(&radio, &Region, subBand);
|
|
|
|
// result code to text - these are error codes that can be raised when using LoRaWAN
|
|
// however, RadioLib has many more - see https://jgromes.github.io/RadioLib/group__status__codes.html for a complete list
|
|
String stateDecode(const int16_t result) {
|
|
switch (result) {
|
|
case RADIOLIB_ERR_NONE:
|
|
return "ERR_NONE";
|
|
case RADIOLIB_ERR_CHIP_NOT_FOUND:
|
|
return "ERR_CHIP_NOT_FOUND";
|
|
case RADIOLIB_ERR_PACKET_TOO_LONG:
|
|
return "ERR_PACKET_TOO_LONG";
|
|
case RADIOLIB_ERR_RX_TIMEOUT:
|
|
return "ERR_RX_TIMEOUT";
|
|
case RADIOLIB_ERR_CRC_MISMATCH:
|
|
return "ERR_CRC_MISMATCH";
|
|
case RADIOLIB_ERR_INVALID_BANDWIDTH:
|
|
return "ERR_INVALID_BANDWIDTH";
|
|
case RADIOLIB_ERR_INVALID_SPREADING_FACTOR:
|
|
return "ERR_INVALID_SPREADING_FACTOR";
|
|
case RADIOLIB_ERR_INVALID_CODING_RATE:
|
|
return "ERR_INVALID_CODING_RATE";
|
|
case RADIOLIB_ERR_INVALID_FREQUENCY:
|
|
return "ERR_INVALID_FREQUENCY";
|
|
case RADIOLIB_ERR_INVALID_OUTPUT_POWER:
|
|
return "ERR_INVALID_OUTPUT_POWER";
|
|
case RADIOLIB_ERR_NETWORK_NOT_JOINED:
|
|
return "RADIOLIB_ERR_NETWORK_NOT_JOINED";
|
|
case RADIOLIB_ERR_DOWNLINK_MALFORMED:
|
|
return "RADIOLIB_ERR_DOWNLINK_MALFORMED";
|
|
case RADIOLIB_ERR_INVALID_REVISION:
|
|
return "RADIOLIB_ERR_INVALID_REVISION";
|
|
case RADIOLIB_ERR_INVALID_PORT:
|
|
return "RADIOLIB_ERR_INVALID_PORT";
|
|
case RADIOLIB_ERR_NO_RX_WINDOW:
|
|
return "RADIOLIB_ERR_NO_RX_WINDOW";
|
|
case RADIOLIB_ERR_INVALID_CID:
|
|
return "RADIOLIB_ERR_INVALID_CID";
|
|
case RADIOLIB_ERR_UPLINK_UNAVAILABLE:
|
|
return "RADIOLIB_ERR_UPLINK_UNAVAILABLE";
|
|
case RADIOLIB_ERR_COMMAND_QUEUE_FULL:
|
|
return "RADIOLIB_ERR_COMMAND_QUEUE_FULL";
|
|
case RADIOLIB_ERR_COMMAND_QUEUE_ITEM_NOT_FOUND:
|
|
return "RADIOLIB_ERR_COMMAND_QUEUE_ITEM_NOT_FOUND";
|
|
case RADIOLIB_ERR_JOIN_NONCE_INVALID:
|
|
return "RADIOLIB_ERR_JOIN_NONCE_INVALID";
|
|
case RADIOLIB_ERR_N_FCNT_DOWN_INVALID:
|
|
return "RADIOLIB_ERR_N_FCNT_DOWN_INVALID";
|
|
case RADIOLIB_ERR_A_FCNT_DOWN_INVALID:
|
|
return "RADIOLIB_ERR_A_FCNT_DOWN_INVALID";
|
|
case RADIOLIB_ERR_DWELL_TIME_EXCEEDED:
|
|
return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED";
|
|
case RADIOLIB_ERR_CHECKSUM_MISMATCH:
|
|
return "RADIOLIB_ERR_CHECKSUM_MISMATCH";
|
|
case RADIOLIB_ERR_NO_JOIN_ACCEPT:
|
|
return "RADIOLIB_ERR_NO_JOIN_ACCEPT";
|
|
case RADIOLIB_LORAWAN_SESSION_RESTORED:
|
|
return "RADIOLIB_LORAWAN_SESSION_RESTORED";
|
|
case RADIOLIB_LORAWAN_NEW_SESSION:
|
|
return "RADIOLIB_LORAWAN_NEW_SESSION";
|
|
case RADIOLIB_ERR_NONCES_DISCARDED:
|
|
return "RADIOLIB_ERR_NONCES_DISCARDED";
|
|
case RADIOLIB_ERR_SESSION_DISCARDED:
|
|
return "RADIOLIB_ERR_SESSION_DISCARDED";
|
|
}
|
|
return "See https://jgromes.github.io/RadioLib/group__status__codes.html";
|
|
}
|
|
|
|
// helper function to display any issues
|
|
void debug(bool failed, const __FlashStringHelper* message, int state, bool halt) {
|
|
if(failed) {
|
|
Serial.print(message);
|
|
Serial.print(" - ");
|
|
Serial.print(stateDecode(state));
|
|
Serial.print(" (");
|
|
Serial.print(state);
|
|
Serial.println(")");
|
|
while(halt) { delay(1); }
|
|
}
|
|
}
|
|
|
|
// helper function to display a byte array
|
|
void arrayDump(uint8_t *buffer, uint16_t len) {
|
|
for(uint16_t c = 0; c < len; c++) {
|
|
char b = buffer[c];
|
|
if(b < 0x10) { Serial.print('0'); }
|
|
Serial.print(b, HEX);
|
|
}
|
|
Serial.println();
|
|
}
|
|
|
|
// Custom delay function:
|
|
// Communication over LoRaWAN includes a lot of delays.
|
|
// By default, RadioLib will use the Arduino delay() function,
|
|
// which will waste a lot of power. However, you can put your
|
|
// microcontroller to sleep instead by customizing the function below,
|
|
// and providing it to RadioLib via "node.setSleepFunction".
|
|
// NOTE: You ahve to ensure that this function is timed precisely, and
|
|
// does actually wait for the amount of time specified!
|
|
// Failure to do so will result in missed downlinks or failed join!
|
|
void customDelay(RadioLibTime_t ms) {
|
|
// this is just an example, so we use the Arduino delay() function,
|
|
// but you can put your microcontroller to sleep here
|
|
::delay(ms);
|
|
}
|
|
|
|
#endif
|