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/main.cpp@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
Child:
1:80c1daf19aa4
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: LoRaMac classA device implementation
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: Miguel Luis and Gregory Cristian
ubhat 0:42863a11464a 14 */
ubhat 0:42863a11464a 15 #include "mbed.h"
ubhat 0:42863a11464a 16 #include "board.h"
ubhat 0:42863a11464a 17 #include "radio.h"
ubhat 0:42863a11464a 18
ubhat 0:42863a11464a 19 #include "LoRaMac.h"
ubhat 0:42863a11464a 20 #include "Comissioning.h"
ubhat 0:42863a11464a 21 #include "SerialDisplay.h"
ubhat 0:42863a11464a 22 #include "ComplianceTest.h"
ubhat 0:42863a11464a 23 #include "LoRaDeviceStateProc.h"
ubhat 0:42863a11464a 24 #include "LoRaEventProc.h"
ubhat 0:42863a11464a 25 #include "LoRaApp.h"
ubhat 0:42863a11464a 26
ubhat 0:42863a11464a 27 /*!
ubhat 0:42863a11464a 28 * Defines a random delay for application data transmission duty cycle. 1s,
ubhat 0:42863a11464a 29 * value in [us].
ubhat 0:42863a11464a 30 */
ubhat 0:42863a11464a 31
ubhat 0:42863a11464a 32
ubhat 0:42863a11464a 33 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:42863a11464a 34
ubhat 0:42863a11464a 35 uint8_t DevEui[] = LORAWAN_DEVICE_EUI;
ubhat 0:42863a11464a 36 uint8_t AppEui[] = LORAWAN_APPLICATION_EUI;
ubhat 0:42863a11464a 37 uint8_t AppKey[] = LORAWAN_APPLICATION_KEY;
ubhat 0:42863a11464a 38
ubhat 0:42863a11464a 39 #else
ubhat 0:42863a11464a 40
ubhat 0:42863a11464a 41 uint8_t NwkSKey[] = LORAWAN_NWKSKEY;
ubhat 0:42863a11464a 42 uint8_t AppSKey[] = LORAWAN_APPSKEY;
ubhat 0:42863a11464a 43
ubhat 0:42863a11464a 44 /*!
ubhat 0:42863a11464a 45 * Device address
ubhat 0:42863a11464a 46 */
ubhat 0:42863a11464a 47 uint32_t DevAddr = LORAWAN_DEVICE_ADDRESS;
ubhat 0:42863a11464a 48
ubhat 0:42863a11464a 49 #endif
ubhat 0:42863a11464a 50
ubhat 0:42863a11464a 51 /*!
ubhat 0:42863a11464a 52 * Application port
ubhat 0:42863a11464a 53 */
ubhat 0:42863a11464a 54 uint8_t AppPort = LORAWAN_APP_PORT;
ubhat 0:42863a11464a 55
ubhat 0:42863a11464a 56 /*!
ubhat 0:42863a11464a 57 * User application data size
ubhat 0:42863a11464a 58 */
ubhat 0:42863a11464a 59 uint8_t AppDataSize = LORAWAN_APP_DATA_SIZE;
ubhat 0:42863a11464a 60
ubhat 0:42863a11464a 61 /*!
ubhat 0:42863a11464a 62 * User application data
ubhat 0:42863a11464a 63 */
ubhat 0:42863a11464a 64 uint8_t AppData[LORAWAN_APP_DATA_MAX_SIZE];
ubhat 0:42863a11464a 65
ubhat 0:42863a11464a 66 /*!
ubhat 0:42863a11464a 67 * Application to handle functions
ubhat 0:42863a11464a 68 */
ubhat 0:42863a11464a 69 Application LoRaApp( AppData );
ubhat 0:42863a11464a 70
ubhat 0:42863a11464a 71 /*!
ubhat 0:42863a11464a 72 * Indicates if the node is sending confirmed or unconfirmed messages
ubhat 0:42863a11464a 73 */
ubhat 0:42863a11464a 74 uint8_t IsTxConfirmed = LORAWAN_CONFIRMED_MSG_ON;
ubhat 0:42863a11464a 75
ubhat 0:42863a11464a 76 /*!
ubhat 0:42863a11464a 77 * Timer to handle the application data transmission duty cycle
ubhat 0:42863a11464a 78 */
ubhat 0:42863a11464a 79 TimerEvent_t TxNextPacketTimer;
ubhat 0:42863a11464a 80
ubhat 0:42863a11464a 81 /*!
ubhat 0:42863a11464a 82 * Indicates if a new transmit interrupt can be set
ubhat 0:42863a11464a 83 */
ubhat 0:42863a11464a 84 bool IsTxIntUpdate = false;
ubhat 0:42863a11464a 85
ubhat 0:42863a11464a 86 /*!
ubhat 0:42863a11464a 87 * Indicates if a new packet can be sent
ubhat 0:42863a11464a 88 */
ubhat 0:42863a11464a 89 bool NextTx = true;
ubhat 0:42863a11464a 90
ubhat 0:42863a11464a 91 /*!
ubhat 0:42863a11464a 92 * LoRaWAN compliance tests support data
ubhat 0:42863a11464a 93 */
ubhat 0:42863a11464a 94 ComplianceTest_s ComplianceTest;
ubhat 0:42863a11464a 95
ubhat 0:42863a11464a 96 /*!
ubhat 0:42863a11464a 97 * Indicates if the MAC layer network join status has changed.
ubhat 0:42863a11464a 98 */
ubhat 0:42863a11464a 99 bool IsNetworkJoinedStatusUpdate = false;
ubhat 0:42863a11464a 100
ubhat 0:42863a11464a 101 /*!
ubhat 0:42863a11464a 102 * Indicates if the message sent.
ubhat 0:42863a11464a 103 */
ubhat 0:42863a11464a 104 bool IsTxUpdate = false;
ubhat 0:42863a11464a 105
ubhat 0:42863a11464a 106 /*!
ubhat 0:42863a11464a 107 * Indicates if the message received in the RX window.
ubhat 0:42863a11464a 108 */
ubhat 0:42863a11464a 109 bool IsRxUpdate = false;
ubhat 0:42863a11464a 110
ubhat 0:42863a11464a 111
ubhat 0:42863a11464a 112 /**
ubhat 0:42863a11464a 113 * Main application entry point.
ubhat 0:42863a11464a 114 */
ubhat 0:42863a11464a 115 int main( void )
ubhat 0:42863a11464a 116 {
ubhat 0:42863a11464a 117
ubhat 0:42863a11464a 118 // Initialize board peripherals
ubhat 0:42863a11464a 119 BoardInit( );
ubhat 0:42863a11464a 120
ubhat 0:42863a11464a 121 // Initialize Device state
ubhat 0:42863a11464a 122 DeviceState = DEVICE_STATE_INIT;
ubhat 0:42863a11464a 123
ubhat 0:42863a11464a 124 while( 1 )
ubhat 0:42863a11464a 125 {
ubhat 0:42863a11464a 126 if( IsNetworkJoinedStatusUpdate == true )
ubhat 0:42863a11464a 127 {
ubhat 0:42863a11464a 128 IsNetworkJoinedStatusUpdate = false;
ubhat 0:42863a11464a 129
ubhat 0:42863a11464a 130 DeviceJoinUpdate( );
ubhat 0:42863a11464a 131 }
ubhat 0:42863a11464a 132
ubhat 0:42863a11464a 133 if( IsTxUpdate == true )
ubhat 0:42863a11464a 134 {
ubhat 0:42863a11464a 135 // If downlink received then update Serial Terminal and execute Rx event
ubhat 0:42863a11464a 136 IsTxUpdate = false;
ubhat 0:42863a11464a 137
ubhat 0:42863a11464a 138 // Update serial terminal
ubhat 0:42863a11464a 139 SerialDisplayTxUpdate( );
ubhat 0:42863a11464a 140 }
ubhat 0:42863a11464a 141
ubhat 0:42863a11464a 142 if( IsTxIntUpdate == true )
ubhat 0:42863a11464a 143 {
ubhat 0:42863a11464a 144 IsTxIntUpdate = false;
ubhat 0:42863a11464a 145
ubhat 0:42863a11464a 146 // Initialize next Tx Interrupt
ubhat 0:42863a11464a 147 InitNextTxInterrupt( AppPort );
ubhat 0:42863a11464a 148 }
ubhat 0:42863a11464a 149
ubhat 0:42863a11464a 150 if( IsRxUpdate == true )
ubhat 0:42863a11464a 151 {
ubhat 0:42863a11464a 152 // If downlink received then update Serial Terminal and execute Rx event
ubhat 0:42863a11464a 153 IsRxUpdate = false;
ubhat 0:42863a11464a 154 RxEvent( );
ubhat 0:42863a11464a 155 SerialDisplayRxUpdate( );
ubhat 0:42863a11464a 156 }
ubhat 0:42863a11464a 157
ubhat 0:42863a11464a 158 switch( DeviceState )
ubhat 0:42863a11464a 159 {
ubhat 0:42863a11464a 160 case DEVICE_STATE_INIT:
ubhat 0:42863a11464a 161 {
ubhat 0:42863a11464a 162 // Initialize MAC, MAC services, Primitives
ubhat 0:42863a11464a 163 DeviceInit( );
ubhat 0:42863a11464a 164
ubhat 0:42863a11464a 165 // Change Device state
ubhat 0:42863a11464a 166 DeviceState = DEVICE_STATE_JOIN;
ubhat 0:42863a11464a 167 break;
ubhat 0:42863a11464a 168 }
ubhat 0:42863a11464a 169 case DEVICE_STATE_JOIN:
ubhat 0:42863a11464a 170 {
ubhat 0:42863a11464a 171 #if( OVER_THE_AIR_ACTIVATION != 0 ) // OTA
ubhat 0:42863a11464a 172
ubhat 0:42863a11464a 173 // Generate DevEUI if not defined by User
ubhat 0:42863a11464a 174 BoardGetDevEUI( DevEui );
ubhat 0:42863a11464a 175
ubhat 0:42863a11464a 176 // Join N/w server
ubhat 0:42863a11464a 177 DeviceJoin( );
ubhat 0:42863a11464a 178
ubhat 0:42863a11464a 179 // Show on serial terminal
ubhat 0:42863a11464a 180 SerialDisplayJoinUpdate( );
ubhat 0:42863a11464a 181
ubhat 0:42863a11464a 182 // Execute Join event
ubhat 0:42863a11464a 183 JoinEvent( );
ubhat 0:42863a11464a 184
ubhat 0:42863a11464a 185 DeviceState = DEVICE_STATE_SLEEP;
ubhat 0:42863a11464a 186
ubhat 0:42863a11464a 187 #else // ABP
ubhat 0:42863a11464a 188 DeviceJoin( );
ubhat 0:42863a11464a 189
ubhat 0:42863a11464a 190 DeviceState = DEVICE_STATE_SEND;
ubhat 0:42863a11464a 191 #endif
ubhat 0:42863a11464a 192 IsNetworkJoinedStatusUpdate = true;
ubhat 0:42863a11464a 193 break;
ubhat 0:42863a11464a 194 }
ubhat 0:42863a11464a 195 case DEVICE_STATE_SEND:
ubhat 0:42863a11464a 196 {
ubhat 0:42863a11464a 197 if( NextTx == true )
ubhat 0:42863a11464a 198 {
ubhat 0:42863a11464a 199 // Prepare payload frame based on application port
ubhat 0:42863a11464a 200 PrepareTxFrame( AppPort );
ubhat 0:42863a11464a 201
ubhat 0:42863a11464a 202 // Send payload over the air
ubhat 0:42863a11464a 203 NextTx = SendFrame( );
ubhat 0:42863a11464a 204
ubhat 0:42863a11464a 205 // Execute transmit event
ubhat 0:42863a11464a 206 TxEvent( );
ubhat 0:42863a11464a 207 }
ubhat 0:42863a11464a 208
ubhat 0:42863a11464a 209 if( NextTx == false )
ubhat 0:42863a11464a 210 {
ubhat 0:42863a11464a 211 IsTxUpdate = true;
ubhat 0:42863a11464a 212 }
ubhat 0:42863a11464a 213
ubhat 0:42863a11464a 214 DeviceState = DEVICE_STATE_SLEEP;
ubhat 0:42863a11464a 215 break;
ubhat 0:42863a11464a 216 }
ubhat 0:42863a11464a 217 case DEVICE_STATE_SLEEP:
ubhat 0:42863a11464a 218 {
ubhat 0:42863a11464a 219 // Wake up through events
ubhat 0:42863a11464a 220 break;
ubhat 0:42863a11464a 221 }
ubhat 0:42863a11464a 222 default:
ubhat 0:42863a11464a 223 {
ubhat 0:42863a11464a 224 DeviceState = DEVICE_STATE_INIT;
ubhat 0:42863a11464a 225 break;
ubhat 0:42863a11464a 226 }
ubhat 0:42863a11464a 227 }
ubhat 0:42863a11464a 228 }
ubhat 0:42863a11464a 229 }