Demonstration of Class-A LoRaWAN device using NAMote-72

Dependencies:   LoRaWAN-lib mbed lib_mpl3115a2 lib_mma8451q lib_gps SX1272Lib

Dependents:   LoRaWAN-NAMote72-BVS-confirmed-tester-0-7v1_copy

LoRaWAN-NAMote72 Application Demo is a Class-A device example project using LoRaWAN-lib and SX1272Lib libraries.

This project is compliant with LoRaWAN V1.0.1 specification.

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.
  • 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

Main.cpp (Device State Machine)

The end-device state machine is defined.

  • Initial State : Device is initialized.
  • Join State : For OTA, Join Request is transmitted to the network until Join Accept is received by the end-device. Join event function is called that sets Red LED ON.
  • Send State : Transmit payload frame is prepared. Tx event is called that blinks the Red LED indicating uplink transmission.
  • Cycle State : Next packet transmission is scheduled

LoRaEventProc.cpp (Events and On-board Application)

Define events during Join, Tx & Rx. Prepare TX packet by appending with appropriate application data.

/media/uploads/ubhat/lora_events.png

  • PrepareLoRaFrame(uint8_t port ) : Prepare LoRa payload frame with on-board application data such as GPS, Temperature, Battery, etc. LoRa.ApplicationCall(AppType ) calls application AppType defined in LoRaApp.cpp. AppType is defined in LoRaApp.h

/media/uploads/ubhat/lora_app.png

LoRaApp.cpp

User-defined applications such as GPS, Temp, Accelerometer, LED indications etc. Event based actions such as LED blink on Tx, LED toggle on downlink etc /media/uploads/ubhat/apptype.png

LoRaDeviceStateProc.cpp

Process function calls corresponding to different Device states /media/uploads/ubhat/device_state.png

LoRaMacLayerService.cpp

Define MAC Layer Services: MLME & MCPS

Serial Terminal Display

By using a serial port connection using applications such as teraterm or putty, one can view the status of the End-Device. Once the End-Device Joins the network, transmission parameters such as payload data, application port, message type etc. are displayed on the terminal.

/media/uploads/ubhat/serial.png

Default Application Payload

This application defaults to sending uplink data to logical port 5. The application payload consists of: /media/uploads/jknapp_smtc/payload.png

Sample Application Payload Calculation for Longitude/Latitude

Payload => 00 19 F6 352BBA A94C20 FFFF

Temperature Calculation

19H => 2510

Temp = 25/2 = 12.5 oC

Battery Level

FFH => 100 %

F6H => 96.5 %

Longitude Calculation

longitude = A94C20H => 1109507210

longitudinal coordinate = -360 + (longitude10 x 180/(223))

longitudinal coordinate = -121.93

Latitude Calculation

latitude = 352BBAH = 348460210

latitude coordinate = (latitude10 x 90/(223-1))

latitude coordinate = 37.39

