Uttam Bhat / LoRaWAN-SX1276-Application-Demo

SX1276 Shield based Applications

Dependencies:   X_NUCLEO_IKS01A1 LoRaWAN-lib SX1276Lib mbed

LoRaWAN-SX1276-Application Demo uses SX1276MB1LAS mbed component shield on a nucleo board platform to demonstrate a Class-A LoRaWAN device in the 915MHz ISM band for North American region. It uses the LoRaWAN-lib and SX1276Lib libraries.

Comissioning.h (LoRaWAN Network Configuration)

The end-device can be activated in one of the two ways:

Over the Air (OTA) activation can be enabled as shown in the figure below. /media/uploads/ubhat/ota_enable.png

The end-device must be configured with the following parameters:

  • LORAWAN_DEVICE_EUI (8 Bytes) : Fist 3 Bytes is the Organizationally Unique Identifier (OUI) followed by 5 bytes of unique ID. If not defined by user, then the firmware automatically assigns one to the end-device
  • LORAWAN_APPLICATION_EUI (8 Bytes)
  • LORAWAN_APPLICATION_KEY (or DEVKEY) (16 Bytes)

/media/uploads/ubhat/ota_eui.png

Activation by Personalization (ABP) can be enabled as shown in the figure below. /media/uploads/ubhat/abp_enable.png

The end-device must be configured with the following parameters:

  • LORAWAN_DEVICE_ADDRESS (4 Bytes) : If not defined by user, then the firmware automatically assigns one to the end-device
  • LORAWAN_NWKSKEY (16 Bytes)
  • LORAWAN_APPSKEY (16 Bytes)

/media/uploads/ubhat/abp_key.png

Config.h (LoRaWAN Communication Parameters)

  • Mode of Operation : Hybrid If the end-device needs to be configured to operate over 8-channels, then Hybrid Mode needs to be enabled /media/uploads/ubhat/hybridenable.png
  • Mode of Operation : Frequency Hop If the end-device needs to be configured to operate over 64-channels, then Hybrid Mode needs to be disabled
  • Delay between successive JOIN REQUESTs : The delay between successive Join Requests (until the end-device joins the network) can be configured using the parameter OVER_THE_AIR_ACTIVATION_DUTYCYCLE
  • Inter-Frame Delay : One can change the delay between each frame transmission using APP_TX_DUTYCYCLE It is advisable that APP_TX_DUTYCYCLE is greater than or equal to 3sec.
  • Data Rate : The data rate can be configured as per LoRaWAN specification using the paramter LORAWAN_DEFAULT_DATARATE. The range of values are DR_0, DR_1, DR_2, DR_3 and DR_4
  • Confirmed/Unconfirmed Messages : The uplink message or payload can be chosen to be confirmed or unconfirmed using the parameter LORAWAN_CONFIRMED_MSG_ON. When set to 1, the transmitted messages need to be confirmed with an ACK by the network server in the subsequent RX window. When set to 0, no ACK is requested.
  • ADR ON/OFF : The ADR can be enabled or disabled using the parameter LORAWAN_ADR_ON. When set to 1, ADR is enabled and disabled when set to 0.
  • Application Port : The application port can be set using parameter LORAWAN_APP_PORT. A few examples are associated to specific Application Port, and are defined in Config.h
  • Payload Length : The lenght of the payload (in bytes) to be transmitted can be configured using LORAWAN_APP_DATA_SIZE
  • Transmit Power : The transmit power can be configured using LORAWAN_TX_POWER (LoRaMAC verifies if the set power is compliant with the LoRaWAN spec and FCC guidelines)

/media/uploads/ubhat/loraconfig.png

The baud-rate for serial terminal display is 115200

