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

Diff: app/Config.h

Revision:
0:6cc76d70e2a1
Child:
2:19dd7bfcacf7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/app/Config.h	Thu Apr 06 21:59:50 2017 +0000
@@ -0,0 +1,129 @@
+/*
+ / _____)             _              | |
+( (____  _____ ____ _| |_ _____  ____| |__
+ \____ \| ___ |    (_   _) ___ |/ ___)  _ \
+ _____) ) ____| | | || |_| ____( (___| | | |
+(______/|_____)_|_|_| \__)_____)\____)_| |_|
+    (C)2015 Semtech
+
+Description: End device communication parameters
+
+License: Revised BSD License, see LICENSE.TXT file include in the project
+
+Maintainer: Uttam Bhat
+*/
+
+#ifndef __LORA_CONFIG_H__
+#define __LORA_CONFIG_H__
+
+/*!
+ * Configure End-Device to use 8-channels corresponding to Block A
+ * Comment/Uncomment to disable/enable Hybrid mode
+ */
+#define USE_BAND_915_HYBRID
+
+#ifndef USE_BAND_915_HYBRID
+/*!
+ * Configure End-Device to use 64-channels across to Block A thru Block H
+ */
+#define USE_BAND_915
+
+#endif
+
+/*!
+ * Join requests trials periodicity. It is the time between RX1/RX2 and next TX
+ */
+#define OVER_THE_AIR_ACTIVATION_DUTYCYCLE           5000000  // value in us
+
+/*!
+ * Defines the application data transmission periodicity. It is the time between RX1/RX2 and next TX
+ */
+#define APP_TX_DUTYCYCLE                            5000000  // value in us
+
+/*!
+ * LoRaWAN confirmed messages
+ * \remark 1 : Confirmed messages enabled. Must receive ACK from network server
+           0 : Confirmed messages disabled. 
+ */
+#define LORAWAN_CONFIRMED_MSG_ON                    1
+
+/*!
+ * LoRaWAN Adaptive Data Rate
+ *
+ * \remark Please note that when ADR is enabled the end-device uses default datarate of DR_0
+ */
+#define LORAWAN_ADR_ON                              0
+
+/*!
+ * Default mote datarate
+ * \remark DR_0 : 980 bps; DR_1 : 1760 bps; DR_2 : 3125 bps; DR_3 : 5470 bps; DR_4 : 12500 bps
+ */
+#define LORAWAN_DEFAULT_DATARATE                    DR_0
+
+/*!
+ * LoRaWAN application port
+ */
+#define LORAWAN_APP_PORT                            9
+
+/*!
+ * LoRaWAN User defined Tx Power
+ *
+ * \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 }
+ */
+#define LORAWAN_TX_POWER                            TX_POWER_20_DBM
+
+#if ( LORAWAN_APP_PORT == 5 )
+/*====================================================
+            US01 GPS APPLICATION DEMO (PORT 5)
+====================================================*/
+
+/*!
+ * User application data buffer size
+ */
+#define LORAWAN_APP_DATA_SIZE                       11
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#elif ( LORAWAN_APP_PORT == 8 )
+/*====================================================
+                IKS01A1 SENSOR DATA (PORT 8)
+====================================================*/
+
+#define USE_IKS01A1_SENSOR
+/*!
+ * User application data buffer size
+ */
+#define LORAWAN_APP_DATA_SIZE                       11
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#elif ( LORAWAN_APP_PORT == 9 )
+/*====================================================
+    IKS01A1 SENSOR DATA (PORT 9) + CAYENNE LPP
+====================================================*/
+
+#define USE_IKS01A1_SENSOR
+
+#define USE_CAYENNE_LPP
+/*!
+ * User application data buffer size
+ */
+#define LORAWAN_APP_DATA_SIZE                       11
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#elif ( LORAWAN_APP_PORT == 11 )
+/*====================================================
+                PUSH BUTTON DEMO (PORT 11)
+====================================================*/
+
+/*!
+ * User application data buffer size
+ */
+#define LORAWAN_APP_DATA_SIZE                       2
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#endif
+
+#endif //  __LORA_CONFIG_H__