Committer:
mluis
Date:
Mon Apr 24 13:47:27 2017 +0000
Revision:
18:18408c3c2d0c
Parent:
12:504203733f11
WARNING: Radio API timings changed from micro-seconds to milliseconds; ; Synchronized with https://github.com/Lora-net/LoRaMac-node git revision e506c246652fa44c3f24cecb89d0707b49ece739; Updated all libraries to the latest versions

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:69f2e28d12c1 1 /*
ubhat 0:69f2e28d12c1 2 / _____) _ | |
ubhat 0:69f2e28d12c1 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:69f2e28d12c1 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:69f2e28d12c1 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:69f2e28d12c1 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:69f2e28d12c1 7 (C)2015 Semtech
ubhat 0:69f2e28d12c1 8
ubhat 0:69f2e28d12c1 9 Description: Compliance Test for LoRaWAN End-Device
ubhat 0:69f2e28d12c1 10
ubhat 0:69f2e28d12c1 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:69f2e28d12c1 12
ubhat 0:69f2e28d12c1 13 Maintainer: Uttam Bhat
ubhat 0:69f2e28d12c1 14 */
ubhat 0:69f2e28d12c1 15
ubhat 0:69f2e28d12c1 16 #include "ComplianceTest.h"
ubhat 0:69f2e28d12c1 17
ubhat 0:69f2e28d12c1 18
mluis 18:18408c3c2d0c 19 void PrepareComplianceTestFrame( McpsIndication_t *mcpsIndication )
ubhat 0:69f2e28d12c1 20 {
ubhat 0:69f2e28d12c1 21 uint8_t *pData;
ubhat 0:69f2e28d12c1 22
mluis 18:18408c3c2d0c 23 pData = &mcpsIndication->Buffer[0];
ubhat 0:69f2e28d12c1 24
ubhat 0:69f2e28d12c1 25 if( ComplianceTest.Running == false )
ubhat 0:69f2e28d12c1 26 {
ubhat 0:69f2e28d12c1 27 // Check compliance test enable command (i)
mluis 18:18408c3c2d0c 28 if( ( mcpsIndication->BufferSize == 4 ) &&
ubhat 0:69f2e28d12c1 29 ( pData[0] == 0x01 ) && ( pData[1] == 0x01 ) && ( pData[2] == 0x01 ) && (pData[3] == 0x01 ) )
ubhat 0:69f2e28d12c1 30 {
mluis 18:18408c3c2d0c 31 IsTxConfirmed = false;
ubhat 0:69f2e28d12c1 32 AppPort = 224;
ubhat 0:69f2e28d12c1 33 AppDataSize = 2;
ubhat 0:69f2e28d12c1 34 ComplianceTest.DownLinkCounter = 0;
ubhat 0:69f2e28d12c1 35 ComplianceTest.LinkCheck = false;
ubhat 0:69f2e28d12c1 36 ComplianceTest.DemodMargin = 0;
ubhat 0:69f2e28d12c1 37 ComplianceTest.NbGateways = 0;
ubhat 0:69f2e28d12c1 38 ComplianceTest.Running = true;
mluis 18:18408c3c2d0c 39 ComplianceTest.State = 1;
mluis 18:18408c3c2d0c 40
mluis 18:18408c3c2d0c 41 MibRequestConfirm_t mibReq;
mluis 18:18408c3c2d0c 42 mibReq.Type = MIB_ADR;
mluis 18:18408c3c2d0c 43 mibReq.Param.AdrEnable = true;
mluis 18:18408c3c2d0c 44 LoRaMacMibSetRequestConfirm( &mibReq );
mluis 18:18408c3c2d0c 45
mluis 18:18408c3c2d0c 46 Gps.enable( false );
ubhat 0:69f2e28d12c1 47 }
ubhat 0:69f2e28d12c1 48 }
ubhat 0:69f2e28d12c1 49 else
ubhat 0:69f2e28d12c1 50 {
ubhat 0:69f2e28d12c1 51 ComplianceTest.State = pData[0];
ubhat 0:69f2e28d12c1 52 switch( ComplianceTest.State )
ubhat 0:69f2e28d12c1 53 {
ubhat 0:69f2e28d12c1 54 case 0: // Check compliance test disable command (ii)
mluis 18:18408c3c2d0c 55 DisableComplianceTest( );
ubhat 0:69f2e28d12c1 56 break;
ubhat 0:69f2e28d12c1 57 case 1: // (iii, iv)
ubhat 0:69f2e28d12c1 58 AppDataSize = 2;
ubhat 0:69f2e28d12c1 59 break;
ubhat 0:69f2e28d12c1 60 case 2: // Enable confirmed messages (v)
ubhat 0:69f2e28d12c1 61 IsTxConfirmed = true;
ubhat 0:69f2e28d12c1 62 ComplianceTest.State = 1;
ubhat 0:69f2e28d12c1 63 break;
ubhat 0:69f2e28d12c1 64 case 3: // Disable confirmed messages (vi)
ubhat 0:69f2e28d12c1 65 IsTxConfirmed = false;
ubhat 0:69f2e28d12c1 66 ComplianceTest.State = 1;
ubhat 0:69f2e28d12c1 67 break;
ubhat 0:69f2e28d12c1 68 case 4: // (vii)
mluis 18:18408c3c2d0c 69 AppDataSize = mcpsIndication->BufferSize;
mluis 18:18408c3c2d0c 70
mluis 18:18408c3c2d0c 71 if( AppDataSize > LORAWAN_APP_DATA_MAX_SIZE )
mluis 18:18408c3c2d0c 72 AppDataSize = LORAWAN_APP_DATA_MAX_SIZE;
mluis 18:18408c3c2d0c 73
ubhat 0:69f2e28d12c1 74 AppData[0] = 4;
ubhat 0:69f2e28d12c1 75 for( uint8_t i = 1; i < AppDataSize; i++ )
ubhat 0:69f2e28d12c1 76 {
mluis 18:18408c3c2d0c 77 AppData[i] = mcpsIndication->Buffer[i] + 1;
ubhat 0:69f2e28d12c1 78 }
ubhat 0:69f2e28d12c1 79 break;
ubhat 0:69f2e28d12c1 80 case 5: // (viii)
ubhat 0:69f2e28d12c1 81 {
ubhat 0:69f2e28d12c1 82 MlmeReq_t mlmeReq;
ubhat 0:69f2e28d12c1 83 mlmeReq.Type = MLME_LINK_CHECK;
ubhat 0:69f2e28d12c1 84 LoRaMacMlmeRequest( &mlmeReq );
ubhat 0:69f2e28d12c1 85 }
ubhat 0:69f2e28d12c1 86 break;
mluis 18:18408c3c2d0c 87 case 6: // (viii)
mluis 18:18408c3c2d0c 88 {
mluis 18:18408c3c2d0c 89 MlmeReq_t mlmeReq;
mluis 18:18408c3c2d0c 90
mluis 18:18408c3c2d0c 91 Otaa = true;
mluis 18:18408c3c2d0c 92
mluis 18:18408c3c2d0c 93 mlmeReq.Type = MLME_JOIN;
mluis 18:18408c3c2d0c 94
mluis 18:18408c3c2d0c 95 mlmeReq.Req.Join.DevEui = DevEui;
mluis 18:18408c3c2d0c 96 mlmeReq.Req.Join.AppEui = AppEui;
mluis 18:18408c3c2d0c 97 mlmeReq.Req.Join.AppKey = AppKey;
mluis 18:18408c3c2d0c 98 mlmeReq.Req.Join.NbTrials = 3;
mluis 18:18408c3c2d0c 99
mluis 18:18408c3c2d0c 100 LoRaMacMlmeRequest( &mlmeReq );
mluis 18:18408c3c2d0c 101
mluis 18:18408c3c2d0c 102 Gps.enable( true );
mluis 18:18408c3c2d0c 103 DeviceState = DEVICE_STATE_SLEEP;
mluis 18:18408c3c2d0c 104 }
mluis 18:18408c3c2d0c 105 break;
mluis 18:18408c3c2d0c 106 case 7: // (x)
mluis 18:18408c3c2d0c 107 {
mluis 18:18408c3c2d0c 108 if( mcpsIndication->BufferSize == 3 )
mluis 18:18408c3c2d0c 109 {
mluis 18:18408c3c2d0c 110 MlmeReq_t mlmeReq;
mluis 18:18408c3c2d0c 111 mlmeReq.Type = MLME_TXCW;
mluis 18:18408c3c2d0c 112 mlmeReq.Req.TxCw.Timeout = ( uint16_t )( ( mcpsIndication->Buffer[1] << 8 ) | mcpsIndication->Buffer[2] );
mluis 18:18408c3c2d0c 113 LoRaMacMlmeRequest( &mlmeReq );
mluis 18:18408c3c2d0c 114 }
mluis 18:18408c3c2d0c 115 ComplianceTest.State = 1;
mluis 18:18408c3c2d0c 116 }
mluis 18:18408c3c2d0c 117 break;
ubhat 0:69f2e28d12c1 118 default:
ubhat 0:69f2e28d12c1 119 break;
ubhat 0:69f2e28d12c1 120 }
ubhat 0:69f2e28d12c1 121 }
ubhat 0:69f2e28d12c1 122 }
ubhat 0:69f2e28d12c1 123
ubhat 0:69f2e28d12c1 124 void RunComplianceTest( void )
ubhat 0:69f2e28d12c1 125 {
ubhat 0:69f2e28d12c1 126 if( ComplianceTest.LinkCheck == true )
ubhat 0:69f2e28d12c1 127 {
ubhat 0:69f2e28d12c1 128 ComplianceTest.LinkCheck = false;
ubhat 0:69f2e28d12c1 129 AppDataSize = 3;
ubhat 0:69f2e28d12c1 130 AppData[0] = 5;
ubhat 0:69f2e28d12c1 131 AppData[1] = ComplianceTest.DemodMargin;
ubhat 0:69f2e28d12c1 132 AppData[2] = ComplianceTest.NbGateways;
ubhat 0:69f2e28d12c1 133 ComplianceTest.State = 1;
ubhat 0:69f2e28d12c1 134 }
ubhat 0:69f2e28d12c1 135 else
ubhat 0:69f2e28d12c1 136 {
ubhat 0:69f2e28d12c1 137 switch( ComplianceTest.State )
mluis 18:18408c3c2d0c 138 {
ubhat 0:69f2e28d12c1 139 case 1:
ubhat 0:69f2e28d12c1 140 AppDataSize = 2;
ubhat 0:69f2e28d12c1 141 AppData[0] = ComplianceTest.DownLinkCounter >> 8;
ubhat 0:69f2e28d12c1 142 AppData[1] = ComplianceTest.DownLinkCounter;
ubhat 0:69f2e28d12c1 143 break;
ubhat 0:69f2e28d12c1 144 case 4:
ubhat 0:69f2e28d12c1 145 ComplianceTest.State = 1;
ubhat 0:69f2e28d12c1 146 break;
mluis 18:18408c3c2d0c 147 default:
mluis 18:18408c3c2d0c 148 break;
ubhat 0:69f2e28d12c1 149 }
ubhat 0:69f2e28d12c1 150 }
mluis 18:18408c3c2d0c 151 }
mluis 18:18408c3c2d0c 152
mluis 18:18408c3c2d0c 153 void DisableComplianceTest( void )
mluis 18:18408c3c2d0c 154 {
mluis 18:18408c3c2d0c 155 IsTxConfirmed = LORAWAN_CONFIRMED_MSG_ON;
mluis 18:18408c3c2d0c 156 AppPort = LORAWAN_APP_PORT;
mluis 18:18408c3c2d0c 157 AppDataSize = LORAWAN_APP_DATA_SIZE;
mluis 18:18408c3c2d0c 158 ComplianceTest.DownLinkCounter = 0;
mluis 18:18408c3c2d0c 159 ComplianceTest.Running = false;
mluis 18:18408c3c2d0c 160
mluis 18:18408c3c2d0c 161 MibRequestConfirm_t mibReq;
mluis 18:18408c3c2d0c 162 mibReq.Type = MIB_ADR;
mluis 18:18408c3c2d0c 163 mibReq.Param.AdrEnable = LORAWAN_ADR_ON;
mluis 18:18408c3c2d0c 164 LoRaMacMibSetRequestConfirm( &mibReq );
mluis 18:18408c3c2d0c 165
mluis 18:18408c3c2d0c 166 Gps.enable( true );
mluis 18:18408c3c2d0c 167 }