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/SerialDisplay.cpp@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
SX1276 Shield based Applications

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