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/LoRaMacLayerService.cpp@6:c5f2da0de0b0, 2018-07-18 (annotated)

Committer:
ubhat
Date:
Wed Jul 18 22:26:26 2018 +0000
Revision:
6:c5f2da0de0b0
Parent:
0:42863a11464a 
Add Channel Block option in Config.h; Fix board specific DevEUI allocation

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: MAC Layer Services: MLME & MCPS
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 "LoRaMacLayerService.h"
ubhat 0:42863a11464a 17
ubhat 0:42863a11464a 18 /*!
ubhat 0:42863a11464a 19 * \brief MCPS-Confirm event function
ubhat 0:42863a11464a 20 *
ubhat 0:42863a11464a 21 * \param [IN] McpsConfirm - Pointer to the confirm structure,
ubhat 0:42863a11464a 22 * containing confirm attributes.
ubhat 0:42863a11464a 23 */
ubhat 0:42863a11464a 24 void McpsConfirm( McpsConfirm_t *McpsConfirm )
ubhat 0:42863a11464a 25 {
ubhat 0:42863a11464a 26 if( McpsConfirm->Status == LORAMAC_EVENT_INFO_STATUS_OK )
ubhat 0:42863a11464a 27 {
ubhat 0:42863a11464a 28 switch( McpsConfirm->McpsRequest )
ubhat 0:42863a11464a 29 {
ubhat 0:42863a11464a 30 case MCPS_UNCONFIRMED:
ubhat 0:42863a11464a 31 {
ubhat 0:42863a11464a 32 // Check Datarate
ubhat 0:42863a11464a 33 // Check TxPower
ubhat 0:42863a11464a 34 break;
ubhat 0:42863a11464a 35 }
ubhat 0:42863a11464a 36 case MCPS_CONFIRMED:
ubhat 0:42863a11464a 37 {
ubhat 0:42863a11464a 38 // Check Datarate
ubhat 0:42863a11464a 39 // Check TxPower
ubhat 0:42863a11464a 40 // Check AckReceived
ubhat 0:42863a11464a 41 // Check NbRetries
ubhat 0:42863a11464a 42 LoRaMacUplinkStatus.Acked = McpsConfirm->AckReceived;
ubhat 0:42863a11464a 43 break;
ubhat 0:42863a11464a 44 }
ubhat 0:42863a11464a 45 case MCPS_PROPRIETARY:
ubhat 0:42863a11464a 46 {
ubhat 0:42863a11464a 47 break;
ubhat 0:42863a11464a 48 }
ubhat 0:42863a11464a 49 default:
ubhat 0:42863a11464a 50 break;
ubhat 0:42863a11464a 51 }
ubhat 0:42863a11464a 52 }
ubhat 0:42863a11464a 53
ubhat 0:42863a11464a 54 LoRaMacUplinkStatus.Datarate = McpsConfirm->Datarate;
ubhat 0:42863a11464a 55 LoRaMacUplinkStatus.UplinkCounter = McpsConfirm->UpLinkCounter;
ubhat 0:42863a11464a 56 LoRaMacUplinkStatus.TxPower = McpsConfirm->TxPower;
ubhat 0:42863a11464a 57
ubhat 0:42863a11464a 58 IsTxIntUpdate = true;
ubhat 0:42863a11464a 59 }
ubhat 0:42863a11464a 60
ubhat 0:42863a11464a 61 /*!
ubhat 0:42863a11464a 62 * \brief MCPS-Indication event function
ubhat 0:42863a11464a 63 *
ubhat 0:42863a11464a 64 * \param [IN] McpsIndication - Pointer to the indication structure,
ubhat 0:42863a11464a 65 * containing indication attributes.
ubhat 0:42863a11464a 66 */
ubhat 0:42863a11464a 67 void McpsIndication( McpsIndication_t *McpsIndication )
ubhat 0:42863a11464a 68 {
ubhat 0:42863a11464a 69 uint8_t port;
ubhat 0:42863a11464a 70
ubhat 0:42863a11464a 71 if( McpsIndication->Status != LORAMAC_EVENT_INFO_STATUS_OK )
ubhat 0:42863a11464a 72 {
ubhat 0:42863a11464a 73 return;
ubhat 0:42863a11464a 74 }
ubhat 0:42863a11464a 75
ubhat 0:42863a11464a 76 switch( McpsIndication->McpsIndication )
ubhat 0:42863a11464a 77 {
ubhat 0:42863a11464a 78 case MCPS_UNCONFIRMED:
ubhat 0:42863a11464a 79 {
ubhat 0:42863a11464a 80 break;
ubhat 0:42863a11464a 81 }
ubhat 0:42863a11464a 82 case MCPS_CONFIRMED:
ubhat 0:42863a11464a 83 {
ubhat 0:42863a11464a 84 break;
ubhat 0:42863a11464a 85 }
ubhat 0:42863a11464a 86 case MCPS_PROPRIETARY:
ubhat 0:42863a11464a 87 {
ubhat 0:42863a11464a 88 break;
ubhat 0:42863a11464a 89 }
ubhat 0:42863a11464a 90 case MCPS_MULTICAST:
ubhat 0:42863a11464a 91 {
ubhat 0:42863a11464a 92 break;
ubhat 0:42863a11464a 93 }
ubhat 0:42863a11464a 94 default:
ubhat 0:42863a11464a 95 break;
ubhat 0:42863a11464a 96 }
ubhat 0:42863a11464a 97
ubhat 0:42863a11464a 98 // Check Multicast
ubhat 0:42863a11464a 99 // Check Port
ubhat 0:42863a11464a 100 // Check Datarate
ubhat 0:42863a11464a 101 // Check FramePending
ubhat 0:42863a11464a 102 // Check Buffer
ubhat 0:42863a11464a 103 // Check BufferSize
ubhat 0:42863a11464a 104 // Check Rssi
ubhat 0:42863a11464a 105 // Check Snr
ubhat 0:42863a11464a 106 // Check RxSlot
ubhat 0:42863a11464a 107 LoRaMacDownlinkStatus.Rssi = McpsIndication->Rssi;
ubhat 0:42863a11464a 108 if( McpsIndication->Snr & 0x80 ) // The SNR sign bit is 1
ubhat 0:42863a11464a 109 {
ubhat 0:42863a11464a 110 // Invert and divide by 4
ubhat 0:42863a11464a 111 LoRaMacDownlinkStatus.Snr = ( ( ~McpsIndication->Snr + 1 ) & 0xFF ) >> 2;
ubhat 0:42863a11464a 112 LoRaMacDownlinkStatus.Snr = -LoRaMacDownlinkStatus.Snr;
ubhat 0:42863a11464a 113 }
ubhat 0:42863a11464a 114 else
ubhat 0:42863a11464a 115 {
ubhat 0:42863a11464a 116 // Divide by 4
ubhat 0:42863a11464a 117 LoRaMacDownlinkStatus.Snr = ( McpsIndication->Snr & 0xFF ) >> 2;
ubhat 0:42863a11464a 118 }
ubhat 0:42863a11464a 119 LoRaMacDownlinkStatus.DownlinkCounter++;
ubhat 0:42863a11464a 120 LoRaMacDownlinkStatus.RxData = McpsIndication->RxData;
ubhat 0:42863a11464a 121 LoRaMacDownlinkStatus.Port = McpsIndication->Port;
ubhat 0:42863a11464a 122 LoRaMacDownlinkStatus.Buffer = McpsIndication->Buffer;
ubhat 0:42863a11464a 123 LoRaMacDownlinkStatus.BufferSize = McpsIndication->BufferSize;
ubhat 0:42863a11464a 124 LoRaMacDownlinkStatus.RxSlot = McpsIndication->RxSlot;
ubhat 0:42863a11464a 125
ubhat 0:42863a11464a 126 if( ComplianceTest.Running == 1 )
ubhat 0:42863a11464a 127 {
ubhat 0:42863a11464a 128 port = 224;
ubhat 0:42863a11464a 129 ComplianceTest.DownLinkCounter++;
ubhat 0:42863a11464a 130 }
ubhat 0:42863a11464a 131 else
ubhat 0:42863a11464a 132 {
ubhat 0:42863a11464a 133 port = McpsIndication->Port;
ubhat 0:42863a11464a 134 }
ubhat 0:42863a11464a 135
ubhat 0:42863a11464a 136 if( McpsIndication->RxData == true )
ubhat 0:42863a11464a 137 {
ubhat 0:42863a11464a 138 switch( port )
ubhat 0:42863a11464a 139 {
ubhat 0:42863a11464a 140 case 1: // The application LED can be controlled on port 1 or 2
ubhat 0:42863a11464a 141 case 2:
ubhat 0:42863a11464a 142 break;
ubhat 0:42863a11464a 143 case 224:
ubhat 0:42863a11464a 144 PrepareComplianceTestFrame( McpsIndication );
ubhat 0:42863a11464a 145 break;
ubhat 0:42863a11464a 146 default:
ubhat 0:42863a11464a 147 break;
ubhat 0:42863a11464a 148 }
ubhat 0:42863a11464a 149 }
ubhat 0:42863a11464a 150
ubhat 0:42863a11464a 151 IsRxUpdate = true;
ubhat 0:42863a11464a 152
ubhat 0:42863a11464a 153 }
ubhat 0:42863a11464a 154
ubhat 0:42863a11464a 155 /*!
ubhat 0:42863a11464a 156 * \brief MLME-Confirm event function
ubhat 0:42863a11464a 157 *
ubhat 0:42863a11464a 158 * \param [IN] MlmeConfirm - Pointer to the confirm structure,
ubhat 0:42863a11464a 159 * containing confirm attributes.
ubhat 0:42863a11464a 160 */
ubhat 0:42863a11464a 161 void MlmeConfirm( MlmeConfirm_t *MlmeConfirm )
ubhat 0:42863a11464a 162 {
ubhat 0:42863a11464a 163 if( MlmeConfirm->Status == LORAMAC_EVENT_INFO_STATUS_OK )
ubhat 0:42863a11464a 164 {
ubhat 0:42863a11464a 165 switch( MlmeConfirm->MlmeRequest )
ubhat 0:42863a11464a 166 {
ubhat 0:42863a11464a 167 case MLME_JOIN:
ubhat 0:42863a11464a 168 {
ubhat 0:42863a11464a 169 // Status is OK, node has joined the network
ubhat 0:42863a11464a 170 IsNetworkJoinedStatusUpdate = true;
ubhat 0:42863a11464a 171 break;
ubhat 0:42863a11464a 172 }
ubhat 0:42863a11464a 173 case MLME_LINK_CHECK:
ubhat 0:42863a11464a 174 {
ubhat 0:42863a11464a 175 // Check DemodMargin
ubhat 0:42863a11464a 176 // Check NbGateways
ubhat 0:42863a11464a 177 if( ComplianceTest.Running == true )
ubhat 0:42863a11464a 178 {
ubhat 0:42863a11464a 179 ComplianceTest.LinkCheck = true;
ubhat 0:42863a11464a 180 ComplianceTest.DemodMargin = MlmeConfirm->DemodMargin;
ubhat 0:42863a11464a 181 ComplianceTest.NbGateways = MlmeConfirm->NbGateways;
ubhat 0:42863a11464a 182 }
ubhat 0:42863a11464a 183 break;
ubhat 0:42863a11464a 184 }
ubhat 0:42863a11464a 185 default:
ubhat 0:42863a11464a 186 break;
ubhat 0:42863a11464a 187 }
ubhat 0:42863a11464a 188 }
ubhat 0:42863a11464a 189
ubhat 0:42863a11464a 190 // Schedule next packet transmission
ubhat 0:42863a11464a 191 TimerSetValue( &TxNextPacketTimer, OVER_THE_AIR_ACTIVATION_DUTYCYCLE );
ubhat 0:42863a11464a 192 TimerStart( &TxNextPacketTimer );
ubhat 0:42863a11464a 193
ubhat 0:42863a11464a 194 DeviceState = DEVICE_STATE_SLEEP;
ubhat 0:42863a11464a 195 }