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:
Tue May 17 00:21:55 2016 +0000
Revision:
0:69f2e28d12c1
Child:
5:6ffeac53b7cb
Project for LoRa Bootcamp

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 0:69f2e28d12c1 19 bool AppLed = 0;
ubhat 0:69f2e28d12c1 20
ubhat 0:69f2e28d12c1 21 /*!
ubhat 0:69f2e28d12c1 22 * \brief Prepares the payload of the frame based on application port
ubhat 0:69f2e28d12c1 23 */
ubhat 0:69f2e28d12c1 24 void PrepareLoRaFrame( uint8_t port )
ubhat 0:69f2e28d12c1 25 {
ubhat 0:69f2e28d12c1 26
ubhat 0:69f2e28d12c1 27 switch( port )
ubhat 0:69f2e28d12c1 28 {
ubhat 0:69f2e28d12c1 29 case 5:
ubhat 0:69f2e28d12c1 30 {
ubhat 0:69f2e28d12c1 31 uint8_t tmp;
ubhat 0:69f2e28d12c1 32 uint8_t tmpLength;
ubhat 0:69f2e28d12c1 33 uint8_t ptrIndex = 0;
ubhat 0:69f2e28d12c1 34
ubhat 0:69f2e28d12c1 35 // Point the pointer to position index of Tx Buffer
ubhat 0:69f2e28d12c1 36 LoRaApp.ApplicationPtrPos( ptrIndex );
ubhat 0:69f2e28d12c1 37
ubhat 0:69f2e28d12c1 38 tmp = ( AppLed != 0 ) ? 0x0F : 0x00;
ubhat 0:69f2e28d12c1 39 tmpLength = 1;
ubhat 0:69f2e28d12c1 40
ubhat 0:69f2e28d12c1 41 LoRaApp.ApplicationAppendData( &tmp, tmpLength ); // Populate lower nibble of 0th Byte with LED state
ubhat 0:69f2e28d12c1 42
ubhat 0:69f2e28d12c1 43 /*!
ubhat 0:69f2e28d12c1 44 * Read Temperature
ubhat 0:69f2e28d12c1 45 * Appends 1 Byte to TX buffer
ubhat 0:69f2e28d12c1 46 */
ubhat 0:69f2e28d12c1 47 LoRaApp.ApplicationCall( AppTemp );
ubhat 0:69f2e28d12c1 48
ubhat 0:69f2e28d12c1 49 /*!
ubhat 0:69f2e28d12c1 50 * Read Battery
ubhat 0:69f2e28d12c1 51 * Appends 1 Byte to TX buffer
ubhat 0:69f2e28d12c1 52 */
ubhat 0:69f2e28d12c1 53 LoRaApp.ApplicationCall( AppBat );
ubhat 0:69f2e28d12c1 54
ubhat 0:69f2e28d12c1 55 /*!
ubhat 0:69f2e28d12c1 56 * Read GPS coordinates
ubhat 0:69f2e28d12c1 57 * Appends 8 Bytes (3 bytes longitude, 3 bytes latitude, 2 bytes altitude) to TX buffer
ubhat 0:69f2e28d12c1 58 */
ubhat 0:69f2e28d12c1 59 LoRaApp.ApplicationCall( AppGps );
ubhat 0:69f2e28d12c1 60
ubhat 0:69f2e28d12c1 61 /*!
ubhat 0:69f2e28d12c1 62 * Read Accelerometer
ubhat 0:69f2e28d12c1 63 * Appends 2 Bytes to TX buffer
ubhat 0:69f2e28d12c1 64 * Value Orientation
ubhat 0:69f2e28d12c1 65 * 0x99 0x00 horizontal + faceup
ubhat 0:69f2e28d12c1 66 * 0x66 0x00 horizontal + facedown
ubhat 0:69f2e28d12c1 67 * 0x00 0x11 vertical
ubhat 0:69f2e28d12c1 68 */
ubhat 0:69f2e28d12c1 69 LoRaApp.ApplicationCall( AppAccl ); // Generate Accelerometer data bytes
ubhat 0:69f2e28d12c1 70
ubhat 0:69f2e28d12c1 71 /*!
ubhat 0:69f2e28d12c1 72 * Generate Ramp data bytes
ubhat 0:69f2e28d12c1 73 * Appends incremental values of 1 Byte each to TX buffer until Full
ubhat 0:69f2e28d12c1 74 */
ubhat 0:69f2e28d12c1 75 LoRaApp.ApplicationCall( AppRamp );
ubhat 0:69f2e28d12c1 76
ubhat 0:69f2e28d12c1 77 break;
ubhat 0:69f2e28d12c1 78 }
ubhat 0:69f2e28d12c1 79
ubhat 0:69f2e28d12c1 80 // Senet M2X ORIENTATION Demo
ubhat 0:69f2e28d12c1 81 // Set LORAWAN_APP_DATA_SIZE to 2
ubhat 0:69f2e28d12c1 82 case 6:
ubhat 0:69f2e28d12c1 83 {
ubhat 0:69f2e28d12c1 84 uint8_t ptrIndex = 1;
ubhat 0:69f2e28d12c1 85
ubhat 0:69f2e28d12c1 86 //Point the pointer to position index of Tx Buffer
ubhat 0:69f2e28d12c1 87 LoRaApp.ApplicationPtrPos( ptrIndex );
ubhat 0:69f2e28d12c1 88
ubhat 0:69f2e28d12c1 89 LoRaApp.ApplicationCall( AppAcclSenet ); // Generate Accelerometer data bytes
ubhat 0:69f2e28d12c1 90
ubhat 0:69f2e28d12c1 91
ubhat 0:69f2e28d12c1 92
ubhat 0:69f2e28d12c1 93 break;
ubhat 0:69f2e28d12c1 94 }
ubhat 0:69f2e28d12c1 95
ubhat 0:69f2e28d12c1 96 /* Senet GPS Demo
ubhat 0:69f2e28d12c1 97 Data Format (in Hex):
ubhat 0:69f2e28d12c1 98 [01, 02, Lattitude (3 bytes), Longitude (3 Bytes), Elevation (2 bytes), Tx Power (1 byte)]
ubhat 0:69f2e28d12c1 99 */
ubhat 0:69f2e28d12c1 100 case 7:
ubhat 0:69f2e28d12c1 101 {
ubhat 0:69f2e28d12c1 102 uint8_t ptrIndex = 0;
ubhat 0:69f2e28d12c1 103 uint8_t tmp[] = {0x01, 0x02};
ubhat 0:69f2e28d12c1 104
ubhat 0:69f2e28d12c1 105 //Point the pointer to position index of Tx Buffer
ubhat 0:69f2e28d12c1 106 LoRaApp.ApplicationPtrPos( ptrIndex );
ubhat 0:69f2e28d12c1 107
ubhat 0:69f2e28d12c1 108 LoRaApp.ApplicationAppendData( tmp, 2 );
ubhat 0:69f2e28d12c1 109
ubhat 0:69f2e28d12c1 110 LoRaApp.ApplicationCall( AppGps ); // Generate Accelerometer data bytes
ubhat 0:69f2e28d12c1 111
ubhat 0:69f2e28d12c1 112 uint8_t pow = 30 - 2*(( uint8_t ) LoRaMacUplinkStatus.TxPower);
ubhat 0:69f2e28d12c1 113 LoRaApp.ApplicationAppendData( &pow, 1 );
ubhat 0:69f2e28d12c1 114
ubhat 0:69f2e28d12c1 115 break;
ubhat 0:69f2e28d12c1 116 }
ubhat 0:69f2e28d12c1 117
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 * \brief What to do during JOIN process ? blink/toggle LED etc.
ubhat 0:69f2e28d12c1 125 */
ubhat 0:69f2e28d12c1 126 void JoinEvent( void )
ubhat 0:69f2e28d12c1 127 {
ubhat 0:69f2e28d12c1 128 // CtrlLED is defined in LoRaBoardAppIf.h
ubhat 0:69f2e28d12c1 129 // param 1: LED color (Red, Yellow or Green)
ubhat 0:69f2e28d12c1 130 // param 2: LED_ON or LED_OFF
ubhat 0:69f2e28d12c1 131 CtrlLED( Red, LED_ON );
ubhat 0:69f2e28d12c1 132 }
ubhat 0:69f2e28d12c1 133
ubhat 0:69f2e28d12c1 134
ubhat 0:69f2e28d12c1 135 /*!
ubhat 0:69f2e28d12c1 136 * \brief What to do during TX ? blink/toggle LED etc.
ubhat 0:69f2e28d12c1 137 */
ubhat 0:69f2e28d12c1 138 void TxEvent( void )
ubhat 0:69f2e28d12c1 139 {
ubhat 0:69f2e28d12c1 140 int blinkTime = 25000;
ubhat 0:69f2e28d12c1 141
ubhat 0:69f2e28d12c1 142 // Blink Red LED for 25msec
ubhat 0:69f2e28d12c1 143 BlinkLED( Red, blinkTime );
ubhat 0:69f2e28d12c1 144 }
ubhat 0:69f2e28d12c1 145
ubhat 0:69f2e28d12c1 146 void RxEvent()
ubhat 0:69f2e28d12c1 147 {
ubhat 0:69f2e28d12c1 148 // Toggle yellow LED
ubhat 0:69f2e28d12c1 149 ToggleLED( Yellow );
ubhat 0:69f2e28d12c1 150
ubhat 0:69f2e28d12c1 151 // If Rx Data is 0x01 turn on Green LED else if 0x0 Turn Green LED off
ubhat 0:69f2e28d12c1 152 if( LoRaMacDownlinkStatus.BufferSize == 1 )
ubhat 0:69f2e28d12c1 153 {
ubhat 0:69f2e28d12c1 154 if( LoRaMacDownlinkStatus.Buffer[0] == 0x01 )
ubhat 0:69f2e28d12c1 155 {
ubhat 0:69f2e28d12c1 156 AppLed = 1;
ubhat 0:69f2e28d12c1 157 }
ubhat 0:69f2e28d12c1 158 else
ubhat 0:69f2e28d12c1 159 {
ubhat 0:69f2e28d12c1 160 if( LoRaMacDownlinkStatus.Buffer[0] == 0x00 )
ubhat 0:69f2e28d12c1 161 {
ubhat 0:69f2e28d12c1 162 AppLed = 0;
ubhat 0:69f2e28d12c1 163 }
ubhat 0:69f2e28d12c1 164 }
ubhat 0:69f2e28d12c1 165 }
ubhat 0:69f2e28d12c1 166
ubhat 0:69f2e28d12c1 167 if( AppLed != 0 )
ubhat 0:69f2e28d12c1 168 {
ubhat 0:69f2e28d12c1 169 // Turn USR_LED ON
ubhat 0:69f2e28d12c1 170 CtrlLED( Usr, LED_ON );
ubhat 0:69f2e28d12c1 171 }
ubhat 0:69f2e28d12c1 172 else
ubhat 0:69f2e28d12c1 173 {
ubhat 0:69f2e28d12c1 174 // Turn USR_LED OFF
ubhat 0:69f2e28d12c1 175 CtrlLED( Usr, LED_OFF );
ubhat 0:69f2e28d12c1 176 }
ubhat 0:69f2e28d12c1 177 }
ubhat 0:69f2e28d12c1 178