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

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
Child:
6:c5f2da0de0b0
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: Process function calls from various Device states
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 #include "LoRaDeviceStateProc.h"
ubhat 0:42863a11464a 17 #include "LoRaMacLayerService.h"
ubhat 0:42863a11464a 18
ubhat 0:42863a11464a 19 eDevicState DeviceState;
ubhat 0:42863a11464a 20
ubhat 0:42863a11464a 21 sLoRaMacUplinkStatus LoRaMacUplinkStatus;
ubhat 0:42863a11464a 22
ubhat 0:42863a11464a 23 sLoRaMacDownlinkStatus LoRaMacDownlinkStatus;
ubhat 0:42863a11464a 24
ubhat 0:42863a11464a 25 LoRaMacPrimitives_t LoRaPrimitives;
ubhat 0:42863a11464a 26
ubhat 0:42863a11464a 27 LoRaMacCallback_t LoRaCallbacks;
ubhat 0:42863a11464a 28
ubhat 0:42863a11464a 29 MibRequestConfirm_t LoRaMibReq;
ubhat 0:42863a11464a 30
ubhat 0:42863a11464a 31 MlmeReq_t mlmeReq;
ubhat 0:42863a11464a 32
ubhat 0:42863a11464a 33
ubhat 0:42863a11464a 34 /*!
ubhat 0:42863a11464a 35 * \brief Function executed on TxNextPacket Timeout event
ubhat 0:42863a11464a 36 */
ubhat 0:42863a11464a 37 static void OnTxNextPacketTimerEvent( void )
ubhat 0:42863a11464a 38 {
ubhat 0:42863a11464a 39 MibRequestConfirm_t mibReq;
ubhat 0:42863a11464a 40 LoRaMacStatus_t status;
ubhat 0:42863a11464a 41
ubhat 0:42863a11464a 42 TimerStop( &TxNextPacketTimer );
ubhat 0:42863a11464a 43
ubhat 0:42863a11464a 44 mibReq.Type = MIB_NETWORK_JOINED;
ubhat 0:42863a11464a 45 status = LoRaMacMibGetRequestConfirm( &mibReq );
ubhat 0:42863a11464a 46
ubhat 0:42863a11464a 47 if( status == LORAMAC_STATUS_OK )
ubhat 0:42863a11464a 48 {
ubhat 0:42863a11464a 49 if( mibReq.Param.IsNetworkJoined == true )
ubhat 0:42863a11464a 50 {
ubhat 0:42863a11464a 51 DeviceState = DEVICE_STATE_SEND;
ubhat 0:42863a11464a 52 }
ubhat 0:42863a11464a 53 else
ubhat 0:42863a11464a 54 {
ubhat 0:42863a11464a 55 DeviceState = DEVICE_STATE_JOIN;
ubhat 0:42863a11464a 56 }
ubhat 0:42863a11464a 57 NextTx = true;
ubhat 0:42863a11464a 58 }
ubhat 0:42863a11464a 59 }
ubhat 0:42863a11464a 60
ubhat 0:42863a11464a 61 void DeviceInit( void )
ubhat 0:42863a11464a 62 {
ubhat 0:42863a11464a 63 LoRaPrimitives.MacMcpsConfirm = McpsConfirm;
ubhat 0:42863a11464a 64 LoRaPrimitives.MacMcpsIndication = McpsIndication;
ubhat 0:42863a11464a 65 LoRaPrimitives.MacMlmeConfirm = MlmeConfirm;
ubhat 0:42863a11464a 66 LoRaCallbacks.GetBatteryLevel = BoardGetBatteryLevel;
ubhat 0:42863a11464a 67 LoRaMacInitialization( &LoRaPrimitives, &LoRaCallbacks );
ubhat 0:42863a11464a 68
ubhat 0:42863a11464a 69 TimerInit( &TxNextPacketTimer, OnTxNextPacketTimerEvent );
ubhat 0:42863a11464a 70
ubhat 0:42863a11464a 71 LoRaMibReq.Type = MIB_ADR;
ubhat 0:42863a11464a 72 LoRaMibReq.Param.AdrEnable = LORAWAN_ADR_ON;
ubhat 0:42863a11464a 73 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 74
ubhat 0:42863a11464a 75 LoRaMibReq.Type = MIB_PUBLIC_NETWORK;
ubhat 0:42863a11464a 76 LoRaMibReq.Param.EnablePublicNetwork = LORAWAN_PUBLIC_NETWORK;
ubhat 0:42863a11464a 77 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 78
ubhat 0:42863a11464a 79 LoRaMibReq.Type = MIB_CHANNELS_TX_POWER;
ubhat 0:42863a11464a 80 LoRaMibReq.Param.ChannelsTxPower = LORAWAN_TX_POWER;
ubhat 0:42863a11464a 81 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 82
ubhat 0:42863a11464a 83 LoRaMacDownlinkStatus.DownlinkCounter = 0;
ubhat 0:42863a11464a 84 }
ubhat 0:42863a11464a 85
ubhat 0:42863a11464a 86 void DeviceJoinUpdate( void )
ubhat 0:42863a11464a 87 {
ubhat 0:42863a11464a 88 LoRaMibReq.Type = MIB_NETWORK_JOINED;
ubhat 0:42863a11464a 89 LoRaMacMibGetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 90 }
ubhat 0:42863a11464a 91
ubhat 0:42863a11464a 92 void DeviceJoin( void )
ubhat 0:42863a11464a 93 {
ubhat 0:42863a11464a 94 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:42863a11464a 95
ubhat 0:42863a11464a 96 mlmeReq.Type = MLME_JOIN;
ubhat 0:42863a11464a 97
ubhat 0:42863a11464a 98 mlmeReq.Req.Join.DevEui = DevEui;
ubhat 0:42863a11464a 99 mlmeReq.Req.Join.AppEui = AppEui;
ubhat 0:42863a11464a 100 mlmeReq.Req.Join.AppKey = AppKey;
ubhat 0:42863a11464a 101
ubhat 0:42863a11464a 102 if( NextTx == true )
ubhat 0:42863a11464a 103 {
ubhat 0:42863a11464a 104 LoRaMacMlmeRequest( &mlmeReq );
ubhat 0:42863a11464a 105 }
ubhat 0:42863a11464a 106
ubhat 0:42863a11464a 107 #else
ubhat 0:42863a11464a 108 // Choose a random device address if not already defined in Config.h
ubhat 0:42863a11464a 109 if( DevAddr == 0 )
ubhat 0:42863a11464a 110 {
ubhat 0:42863a11464a 111 // Random seed initialization
ubhat 0:42863a11464a 112 srand1( BoardGetRandomSeed( ) );
ubhat 0:42863a11464a 113 DevAddr = randr( 0, 0x01FFFFFF );
ubhat 0:42863a11464a 114 }
ubhat 0:42863a11464a 115
ubhat 0:42863a11464a 116 LoRaMibReq.Type = MIB_NET_ID;
ubhat 0:42863a11464a 117 LoRaMibReq.Param.NetID = LORAWAN_NETWORK_ID;
ubhat 0:42863a11464a 118 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 119
ubhat 0:42863a11464a 120 LoRaMibReq.Type = MIB_DEV_ADDR;
ubhat 0:42863a11464a 121 LoRaMibReq.Param.DevAddr = DevAddr;
ubhat 0:42863a11464a 122 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 123
ubhat 0:42863a11464a 124 LoRaMibReq.Type = MIB_NWK_SKEY;
ubhat 0:42863a11464a 125 LoRaMibReq.Param.NwkSKey = NwkSKey;
ubhat 0:42863a11464a 126 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 127
ubhat 0:42863a11464a 128 LoRaMibReq.Type = MIB_APP_SKEY;
ubhat 0:42863a11464a 129 LoRaMibReq.Param.AppSKey = AppSKey;
ubhat 0:42863a11464a 130 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 131
ubhat 0:42863a11464a 132 LoRaMibReq.Type = MIB_NETWORK_JOINED;
ubhat 0:42863a11464a 133 LoRaMibReq.Param.IsNetworkJoined = true;
ubhat 0:42863a11464a 134 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:42863a11464a 135
ubhat 0:42863a11464a 136 #endif
ubhat 0:42863a11464a 137 }
ubhat 0:42863a11464a 138
ubhat 0:42863a11464a 139 /*!
ubhat 0:42863a11464a 140 * \brief Prepares the payload of the frame
ubhat 0:42863a11464a 141 */
ubhat 0:42863a11464a 142 void PrepareTxFrame( uint8_t port )
ubhat 0:42863a11464a 143 {
ubhat 0:42863a11464a 144 MibRequestConfirm_t mibReq;
ubhat 0:42863a11464a 145
ubhat 0:42863a11464a 146 if( BoardGetBatteryLevel( ) < LOW_BAT_THRESHOLD )
ubhat 0:42863a11464a 147 {
ubhat 0:42863a11464a 148 mibReq.Type = MIB_CHANNELS_TX_POWER;
ubhat 0:42863a11464a 149 LoRaMacMibGetRequestConfirm( &mibReq );
ubhat 0:42863a11464a 150 // TX_POWER_30_DBM = 0, TX_POWER_28_DBM = 1, ..., TX_POWER_20_DBM = 5, ..., TX_POWER_10_DBM = 10
ubhat 0:42863a11464a 151 // The if condition is then "less than" to check if the power is greater than 20 dBm
ubhat 0:42863a11464a 152 if( mibReq.Param.ChannelsTxPower < TX_POWER_20_DBM )
ubhat 0:42863a11464a 153 {
ubhat 0:42863a11464a 154 mibReq.Param.ChannelsTxPower = TX_POWER_20_DBM;
ubhat 0:42863a11464a 155 LoRaMacMibSetRequestConfirm( &mibReq );
ubhat 0:42863a11464a 156 }
ubhat 0:42863a11464a 157 }
ubhat 0:42863a11464a 158
ubhat 0:42863a11464a 159 if( port == 224 )
ubhat 0:42863a11464a 160 {
ubhat 0:42863a11464a 161 RunComplianceTest( );
ubhat 0:42863a11464a 162 }
ubhat 0:42863a11464a 163 else
ubhat 0:42863a11464a 164 {
ubhat 0:42863a11464a 165 PrepareLoRaFrame( port );
ubhat 0:42863a11464a 166 }
ubhat 0:42863a11464a 167 }
ubhat 0:42863a11464a 168
ubhat 0:42863a11464a 169 /*!
ubhat 0:42863a11464a 170 * \brief Prepares the payload of the frame
ubhat 0:42863a11464a 171 *
ubhat 0:42863a11464a 172 * \retval [0: frame could be send, 1: error]
ubhat 0:42863a11464a 173 */
ubhat 0:42863a11464a 174 bool SendFrame( void )
ubhat 0:42863a11464a 175 {
ubhat 0:42863a11464a 176 McpsReq_t mcpsReq;
ubhat 0:42863a11464a 177 LoRaMacTxInfo_t txInfo;
ubhat 0:42863a11464a 178
ubhat 0:42863a11464a 179 if( LoRaMacQueryTxPossible( AppDataSize, &txInfo ) != LORAMAC_STATUS_OK )
ubhat 0:42863a11464a 180 {
ubhat 0:42863a11464a 181 // Send empty frame in order to flush MAC commands
ubhat 0:42863a11464a 182 mcpsReq.Type = MCPS_UNCONFIRMED;
ubhat 0:42863a11464a 183 mcpsReq.Req.Unconfirmed.fBuffer = NULL;
ubhat 0:42863a11464a 184 mcpsReq.Req.Unconfirmed.fBufferSize = 0;
ubhat 0:42863a11464a 185 mcpsReq.Req.Unconfirmed.Datarate = LORAWAN_DEFAULT_DATARATE;
ubhat 0:42863a11464a 186
ubhat 0:42863a11464a 187 LoRaMacUplinkStatus.Acked = false;
ubhat 0:42863a11464a 188 LoRaMacUplinkStatus.Port = 0;
ubhat 0:42863a11464a 189 LoRaMacUplinkStatus.Buffer = NULL;
ubhat 0:42863a11464a 190 LoRaMacUplinkStatus.BufferSize = 0;
ubhat 0:42863a11464a 191 }
ubhat 0:42863a11464a 192 else
ubhat 0:42863a11464a 193 {
ubhat 0:42863a11464a 194 LoRaMacUplinkStatus.Acked = false;
ubhat 0:42863a11464a 195 LoRaMacUplinkStatus.Port = AppPort;
ubhat 0:42863a11464a 196 LoRaMacUplinkStatus.Buffer = AppData;
ubhat 0:42863a11464a 197 LoRaMacUplinkStatus.BufferSize = AppDataSize;
ubhat 0:42863a11464a 198
ubhat 0:42863a11464a 199 if( ( IsTxConfirmed == false ) || ( LoRaMacUplinkStatus.UplinkCounter == 0 ) )
ubhat 0:42863a11464a 200 {
ubhat 0:42863a11464a 201 mcpsReq.Type = MCPS_UNCONFIRMED;
ubhat 0:42863a11464a 202 mcpsReq.Req.Unconfirmed.fPort = AppPort;
ubhat 0:42863a11464a 203 mcpsReq.Req.Unconfirmed.fBuffer = AppData;
ubhat 0:42863a11464a 204 mcpsReq.Req.Unconfirmed.fBufferSize = AppDataSize;
ubhat 0:42863a11464a 205 mcpsReq.Req.Unconfirmed.Datarate = LORAWAN_DEFAULT_DATARATE;
ubhat 0:42863a11464a 206 }
ubhat 0:42863a11464a 207 else
ubhat 0:42863a11464a 208 {
ubhat 0:42863a11464a 209 mcpsReq.Type = MCPS_CONFIRMED;
ubhat 0:42863a11464a 210 mcpsReq.Req.Confirmed.fPort = AppPort;
ubhat 0:42863a11464a 211 mcpsReq.Req.Confirmed.fBuffer = AppData;
ubhat 0:42863a11464a 212 mcpsReq.Req.Confirmed.fBufferSize = AppDataSize;
ubhat 0:42863a11464a 213 mcpsReq.Req.Confirmed.NbTrials = 8;
ubhat 0:42863a11464a 214 mcpsReq.Req.Confirmed.Datarate = LORAWAN_DEFAULT_DATARATE;
ubhat 0:42863a11464a 215 }
ubhat 0:42863a11464a 216 }
ubhat 0:42863a11464a 217
ubhat 0:42863a11464a 218 LoRaMacUplinkStatus.Type = mcpsReq.Type;
ubhat 0:42863a11464a 219
ubhat 0:42863a11464a 220 if( LoRaMacMcpsRequest( &mcpsReq ) == LORAMAC_STATUS_OK )
ubhat 0:42863a11464a 221 {
ubhat 0:42863a11464a 222 return false;
ubhat 0:42863a11464a 223 }
ubhat 0:42863a11464a 224 return true;
ubhat 0:42863a11464a 225 }