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/Config.h@4:aad57e03bf82, 2017-09-28 (annotated)

Committer:
ubhat
Date:
Thu Sep 28 04:53:55 2017 +0000
Revision:
4:aad57e03bf82
Parent:
3:4bca7f8f731a
Child:
6:c5f2da0de0b0
Minor edits

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: End device communication parameters
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
ubhat 0:42863a11464a 16 #ifndef __LORA_CONFIG_H__
ubhat 0:42863a11464a 17 #define __LORA_CONFIG_H__
ubhat 0:42863a11464a 18
ubhat 0:42863a11464a 19 /*!
ubhat 0:42863a11464a 20 * Configure End-Device to use 8-channels corresponding to Block A
ubhat 0:42863a11464a 21 * Comment/Uncomment to disable/enable Hybrid mode
ubhat 0:42863a11464a 22 */
ubhat 0:42863a11464a 23 #define USE_BAND_915_HYBRID
ubhat 0:42863a11464a 24
ubhat 0:42863a11464a 25 #ifndef USE_BAND_915_HYBRID
ubhat 0:42863a11464a 26 /*!
ubhat 0:42863a11464a 27 * Configure End-Device to use 64-channels across to Block A thru Block H
ubhat 0:42863a11464a 28 */
ubhat 0:42863a11464a 29 #define USE_BAND_915
ubhat 0:42863a11464a 30
ubhat 0:42863a11464a 31 #endif
ubhat 0:42863a11464a 32
ubhat 0:42863a11464a 33 /*!
ubhat 0:42863a11464a 34 * Join requests trials periodicity. It is the time between RX1/RX2 and next TX
ubhat 0:42863a11464a 35 */
ubhat 0:42863a11464a 36 #define OVER_THE_AIR_ACTIVATION_DUTYCYCLE 5000000 // value in us
ubhat 0:42863a11464a 37
ubhat 0:42863a11464a 38 /*!
ubhat 0:42863a11464a 39 * Defines the application data transmission periodicity. It is the time between RX1/RX2 and next TX
ubhat 0:42863a11464a 40 */
ubhat 0:42863a11464a 41 #define APP_TX_DUTYCYCLE 5000000 // value in us
ubhat 0:42863a11464a 42
ubhat 0:42863a11464a 43 /*!
ubhat 0:42863a11464a 44 * LoRaWAN confirmed messages
ubhat 0:42863a11464a 45 * \remark 1 : Confirmed messages enabled. Must receive ACK from network server
ubhat 0:42863a11464a 46 0 : Confirmed messages disabled.
ubhat 0:42863a11464a 47 */
ubhat 0:42863a11464a 48 #define LORAWAN_CONFIRMED_MSG_ON 1
ubhat 0:42863a11464a 49
ubhat 0:42863a11464a 50 /*!
ubhat 0:42863a11464a 51 * LoRaWAN Adaptive Data Rate
ubhat 0:42863a11464a 52 *
ubhat 0:42863a11464a 53 * \remark Please note that when ADR is enabled the end-device uses default datarate of DR_0
ubhat 0:42863a11464a 54 */
ubhat 0:42863a11464a 55 #define LORAWAN_ADR_ON 0
ubhat 0:42863a11464a 56
ubhat 0:42863a11464a 57 /*!
ubhat 0:42863a11464a 58 * Default mote datarate
ubhat 0:42863a11464a 59 * \remark DR_0 : 980 bps; DR_1 : 1760 bps; DR_2 : 3125 bps; DR_3 : 5470 bps; DR_4 : 12500 bps
ubhat 0:42863a11464a 60 */
ubhat 0:42863a11464a 61 #define LORAWAN_DEFAULT_DATARATE DR_0
ubhat 0:42863a11464a 62
ubhat 0:42863a11464a 63 /*!
ubhat 0:42863a11464a 64 * LoRaWAN application port
ubhat 0:42863a11464a 65 */
ubhat 4:aad57e03bf82 66 #define LORAWAN_APP_PORT 5
ubhat 0:42863a11464a 67
ubhat 0:42863a11464a 68 /*!
ubhat 0:42863a11464a 69 * LoRaWAN User defined Tx Power
ubhat 0:42863a11464a 70 *
ubhat 0:42863a11464a 71 * \remark The Tx power level is set as TX_POWER_P_DBM, where 10 <= P <= 30 and P is even value { i.e. P = 10, 12, 14 ... 28 or 30 }
ubhat 0:42863a11464a 72 */
ubhat 0:42863a11464a 73 #define LORAWAN_TX_POWER TX_POWER_20_DBM
ubhat 0:42863a11464a 74
ubhat 0:42863a11464a 75 #if ( LORAWAN_APP_PORT == 5 )
ubhat 0:42863a11464a 76 /*====================================================
ubhat 4:aad57e03bf82 77 RAMP DATA APPLICATION DEMO (PORT 5)
ubhat 0:42863a11464a 78 ====================================================*/
ubhat 0:42863a11464a 79
ubhat 0:42863a11464a 80 /*!
ubhat 0:42863a11464a 81 * User application data buffer size
ubhat 0:42863a11464a 82 */
ubhat 0:42863a11464a 83 #define LORAWAN_APP_DATA_SIZE 11
ubhat 0:42863a11464a 84
ubhat 0:42863a11464a 85 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:42863a11464a 86
ubhat 2:78df92a365c2 87 #elif ( LORAWAN_APP_PORT == 8 )
ubhat 0:42863a11464a 88 /*====================================================
ubhat 2:78df92a365c2 89 IKS01A1 SENSOR DATA (PORT 8)
ubhat 0:42863a11464a 90 ====================================================*/
ubhat 0:42863a11464a 91
ubhat 2:78df92a365c2 92 #define USE_IKS01A1_SENSOR
ubhat 0:42863a11464a 93 /*!
ubhat 0:42863a11464a 94 * User application data buffer size
ubhat 0:42863a11464a 95 */
ubhat 0:42863a11464a 96 #define LORAWAN_APP_DATA_SIZE 11
ubhat 0:42863a11464a 97
ubhat 0:42863a11464a 98 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:42863a11464a 99
ubhat 3:4bca7f8f731a 100 #elif ( LORAWAN_APP_PORT == 9 )
ubhat 3:4bca7f8f731a 101 /*====================================================
ubhat 3:4bca7f8f731a 102 IKS01A1 SENSOR DATA (PORT 9) + CAYENNE LPP
ubhat 3:4bca7f8f731a 103 ====================================================*/
ubhat 3:4bca7f8f731a 104
ubhat 3:4bca7f8f731a 105 #define USE_IKS01A1_SENSOR
ubhat 3:4bca7f8f731a 106
ubhat 3:4bca7f8f731a 107 #define USE_CAYENNE_LPP
ubhat 3:4bca7f8f731a 108 /*!
ubhat 3:4bca7f8f731a 109 * User application data buffer size
ubhat 3:4bca7f8f731a 110 */
ubhat 3:4bca7f8f731a 111 #define LORAWAN_APP_DATA_SIZE 11
ubhat 3:4bca7f8f731a 112
ubhat 3:4bca7f8f731a 113 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 3:4bca7f8f731a 114
ubhat 0:42863a11464a 115 #elif ( LORAWAN_APP_PORT == 11 )
ubhat 0:42863a11464a 116 /*====================================================
ubhat 0:42863a11464a 117 PUSH BUTTON DEMO (PORT 11)
ubhat 0:42863a11464a 118 ====================================================*/
ubhat 0:42863a11464a 119
ubhat 0:42863a11464a 120 /*!
ubhat 0:42863a11464a 121 * User application data buffer size
ubhat 0:42863a11464a 122 */
ubhat 0:42863a11464a 123 #define LORAWAN_APP_DATA_SIZE 2
ubhat 0:42863a11464a 124
ubhat 0:42863a11464a 125 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:42863a11464a 126
ubhat 0:42863a11464a 127 #endif
ubhat 0:42863a11464a 128
ubhat 0:42863a11464a 129 #endif // __LORA_CONFIG_H__