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:
ubhat
Date:
Wed Jun 08 01:40:42 2016 +0000
Revision:
5:6ffeac53b7cb
Parent:
0:69f2e28d12c1
Child:
6:f8194e691dd4
Change state machine flow in main.cpp

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: Define events during Join, Tx & Rx
ubhat 0:69f2e28d12c1 10 Prepare TX packet by appending with appropriate application data
ubhat 0:69f2e28d12c1 11
ubhat 0:69f2e28d12c1 12 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:69f2e28d12c1 13
ubhat 0:69f2e28d12c1 14 Maintainer: Uttam Bhat
ubhat 0:69f2e28d12c1 15 */
ubhat 0:69f2e28d12c1 16
ubhat 0:69f2e28d12c1 17 #include "LoRaEventProc.h"
ubhat 0:69f2e28d12c1 18
ubhat 5:6ffeac53b7cb 19 /*!
ubhat 5:6ffeac53b7cb 20 * Defines the application data transmission duty cycle
ubhat 5:6ffeac53b7cb 21 */
ubhat 5:6ffeac53b7cb 22 uint32_t TxDutyCycleTime = APP_TX_DUTYCYCLE;
ubhat 5:6ffeac53b7cb 23
ubhat 0:69f2e28d12c1 24 bool AppLed = 0;
ubhat 0:69f2e28d12c1 25
ubhat 0:69f2e28d12c1 26 /*!
ubhat 0:69f2e28d12c1 27 * \brief Prepares the payload of the frame based on application port
ubhat 0:69f2e28d12c1 28 */
ubhat 0:69f2e28d12c1 29 void PrepareLoRaFrame( uint8_t port )
ubhat 0:69f2e28d12c1 30 {
ubhat 0:69f2e28d12c1 31
ubhat 0:69f2e28d12c1 32 switch( port )
ubhat 0:69f2e28d12c1 33 {
ubhat 0:69f2e28d12c1 34 case 5:
ubhat 0:69f2e28d12c1 35 {
ubhat 0:69f2e28d12c1 36 uint8_t tmp;
ubhat 0:69f2e28d12c1 37 uint8_t tmpLength;
ubhat 0:69f2e28d12c1 38 uint8_t ptrIndex = 0;
ubhat 0:69f2e28d12c1 39
ubhat 0:69f2e28d12c1 40 // Point the pointer to position index of Tx Buffer
ubhat 0:69f2e28d12c1 41 LoRaApp.ApplicationPtrPos( ptrIndex );
ubhat 0:69f2e28d12c1 42
ubhat 0:69f2e28d12c1 43 tmp = ( AppLed != 0 ) ? 0x0F : 0x00;
ubhat 0:69f2e28d12c1 44 tmpLength = 1;
ubhat 0:69f2e28d12c1 45
ubhat 0:69f2e28d12c1 46 LoRaApp.ApplicationAppendData( &tmp, tmpLength ); // Populate lower nibble of 0th Byte with LED state
ubhat 0:69f2e28d12c1 47
ubhat 0:69f2e28d12c1 48 /*!
ubhat 0:69f2e28d12c1 49 * Read Temperature
ubhat 0:69f2e28d12c1 50 * Appends 1 Byte to TX buffer
ubhat 0:69f2e28d12c1 51 */
ubhat 0:69f2e28d12c1 52 LoRaApp.ApplicationCall( AppTemp );
ubhat 0:69f2e28d12c1 53
ubhat 0:69f2e28d12c1 54 /*!
ubhat 0:69f2e28d12c1 55 * Read Battery
ubhat 0:69f2e28d12c1 56 * Appends 1 Byte to TX buffer
ubhat 0:69f2e28d12c1 57 */
ubhat 0:69f2e28d12c1 58 LoRaApp.ApplicationCall( AppBat );
ubhat 0:69f2e28d12c1 59
ubhat 0:69f2e28d12c1 60 /*!
ubhat 0:69f2e28d12c1 61 * Read GPS coordinates
ubhat 0:69f2e28d12c1 62 * Appends 8 Bytes (3 bytes longitude, 3 bytes latitude, 2 bytes altitude) to TX buffer
ubhat 0:69f2e28d12c1 63 */
ubhat 0:69f2e28d12c1 64 LoRaApp.ApplicationCall( AppGps );
ubhat 0:69f2e28d12c1 65
ubhat 0:69f2e28d12c1 66 /*!
ubhat 0:69f2e28d12c1 67 * Read Accelerometer
ubhat 0:69f2e28d12c1 68 * Appends 2 Bytes to TX buffer
ubhat 0:69f2e28d12c1 69 * Value Orientation
ubhat 0:69f2e28d12c1 70 * 0x99 0x00 horizontal + faceup
ubhat 0:69f2e28d12c1 71 * 0x66 0x00 horizontal + facedown
ubhat 0:69f2e28d12c1 72 * 0x00 0x11 vertical
ubhat 0:69f2e28d12c1 73 */
ubhat 0:69f2e28d12c1 74 LoRaApp.ApplicationCall( AppAccl ); // Generate Accelerometer data bytes
ubhat 0:69f2e28d12c1 75
ubhat 0:69f2e28d12c1 76 /*!
ubhat 0:69f2e28d12c1 77 * Generate Ramp data bytes
ubhat 0:69f2e28d12c1 78 * Appends incremental values of 1 Byte each to TX buffer until Full
ubhat 0:69f2e28d12c1 79 */
ubhat 0:69f2e28d12c1 80 LoRaApp.ApplicationCall( AppRamp );
ubhat 0:69f2e28d12c1 81
ubhat 0:69f2e28d12c1 82 break;
ubhat 0:69f2e28d12c1 83 }
ubhat 0:69f2e28d12c1 84
ubhat 0:69f2e28d12c1 85 // Senet M2X ORIENTATION Demo
ubhat 0:69f2e28d12c1 86 // Set LORAWAN_APP_DATA_SIZE to 2
ubhat 0:69f2e28d12c1 87 case 6:
ubhat 0:69f2e28d12c1 88 {
ubhat 0:69f2e28d12c1 89 uint8_t ptrIndex = 1;
ubhat 0:69f2e28d12c1 90
ubhat 0:69f2e28d12c1 91 //Point the pointer to position index of Tx Buffer
ubhat 0:69f2e28d12c1 92 LoRaApp.ApplicationPtrPos( ptrIndex );
ubhat 0:69f2e28d12c1 93
ubhat 0:69f2e28d12c1 94 LoRaApp.ApplicationCall( AppAcclSenet ); // Generate Accelerometer data bytes
ubhat 0:69f2e28d12c1 95
ubhat 0:69f2e28d12c1 96
ubhat 0:69f2e28d12c1 97
ubhat 0:69f2e28d12c1 98 break;
ubhat 0:69f2e28d12c1 99 }
ubhat 0:69f2e28d12c1 100
ubhat 0:69f2e28d12c1 101 /* Senet GPS Demo
ubhat 0:69f2e28d12c1 102 Data Format (in Hex):
ubhat 0:69f2e28d12c1 103 [01, 02, Lattitude (3 bytes), Longitude (3 Bytes), Elevation (2 bytes), Tx Power (1 byte)]
ubhat 0:69f2e28d12c1 104 */
ubhat 0:69f2e28d12c1 105 case 7:
ubhat 0:69f2e28d12c1 106 {
ubhat 0:69f2e28d12c1 107 uint8_t ptrIndex = 0;
ubhat 0:69f2e28d12c1 108 uint8_t tmp[] = {0x01, 0x02};
ubhat 0:69f2e28d12c1 109
ubhat 0:69f2e28d12c1 110 //Point the pointer to position index of Tx Buffer
ubhat 0:69f2e28d12c1 111 LoRaApp.ApplicationPtrPos( ptrIndex );
ubhat 0:69f2e28d12c1 112
ubhat 0:69f2e28d12c1 113 LoRaApp.ApplicationAppendData( tmp, 2 );
ubhat 0:69f2e28d12c1 114
ubhat 0:69f2e28d12c1 115 LoRaApp.ApplicationCall( AppGps ); // Generate Accelerometer data bytes
ubhat 0:69f2e28d12c1 116
ubhat 0:69f2e28d12c1 117 uint8_t pow = 30 - 2*(( uint8_t ) LoRaMacUplinkStatus.TxPower);
ubhat 0:69f2e28d12c1 118 LoRaApp.ApplicationAppendData( &pow, 1 );
ubhat 0:69f2e28d12c1 119
ubhat 0:69f2e28d12c1 120 break;
ubhat 0:69f2e28d12c1 121 }
ubhat 0:69f2e28d12c1 122
ubhat 0:69f2e28d12c1 123 default:
ubhat 0:69f2e28d12c1 124 break;
ubhat 0:69f2e28d12c1 125 }
ubhat 0:69f2e28d12c1 126 }
ubhat 0:69f2e28d12c1 127
ubhat 5:6ffeac53b7cb 128
ubhat 5:6ffeac53b7cb 129 /*!
ubhat 5:6ffeac53b7cb 130 * \brief Sets Interrupt for next payload transmission
ubhat 5:6ffeac53b7cb 131 */
ubhat 5:6ffeac53b7cb 132 void InitNextTxInterrupt( uint8_t port )
ubhat 5:6ffeac53b7cb 133 {
ubhat 5:6ffeac53b7cb 134 switch( port )
ubhat 5:6ffeac53b7cb 135 {
ubhat 5:6ffeac53b7cb 136 /* GPS Application Demo
ubhat 5:6ffeac53b7cb 137 Set Timer interrupt for next uplink
ubhat 5:6ffeac53b7cb 138 */
ubhat 5:6ffeac53b7cb 139 case 5:
ubhat 5:6ffeac53b7cb 140 {
ubhat 5:6ffeac53b7cb 141 }
ubhat 5:6ffeac53b7cb 142
ubhat 5:6ffeac53b7cb 143 /* Senet + M2X demo
ubhat 5:6ffeac53b7cb 144 Set Timer interrupt for next uplink
ubhat 5:6ffeac53b7cb 145 */
ubhat 5:6ffeac53b7cb 146 case 6:
ubhat 5:6ffeac53b7cb 147 {
ubhat 5:6ffeac53b7cb 148
ubhat 5:6ffeac53b7cb 149 }
ubhat 5:6ffeac53b7cb 150
ubhat 5:6ffeac53b7cb 151 /* Senet GPS Demo
ubhat 5:6ffeac53b7cb 152 Set Timer interrupt for next uplink
ubhat 5:6ffeac53b7cb 153 */
ubhat 5:6ffeac53b7cb 154 case 7:
ubhat 5:6ffeac53b7cb 155 {
ubhat 5:6ffeac53b7cb 156 // Schedule next packet transmission
ubhat 5:6ffeac53b7cb 157 TxDutyCycleTime = APP_TX_DUTYCYCLE + randr( -APP_TX_DUTYCYCLE_RND, APP_TX_DUTYCYCLE_RND );
ubhat 5:6ffeac53b7cb 158 TimerSetValue( &TxNextPacketTimer, TxDutyCycleTime );
ubhat 5:6ffeac53b7cb 159 TimerStart( &TxNextPacketTimer );
ubhat 5:6ffeac53b7cb 160 break;
ubhat 5:6ffeac53b7cb 161 }
ubhat 5:6ffeac53b7cb 162
ubhat 5:6ffeac53b7cb 163 /* Push Button Demo
ubhat 5:6ffeac53b7cb 164 Send Packet Immedietly
ubhat 5:6ffeac53b7cb 165 */
ubhat 5:6ffeac53b7cb 166 case 11:
ubhat 5:6ffeac53b7cb 167 {
ubhat 5:6ffeac53b7cb 168 DeviceState = DEVICE_STATE_SEND;
ubhat 5:6ffeac53b7cb 169 NextTx = true;
ubhat 5:6ffeac53b7cb 170 break;
ubhat 5:6ffeac53b7cb 171 }
ubhat 5:6ffeac53b7cb 172
ubhat 5:6ffeac53b7cb 173 /* Compliance Test
ubhat 5:6ffeac53b7cb 174 Set Timer interrupt for next uplink
ubhat 5:6ffeac53b7cb 175 */
ubhat 5:6ffeac53b7cb 176 case 224:
ubhat 5:6ffeac53b7cb 177 {
ubhat 5:6ffeac53b7cb 178 // Schedule next packet transmission
ubhat 5:6ffeac53b7cb 179 TimerSetValue( &TxNextPacketTimer, COMPLIANCE_TX_DUTYCYCLE );
ubhat 5:6ffeac53b7cb 180 TimerStart( &TxNextPacketTimer );
ubhat 5:6ffeac53b7cb 181 break;
ubhat 5:6ffeac53b7cb 182 }
ubhat 5:6ffeac53b7cb 183
ubhat 5:6ffeac53b7cb 184 default:
ubhat 5:6ffeac53b7cb 185 {
ubhat 5:6ffeac53b7cb 186 // Schedule next packet transmission
ubhat 5:6ffeac53b7cb 187 TimerSetValue( &TxNextPacketTimer, TxDutyCycleTime );
ubhat 5:6ffeac53b7cb 188 TimerStart( &TxNextPacketTimer );
ubhat 5:6ffeac53b7cb 189 break;
ubhat 5:6ffeac53b7cb 190 }
ubhat 5:6ffeac53b7cb 191 }
ubhat 5:6ffeac53b7cb 192
ubhat 5:6ffeac53b7cb 193 }
ubhat 5:6ffeac53b7cb 194
ubhat 0:69f2e28d12c1 195 /*!
ubhat 0:69f2e28d12c1 196 * \brief What to do during JOIN process ? blink/toggle LED etc.
ubhat 0:69f2e28d12c1 197 */
ubhat 0:69f2e28d12c1 198 void JoinEvent( void )
ubhat 0:69f2e28d12c1 199 {
ubhat 0:69f2e28d12c1 200 // CtrlLED is defined in LoRaBoardAppIf.h
ubhat 0:69f2e28d12c1 201 // param 1: LED color (Red, Yellow or Green)
ubhat 0:69f2e28d12c1 202 // param 2: LED_ON or LED_OFF
ubhat 0:69f2e28d12c1 203 CtrlLED( Red, LED_ON );
ubhat 0:69f2e28d12c1 204 }
ubhat 0:69f2e28d12c1 205
ubhat 0:69f2e28d12c1 206
ubhat 0:69f2e28d12c1 207 /*!
ubhat 0:69f2e28d12c1 208 * \brief What to do during TX ? blink/toggle LED etc.
ubhat 0:69f2e28d12c1 209 */
ubhat 0:69f2e28d12c1 210 void TxEvent( void )
ubhat 0:69f2e28d12c1 211 {
ubhat 0:69f2e28d12c1 212 int blinkTime = 25000;
ubhat 0:69f2e28d12c1 213
ubhat 0:69f2e28d12c1 214 // Blink Red LED for 25msec
ubhat 0:69f2e28d12c1 215 BlinkLED( Red, blinkTime );
ubhat 0:69f2e28d12c1 216 }
ubhat 0:69f2e28d12c1 217
ubhat 0:69f2e28d12c1 218 void RxEvent()
ubhat 0:69f2e28d12c1 219 {
ubhat 0:69f2e28d12c1 220 // Toggle yellow LED
ubhat 0:69f2e28d12c1 221 ToggleLED( Yellow );
ubhat 0:69f2e28d12c1 222
ubhat 0:69f2e28d12c1 223 // If Rx Data is 0x01 turn on Green LED else if 0x0 Turn Green LED off
ubhat 0:69f2e28d12c1 224 if( LoRaMacDownlinkStatus.BufferSize == 1 )
ubhat 0:69f2e28d12c1 225 {
ubhat 0:69f2e28d12c1 226 if( LoRaMacDownlinkStatus.Buffer[0] == 0x01 )
ubhat 0:69f2e28d12c1 227 {
ubhat 0:69f2e28d12c1 228 AppLed = 1;
ubhat 0:69f2e28d12c1 229 }
ubhat 0:69f2e28d12c1 230 else
ubhat 0:69f2e28d12c1 231 {
ubhat 0:69f2e28d12c1 232 if( LoRaMacDownlinkStatus.Buffer[0] == 0x00 )
ubhat 0:69f2e28d12c1 233 {
ubhat 0:69f2e28d12c1 234 AppLed = 0;
ubhat 0:69f2e28d12c1 235 }
ubhat 0:69f2e28d12c1 236 }
ubhat 0:69f2e28d12c1 237 }
ubhat 0:69f2e28d12c1 238
ubhat 0:69f2e28d12c1 239 if( AppLed != 0 )
ubhat 0:69f2e28d12c1 240 {
ubhat 0:69f2e28d12c1 241 // Turn USR_LED ON
ubhat 0:69f2e28d12c1 242 CtrlLED( Usr, LED_ON );
ubhat 0:69f2e28d12c1 243 }
ubhat 0:69f2e28d12c1 244 else
ubhat 0:69f2e28d12c1 245 {
ubhat 0:69f2e28d12c1 246 // Turn USR_LED OFF
ubhat 0:69f2e28d12c1 247 CtrlLED( Usr, LED_OFF );
ubhat 0:69f2e28d12c1 248 }
ubhat 0:69f2e28d12c1 249 }
ubhat 0:69f2e28d12c1 250