app/Common.h@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
SX1276 Shield based Applications

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:42863a11464a 1 /*
ubhat 0:42863a11464a 2 / _____) _ | |
ubhat 0:42863a11464a 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:42863a11464a 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:42863a11464a 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:42863a11464a 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:42863a11464a 7 (C)2015 Semtech
ubhat 0:42863a11464a 8
ubhat 0:42863a11464a 9 Description: Extern declaration of parameters defined in main.cpp
ubhat 0:42863a11464a 10
ubhat 0:42863a11464a 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:42863a11464a 12
ubhat 0:42863a11464a 13 Maintainer: Uttam Bhat
ubhat 0:42863a11464a 14 */
ubhat 0:42863a11464a 15 #ifndef __COMMON_H__
ubhat 0:42863a11464a 16 #define __COMMON_H__
ubhat 0:42863a11464a 17
ubhat 0:42863a11464a 18 #include "Comissioning.h"
ubhat 0:42863a11464a 19 #include "board.h"
ubhat 0:42863a11464a 20
ubhat 0:42863a11464a 21 /*!
ubhat 0:42863a11464a 22 * User application data buffer size
ubhat 0:42863a11464a 23 */
ubhat 0:42863a11464a 24 #define LORAWAN_APP_DATA_MAX_SIZE 64
ubhat 0:42863a11464a 25
ubhat 0:42863a11464a 26 /*!
ubhat 0:42863a11464a 27 * Current network ID
ubhat 0:42863a11464a 28 */
ubhat 0:42863a11464a 29 #define LORAWAN_NETWORK_ID ( uint32_t )0
ubhat 0:42863a11464a 30
ubhat 0:42863a11464a 31
ubhat 0:42863a11464a 32 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:42863a11464a 33 /*!
ubhat 0:42863a11464a 34 * Over the Air Activation
ubhat 0:42863a11464a 35 */
ubhat 0:42863a11464a 36
ubhat 0:42863a11464a 37 extern uint8_t DevEui[];
ubhat 0:42863a11464a 38 extern uint8_t AppEui[];
ubhat 0:42863a11464a 39 extern uint8_t AppKey[];
ubhat 0:42863a11464a 40
ubhat 0:42863a11464a 41 #else
ubhat 0:42863a11464a 42 /*!
ubhat 0:42863a11464a 43 * Activation by Personalization
ubhat 0:42863a11464a 44 */
ubhat 0:42863a11464a 45
ubhat 0:42863a11464a 46 extern uint8_t NwkSKey[];
ubhat 0:42863a11464a 47 extern uint8_t AppSKey[];
ubhat 0:42863a11464a 48 extern uint32_t DevAddr;
ubhat 0:42863a11464a 49
ubhat 0:42863a11464a 50 #endif
ubhat 0:42863a11464a 51
ubhat 0:42863a11464a 52 extern uint8_t AppData[LORAWAN_APP_DATA_MAX_SIZE]; // User application data size
ubhat 0:42863a11464a 53
ubhat 0:42863a11464a 54 extern uint8_t AppPort; // Application port
ubhat 0:42863a11464a 55
ubhat 0:42863a11464a 56 extern uint8_t AppDataSize; // Application size
ubhat 0:42863a11464a 57
ubhat 0:42863a11464a 58 extern uint8_t IsTxConfirmed; // Indicates if the node is sending confirmed or unconfirmed messages
ubhat 0:42863a11464a 59
ubhat 0:42863a11464a 60 extern bool IsTxIntUpdate; // Indicates if a new transmit interrupt can be set
ubhat 0:42863a11464a 61
ubhat 0:42863a11464a 62 extern bool NextTx; // Indicates if a new packet can be sent
ubhat 0:42863a11464a 63
ubhat 0:42863a11464a 64 extern bool IsNetworkJoinedStatusUpdate; // Indicates if the MAC layer network join status has changed.
ubhat 0:42863a11464a 65
ubhat 0:42863a11464a 66 extern bool IsTxUpdate; // Indicates if the message sent
ubhat 0:42863a11464a 67
ubhat 0:42863a11464a 68 extern bool IsRxUpdate; // Indicates if the message received in the RX window.
ubhat 0:42863a11464a 69
ubhat 0:42863a11464a 70 extern TimerEvent_t TxNextPacketTimer; // Timer to handle the application data transmission duty cycle
ubhat 0:42863a11464a 71
ubhat 0:42863a11464a 72 #endif // __COMMON_H__