Semtech / LoRaWAN-SX1272-Application-Demo

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   X_NUCLEO_IKS01A1 driver_mbed_TH02 LoRaWAN-lib-v1_0_1 SX1272Lib mbed

Fork of LoRaWAN-SX1272-Application-Demo by Uttam Bhat

LoRaWAN-SX1272-Application Demo uses https://os.mbed.com/components/SX1272MB2xAS/ 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 SX1272Lib 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:d49b89361b67, 2017-11-10 (annotated)

Committer:
ubhat
Date:
Fri Nov 10 09:22:47 2017 +0000
Revision:
4:d49b89361b67
Parent:
2:19dd7bfcacf7
Child:
6:dfba69760b76
Enable all channel octets instead of default Band-A

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:6cc76d70e2a1 1 /*
ubhat 0:6cc76d70e2a1 2 / _____) _ | |
ubhat 0:6cc76d70e2a1 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:6cc76d70e2a1 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:6cc76d70e2a1 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:6cc76d70e2a1 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:6cc76d70e2a1 7 (C)2015 Semtech
ubhat 0:6cc76d70e2a1 8
ubhat 0:6cc76d70e2a1 9 Description: End device communication parameters
ubhat 0:6cc76d70e2a1 10
ubhat 0:6cc76d70e2a1 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:6cc76d70e2a1 12
ubhat 0:6cc76d70e2a1 13 Maintainer: Uttam Bhat
ubhat 0:6cc76d70e2a1 14 */
ubhat 0:6cc76d70e2a1 15
ubhat 0:6cc76d70e2a1 16 #ifndef __LORA_CONFIG_H__
ubhat 0:6cc76d70e2a1 17 #define __LORA_CONFIG_H__
ubhat 0:6cc76d70e2a1 18
ubhat 0:6cc76d70e2a1 19 /*!
ubhat 0:6cc76d70e2a1 20 * Configure End-Device to use 8-channels corresponding to Block A
ubhat 0:6cc76d70e2a1 21 * Comment/Uncomment to disable/enable Hybrid mode
ubhat 0:6cc76d70e2a1 22 */
ubhat 0:6cc76d70e2a1 23 #define USE_BAND_915_HYBRID
ubhat 0:6cc76d70e2a1 24
ubhat 0:6cc76d70e2a1 25 #ifndef USE_BAND_915_HYBRID
ubhat 0:6cc76d70e2a1 26 /*!
ubhat 0:6cc76d70e2a1 27 * Configure End-Device to use 64-channels across to Block A thru Block H
ubhat 0:6cc76d70e2a1 28 */
ubhat 0:6cc76d70e2a1 29 #define USE_BAND_915
ubhat 0:6cc76d70e2a1 30
ubhat 4:d49b89361b67 31 #else
ubhat 4:d49b89361b67 32
ubhat 4:d49b89361b67 33 #define USE_BAND_915_HYBRID_BLOCK_D
ubhat 4:d49b89361b67 34
ubhat 0:6cc76d70e2a1 35 #endif
ubhat 0:6cc76d70e2a1 36
ubhat 0:6cc76d70e2a1 37 /*!
ubhat 0:6cc76d70e2a1 38 * Join requests trials periodicity. It is the time between RX1/RX2 and next TX
ubhat 0:6cc76d70e2a1 39 */
ubhat 0:6cc76d70e2a1 40 #define OVER_THE_AIR_ACTIVATION_DUTYCYCLE 5000000 // value in us
ubhat 0:6cc76d70e2a1 41
ubhat 0:6cc76d70e2a1 42 /*!
ubhat 0:6cc76d70e2a1 43 * Defines the application data transmission periodicity. It is the time between RX1/RX2 and next TX
ubhat 0:6cc76d70e2a1 44 */
ubhat 4:d49b89361b67 45 #define APP_TX_DUTYCYCLE 6000000 // value in us
ubhat 4:d49b89361b67 46
ubhat 4:d49b89361b67 47 #define APP_TX_DUTYCYCLE_RND 3000000
ubhat 0:6cc76d70e2a1 48
ubhat 0:6cc76d70e2a1 49 /*!
ubhat 0:6cc76d70e2a1 50 * LoRaWAN confirmed messages
ubhat 0:6cc76d70e2a1 51 * \remark 1 : Confirmed messages enabled. Must receive ACK from network server
ubhat 0:6cc76d70e2a1 52 0 : Confirmed messages disabled.
ubhat 0:6cc76d70e2a1 53 */
ubhat 0:6cc76d70e2a1 54 #define LORAWAN_CONFIRMED_MSG_ON 1
ubhat 0:6cc76d70e2a1 55
ubhat 0:6cc76d70e2a1 56 /*!
ubhat 0:6cc76d70e2a1 57 * LoRaWAN Adaptive Data Rate
ubhat 0:6cc76d70e2a1 58 *
ubhat 0:6cc76d70e2a1 59 * \remark Please note that when ADR is enabled the end-device uses default datarate of DR_0
ubhat 0:6cc76d70e2a1 60 */
ubhat 0:6cc76d70e2a1 61 #define LORAWAN_ADR_ON 0
ubhat 0:6cc76d70e2a1 62
ubhat 0:6cc76d70e2a1 63 /*!
ubhat 0:6cc76d70e2a1 64 * Default mote datarate
ubhat 0:6cc76d70e2a1 65 * \remark DR_0 : 980 bps; DR_1 : 1760 bps; DR_2 : 3125 bps; DR_3 : 5470 bps; DR_4 : 12500 bps
ubhat 0:6cc76d70e2a1 66 */
ubhat 0:6cc76d70e2a1 67 #define LORAWAN_DEFAULT_DATARATE DR_0
ubhat 0:6cc76d70e2a1 68
ubhat 0:6cc76d70e2a1 69 /*!
ubhat 0:6cc76d70e2a1 70 * LoRaWAN application port
ubhat 0:6cc76d70e2a1 71 */
ubhat 2:19dd7bfcacf7 72 #define LORAWAN_APP_PORT 5
ubhat 0:6cc76d70e2a1 73
ubhat 0:6cc76d70e2a1 74 /*!
ubhat 0:6cc76d70e2a1 75 * LoRaWAN User defined Tx Power
ubhat 0:6cc76d70e2a1 76 *
ubhat 0:6cc76d70e2a1 77 * \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:6cc76d70e2a1 78 */
ubhat 2:19dd7bfcacf7 79 #define LORAWAN_TX_POWER TX_POWER_10_DBM
ubhat 0:6cc76d70e2a1 80
ubhat 0:6cc76d70e2a1 81 #if ( LORAWAN_APP_PORT == 5 )
ubhat 0:6cc76d70e2a1 82 /*====================================================
ubhat 0:6cc76d70e2a1 83 US01 GPS APPLICATION DEMO (PORT 5)
ubhat 0:6cc76d70e2a1 84 ====================================================*/
ubhat 0:6cc76d70e2a1 85
ubhat 0:6cc76d70e2a1 86 /*!
ubhat 0:6cc76d70e2a1 87 * User application data buffer size
ubhat 0:6cc76d70e2a1 88 */
ubhat 0:6cc76d70e2a1 89 #define LORAWAN_APP_DATA_SIZE 11
ubhat 0:6cc76d70e2a1 90
ubhat 0:6cc76d70e2a1 91 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:6cc76d70e2a1 92
ubhat 0:6cc76d70e2a1 93 #elif ( LORAWAN_APP_PORT == 8 )
ubhat 0:6cc76d70e2a1 94 /*====================================================
ubhat 0:6cc76d70e2a1 95 IKS01A1 SENSOR DATA (PORT 8)
ubhat 0:6cc76d70e2a1 96 ====================================================*/
ubhat 0:6cc76d70e2a1 97
ubhat 0:6cc76d70e2a1 98 #define USE_IKS01A1_SENSOR
ubhat 0:6cc76d70e2a1 99 /*!
ubhat 0:6cc76d70e2a1 100 * User application data buffer size
ubhat 0:6cc76d70e2a1 101 */
ubhat 0:6cc76d70e2a1 102 #define LORAWAN_APP_DATA_SIZE 11
ubhat 0:6cc76d70e2a1 103
ubhat 0:6cc76d70e2a1 104 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:6cc76d70e2a1 105
ubhat 0:6cc76d70e2a1 106 #elif ( LORAWAN_APP_PORT == 9 )
ubhat 0:6cc76d70e2a1 107 /*====================================================
ubhat 0:6cc76d70e2a1 108 IKS01A1 SENSOR DATA (PORT 9) + CAYENNE LPP
ubhat 0:6cc76d70e2a1 109 ====================================================*/
ubhat 0:6cc76d70e2a1 110
ubhat 0:6cc76d70e2a1 111 #define USE_IKS01A1_SENSOR
ubhat 0:6cc76d70e2a1 112
ubhat 0:6cc76d70e2a1 113 #define USE_CAYENNE_LPP
ubhat 0:6cc76d70e2a1 114 /*!
ubhat 0:6cc76d70e2a1 115 * User application data buffer size
ubhat 0:6cc76d70e2a1 116 */
ubhat 0:6cc76d70e2a1 117 #define LORAWAN_APP_DATA_SIZE 11
ubhat 0:6cc76d70e2a1 118
ubhat 0:6cc76d70e2a1 119 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:6cc76d70e2a1 120
ubhat 0:6cc76d70e2a1 121 #elif ( LORAWAN_APP_PORT == 11 )
ubhat 0:6cc76d70e2a1 122 /*====================================================
ubhat 0:6cc76d70e2a1 123 PUSH BUTTON DEMO (PORT 11)
ubhat 0:6cc76d70e2a1 124 ====================================================*/
ubhat 0:6cc76d70e2a1 125
ubhat 0:6cc76d70e2a1 126 /*!
ubhat 0:6cc76d70e2a1 127 * User application data buffer size
ubhat 0:6cc76d70e2a1 128 */
ubhat 0:6cc76d70e2a1 129 #define LORAWAN_APP_DATA_SIZE 2
ubhat 0:6cc76d70e2a1 130
ubhat 0:6cc76d70e2a1 131 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 0:6cc76d70e2a1 132
ubhat 2:19dd7bfcacf7 133 #elif ( LORAWAN_APP_PORT == 12 )
ubhat 2:19dd7bfcacf7 134 /*====================================================
ubhat 2:19dd7bfcacf7 135 GROVE SENSOR DEMO (PORT 11)
ubhat 2:19dd7bfcacf7 136 ====================================================*/
ubhat 2:19dd7bfcacf7 137
ubhat 2:19dd7bfcacf7 138 #define USE_GROVE_SENSOR
ubhat 2:19dd7bfcacf7 139
ubhat 2:19dd7bfcacf7 140 #define USE_CAYENNE_LPP
ubhat 2:19dd7bfcacf7 141
ubhat 2:19dd7bfcacf7 142 /*!
ubhat 2:19dd7bfcacf7 143 * User application data buffer size
ubhat 2:19dd7bfcacf7 144 */
ubhat 2:19dd7bfcacf7 145 #define LORAWAN_APP_DATA_SIZE 7
ubhat 2:19dd7bfcacf7 146
ubhat 2:19dd7bfcacf7 147 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 2:19dd7bfcacf7 148
ubhat 0:6cc76d70e2a1 149 #endif
ubhat 0:6cc76d70e2a1 150
ubhat 0:6cc76d70e2a1 151 #endif // __LORA_CONFIG_H__