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:
18:18408c3c2d0c
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: VT100 serial display management
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: Miguel Luis and Gregory Cristian
ubhat 0:69f2e28d12c1 14 */
ubhat 0:69f2e28d12c1 15
ubhat 0:69f2e28d12c1 16 #include "SerialDisplay.h"
ubhat 0:69f2e28d12c1 17
ubhat 0:69f2e28d12c1 18 VT100 vt( USBTX, USBRX );
ubhat 0:69f2e28d12c1 19
ubhat 0:69f2e28d12c1 20 void SerialDisplayJoinUpdate( void )
ubhat 0:69f2e28d12c1 21 {
ubhat 0:69f2e28d12c1 22 printf( "###### ===== JOINING ==== ######\r\n" );
ubhat 0:69f2e28d12c1 23
ubhat 0:69f2e28d12c1 24 DisplayNetworkParam( );
ubhat 0:69f2e28d12c1 25
ubhat 0:69f2e28d12c1 26 printf( "\r\n" );
ubhat 0:69f2e28d12c1 27 }
ubhat 0:69f2e28d12c1 28
ubhat 0:69f2e28d12c1 29 void SerialDisplayTxUpdate(void)
ubhat 0:69f2e28d12c1 30 {
ubhat 0:69f2e28d12c1 31 printf( "###### ===== UPLINK FRAME %d ==== ######\r\n", LoRaMacUplinkStatus.UplinkCounter );
ubhat 0:69f2e28d12c1 32
ubhat 0:69f2e28d12c1 33 DisplayNetworkParam( );
ubhat 0:69f2e28d12c1 34
ubhat 0:69f2e28d12c1 35 printf( "TX PORT: %d\r\n", LoRaMacUplinkStatus.Port );
ubhat 0:69f2e28d12c1 36
ubhat 0:69f2e28d12c1 37 if( LoRaMacUplinkStatus.BufferSize != 0 )
ubhat 0:69f2e28d12c1 38 {
ubhat 0:69f2e28d12c1 39 printf( "TX DATA: " );
ubhat 0:69f2e28d12c1 40 if( LoRaMacUplinkStatus.Type == MCPS_CONFIRMED )
ubhat 0:69f2e28d12c1 41 {
ubhat 0:69f2e28d12c1 42 printf( "CONFIRMED\r\n" );
ubhat 0:69f2e28d12c1 43 }
ubhat 0:69f2e28d12c1 44 else
ubhat 0:69f2e28d12c1 45 {
ubhat 0:69f2e28d12c1 46 printf( "UNCONFIRMED\r\n" );
ubhat 0:69f2e28d12c1 47 }
ubhat 0:69f2e28d12c1 48 SerialDisplayHex( LoRaMacUplinkStatus.Buffer, LoRaMacUplinkStatus.BufferSize );
ubhat 0:69f2e28d12c1 49 }
ubhat 0:69f2e28d12c1 50
ubhat 0:69f2e28d12c1 51 printf( "DATA RATE: DR%d\r\n", LoRaMacUplinkStatus.Datarate );
ubhat 0:69f2e28d12c1 52
ubhat 0:69f2e28d12c1 53 printf( "TX POWER: %d dBm\r\n", 30 - ( LoRaMacUplinkStatus.TxPower << 1 ) );
ubhat 0:69f2e28d12c1 54
ubhat 0:69f2e28d12c1 55 printf( "BATTERY: %2.2fV\r\n", BoardGetBatteryVoltage( ) );
ubhat 0:69f2e28d12c1 56
ubhat 0:69f2e28d12c1 57 printf( "\r\n");
ubhat 0:69f2e28d12c1 58 }
ubhat 0:69f2e28d12c1 59
ubhat 0:69f2e28d12c1 60 void SerialDisplayRxUpdate( void )
ubhat 0:69f2e28d12c1 61 {
ubhat 0:69f2e28d12c1 62 printf( "###### ===== DOWNLINK FRAME %d ==== ######\r\n", LoRaMacDownlinkStatus.DownlinkCounter );
ubhat 0:69f2e28d12c1 63
ubhat 0:69f2e28d12c1 64 printf( "RX WINDOW: %d\r\n", LoRaMacDownlinkStatus.RxSlot + 1 );
ubhat 0:69f2e28d12c1 65
ubhat 0:69f2e28d12c1 66 printf( "RX PORT: %d\r\n", LoRaMacDownlinkStatus.Port );
ubhat 0:69f2e28d12c1 67
ubhat 0:69f2e28d12c1 68 if( LoRaMacDownlinkStatus.BufferSize != 0 )
ubhat 0:69f2e28d12c1 69 {
ubhat 0:69f2e28d12c1 70 printf( "RX DATA: \r\n" );
ubhat 0:69f2e28d12c1 71 SerialDisplayHex( LoRaMacDownlinkStatus.Buffer, LoRaMacDownlinkStatus.BufferSize );
ubhat 0:69f2e28d12c1 72 }
ubhat 0:69f2e28d12c1 73
ubhat 0:69f2e28d12c1 74 printf( "RX RSSI: %d\r\n", LoRaMacDownlinkStatus.Rssi );
ubhat 0:69f2e28d12c1 75
ubhat 0:69f2e28d12c1 76 printf( "RX SNR: %d\r\n", LoRaMacDownlinkStatus.Snr );
ubhat 0:69f2e28d12c1 77
ubhat 0:69f2e28d12c1 78 printf( "\r\n" );
ubhat 0:69f2e28d12c1 79 }
ubhat 0:69f2e28d12c1 80
ubhat 0:69f2e28d12c1 81 void SerialDisplayHex( uint8_t *pData, uint8_t len )
ubhat 0:69f2e28d12c1 82 {
ubhat 0:69f2e28d12c1 83 int i;
ubhat 0:69f2e28d12c1 84 bool newline = 0;
ubhat 0:69f2e28d12c1 85
ubhat 0:69f2e28d12c1 86 for( i = 0; i < len; i++ )
ubhat 0:69f2e28d12c1 87 {
ubhat 0:69f2e28d12c1 88 if( newline != 0 )
ubhat 0:69f2e28d12c1 89 {
ubhat 0:69f2e28d12c1 90 printf( "\r\n" );
ubhat 0:69f2e28d12c1 91 newline = 0;
ubhat 0:69f2e28d12c1 92 }
ubhat 0:69f2e28d12c1 93
ubhat 0:69f2e28d12c1 94 printf( "%02X ", pData[i] );
ubhat 0:69f2e28d12c1 95
ubhat 0:69f2e28d12c1 96 if( ( ( i + 1 ) % 16 ) == 0 )
ubhat 0:69f2e28d12c1 97 {
ubhat 0:69f2e28d12c1 98 newline = 1;
ubhat 0:69f2e28d12c1 99 }
ubhat 0:69f2e28d12c1 100 }
ubhat 0:69f2e28d12c1 101 printf( "\r\n" );
ubhat 0:69f2e28d12c1 102 }
ubhat 0:69f2e28d12c1 103
ubhat 0:69f2e28d12c1 104 void SerialAcclMetrDisplay( uint8_t statusReg )
ubhat 0:69f2e28d12c1 105 {
ubhat 0:69f2e28d12c1 106 printf( "===== DEVICE ORIENTATION ====\r\n" );
ubhat 0:69f2e28d12c1 107 if( ( statusReg & 0x40 ) != 0 )
ubhat 0:69f2e28d12c1 108 {
ubhat 0:69f2e28d12c1 109 printf( "HORIZONTAL + " );
ubhat 0:69f2e28d12c1 110 if( ( statusReg & 0x01 ) != 0 )
ubhat 0:69f2e28d12c1 111 {
ubhat 0:69f2e28d12c1 112 printf( "FACE DOWN" );
ubhat 0:69f2e28d12c1 113 }
ubhat 0:69f2e28d12c1 114 else
ubhat 0:69f2e28d12c1 115 {
ubhat 0:69f2e28d12c1 116 printf( "FACE UP" );
ubhat 0:69f2e28d12c1 117 }
ubhat 0:69f2e28d12c1 118 }
ubhat 0:69f2e28d12c1 119 else
ubhat 0:69f2e28d12c1 120 {
ubhat 0:69f2e28d12c1 121 printf( "VERTICAL" );
ubhat 0:69f2e28d12c1 122 }
ubhat 0:69f2e28d12c1 123 printf( "\r\n\r\n" );
ubhat 0:69f2e28d12c1 124 }
ubhat 0:69f2e28d12c1 125
ubhat 0:69f2e28d12c1 126 void DisplayNetworkParam( void )
ubhat 0:69f2e28d12c1 127 {
ubhat 0:69f2e28d12c1 128 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:69f2e28d12c1 129
ubhat 0:69f2e28d12c1 130 printf( "DEVEUI: " );
ubhat 0:69f2e28d12c1 131 SerialDisplayHex( DevEui, 8 );
ubhat 0:69f2e28d12c1 132
ubhat 0:69f2e28d12c1 133 printf( "APPEUI: " );
ubhat 0:69f2e28d12c1 134 SerialDisplayHex( AppEui, 8 );
ubhat 0:69f2e28d12c1 135
ubhat 0:69f2e28d12c1 136 printf( "APPKEY: " );
ubhat 0:69f2e28d12c1 137 SerialDisplayHex( AppKey, 16 );
ubhat 0:69f2e28d12c1 138
ubhat 0:69f2e28d12c1 139 #else
ubhat 0:69f2e28d12c1 140
ubhat 0:69f2e28d12c1 141 printf( "DEVADDR: " );
ubhat 0:69f2e28d12c1 142
ubhat 0:69f2e28d12c1 143 uint8_t *pData = ( uint8_t* )&DevAddr;
ubhat 0:69f2e28d12c1 144 for( int32_t i = 3; i >= 0; i-- )
ubhat 0:69f2e28d12c1 145 {
ubhat 0:69f2e28d12c1 146 printf( "%02X ", pData[i] );
ubhat 0:69f2e28d12c1 147 }
ubhat 0:69f2e28d12c1 148 printf( "\r\n" );
ubhat 0:69f2e28d12c1 149
ubhat 0:69f2e28d12c1 150 printf( "NWKSKEY: " );
ubhat 0:69f2e28d12c1 151 SerialDisplayHex( NwkSKey, 16 );
ubhat 0:69f2e28d12c1 152
ubhat 0:69f2e28d12c1 153 printf( "APPSKEY: " );
ubhat 0:69f2e28d12c1 154 SerialDisplayHex( AppSKey, 16 );
ubhat 0:69f2e28d12c1 155
ubhat 0:69f2e28d12c1 156 #endif
ubhat 0:69f2e28d12c1 157 }