Semtech / LoRaWAN-demo-NAMote72

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   LoRaWAN-lib SX1272Lib lib_gps lib_mpl3115a2 mbed

LoRaWAN-demo is a ClassA device example project using LoRaWAN-lib and SX1272Lib libraries.

This demo application sends a frame every 4 to 6 seconds (randomly) and displays its current status using a serial port as display(VT100).

The serial port settings are as shown in below image. To access the serial port settings please click on "Setup" menu and then "Serial port..."

/media/uploads/mluis/serial_port_settings.png

The terminal window should be setup as shown in below image. To access the terminal window settings please click on "Setup" menu and then "Terminal..."

/media/uploads/mluis/terminal_window_settings.png

The image below shows the VT100 application status.

Application main screen

The application gives the possibility to either activate the device using

  • Over The Air Activation (OTAA)
  • Personalization activation (PA)

The activation mode can be adjusted in Comissioning.h by changing the following parameter:

/*!
 * When set to 1 the application uses the Over-the-Air activation procedure
 * When set to 0 the application uses the Personalization activation procedure
 */
#define OVER_THE_AIR_ACTIVATION                     1


The application gives the possibility to select which kind of network we are connecting to.

  • Public Network (true)
  • Private Network (false)

The netork type can be changed as follows:

/*!
 * Indicates if the end-device is to be connected to a private or public network
 */
#define LORAWAN_PUBLIC_NETWORK                      true


OTAA
When OTAA is selected the user must porvide a device EUI, an application EUI and an application key.
These can be adjusted by changing the following parameters:

/*!
 * Mote device IEEE EUI (big endian)
 *
 * \remark In this application the value is automatically generated by calling
 *         BoardGetUniqueId function
 */
#define LORAWAN_DEVICE_EUI                          { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }

/*!
 * Application IEEE EUI (big endian)
 */
#define LORAWAN_APPLICATION_EUI                     { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }

/*!
 * AES encryption/decryption cipher application key
 */
#define LORAWAN_APPLICATION_KEY                     { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }


PA
When PA is selected the user must porvide a network ID, a device address, a network session key and an application session key.
These can be adjusted by changing the following parameters:

/*!
 * Current network ID
 */
#define LORAWAN_NETWORK_ID                          ( uint32_t )0

/*!
 * Device address on the network (big endian)
 *
 * \remark In this application the value is automatically generated using
 *         a pseudo random generator seeded with a value derived from
 *         BoardUniqueId value
 */
#define LORAWAN_DEVICE_ADDRESS                      ( uint32_t )0x00000000

/*!
 * AES encryption/decryption cipher network session key
 */
#define LORAWAN_NWKSKEY                             { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }

/*!
 * AES encryption/decryption cipher application session key
 */
#define LORAWAN_APPSKEY                             { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }


On top of main.c the user has the possibility to tweak some application settings such as:

  • Join requests transmission frequency
  • Frames transmission frequency
  • Application default datarate
  • Confirmed or Unconfirmed frames transmission
  • ADR (Adaptive Datarate) ON/OFF
  • Application port to be used by the transmitted frames

The join requests transmission frequency can be adjusted by changing the follwoing parameter: 

/*!
 * Join requests trials duty cycle.
 */
#define OVER_THE_AIR_ACTIVATION_DUTYCYCLE           10000000  // 10 [s] value in us


The frame transmission frequency can be adjusted by changing the follwoing parameters:

/*!
 * Defines the application data transmission duty cycle. 5s, value in [us].
 */
#define APP_TX_DUTYCYCLE                            5000000

/*!
 * Defines a random delay for application data transmission duty cycle. 1s,
 * value in [us].
 */
#define APP_TX_DUTYCYCLE_RND                        1000000


The frame transmission scheduling is then executed as follows:

        if( ScheduleNextTx == true )
        {
            ScheduleNextTx = false;
            // Schedule next packet transmission
            TxDutyCycleTime = APP_TX_DUTYCYCLE + randr( -APP_TX_DUTYCYCLE_RND, APP_TX_DUTYCYCLE_RND );
            TimerSetValue( &TxNextPacketTimer, TxDutyCycleTime );
            TimerStart( &TxNextPacketTimer );
        }


The application default datarate can be adjusted by changing the following parameter:

Quote:

When ADR is off this setting is the fixed datarate that will be used by the application.
When ADR is on this setting is the initial datarate used by the application.

/*!
 * Default mote datarate
 */
#define LORAWAN_DEFAULT_DATARATE                    DR_0


The transmitted frame contents will depend on LORAWAN_CONFIRMED_MSG_ON value.

/*!
 * LoRaWAN confirmed messages
 */
#define LORAWAN_CONFIRMED_MSG_ON                    true
  • If LORAWAN_CONFIRMED_MSG_ON equals false then the application payload is one byte corresponding to the AppLed state.
  • If LORAWAN_CONFIRMED_MSG_ON equals true then the application payload is six bytes corresponding to the AppLed state, Downlink counter (unsigned 16 bits), received RSSI (signed 16 bits) and received SNR (signed 8 bits). 

/*!
 * \brief   Prepares the payload of the frame
 */
static void PrepareTxFrame( uint8_t port )
{
...
    switch( port )
    {
    case 5:
        {
            Gps.service( );
            Mpl3115a2.ReadTemperature( );
            AppData[0] = AppLedStateOn;                        // (bit 0 == 1) => LED on
            AppData[1] = ( int32_t )Mpl3115a2.Temperature;     // Signed degrees Celcius in half degree units. So, +/-63 °C
            AppData[2] = BoardGetBatteryLevel( );              // Per LoRaWAN spec; 0 = Charging; 1...254 = level, 255 = N/A
            AppData[3] = ( Gps.LatitudeBinary >> 16 ) & 0xFF;
            AppData[4] = ( Gps.LatitudeBinary >> 8 ) & 0xFF;
            AppData[5] = Gps.LatitudeBinary & 0xFF;
            AppData[6] = ( Gps.LongitudeBinary >> 16 ) & 0xFF;
            AppData[7] = ( Gps.LongitudeBinary >> 8 ) & 0xFF;
            AppData[8] = Gps.LongitudeBinary & 0xFF;

            uint16_t altitudeGps = atoi( Gps.NmeaGpsData.NmeaAltitude );
            AppData[9] = ( altitudeGps >> 8 ) & 0xFF;
            AppData[10] = altitudeGps & 0xFF;
        }
        break;
    case 224:
...
}


The ADR enabling/disabling can be adjusted by changing the following parameter:

/*!
 * LoRaWAN Adaptive Data Rate
 *
 * \remark Please note that when ADR is enabled the end-device should be static
 */
#define LORAWAN_ADR_ON                              1


The application port can be adjusted by changing the following parameter:

/*!
 * LoRaWAN application port
 */
#define LORAWAN_APP_PORT                            5

board/board.cpp@9:37deeefbfe45, 2017-04-24 (annotated)

Committer:
mluis
Date:
Mon Apr 24 13:42:18 2017 +0000
Revision:
9:37deeefbfe45
Parent:
3:847470093298 
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
mluis 0:8e36e3d5d706 1 /*
mluis 0:8e36e3d5d706 2 / _____) _ | |
mluis 0:8e36e3d5d706 3 ( (____ _____ ____ _| |_ _____ ____| |__
mluis 0:8e36e3d5d706 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
mluis 0:8e36e3d5d706 5 _____) ) ____| | | || |_| ____( (___| | | |
mluis 0:8e36e3d5d706 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
mluis 0:8e36e3d5d706 7 (C)2015 Semtech
mluis 0:8e36e3d5d706 8
mluis 0:8e36e3d5d706 9 Description: Target board general functions implementation
mluis 0:8e36e3d5d706 10
mluis 0:8e36e3d5d706 11 License: Revised BSD License, see LICENSE.TXT file include in the project
mluis 0:8e36e3d5d706 12
mluis 0:8e36e3d5d706 13 Maintainer: Miguel Luis and Gregory Cristian
mluis 0:8e36e3d5d706 14 */
mluis 0:8e36e3d5d706 15 #include "mbed.h"
mluis 0:8e36e3d5d706 16 #include "board.h"
mluis 0:8e36e3d5d706 17
mluis 0:8e36e3d5d706 18 /*!
mluis 9:37deeefbfe45 19 * Unique Devices IDs register set ( STM32 )
mluis 0:8e36e3d5d706 20 */
mluis 0:8e36e3d5d706 21 #define ID1 ( 0x1FF800D0 )
mluis 0:8e36e3d5d706 22 #define ID2 ( 0x1FF800D4 )
mluis 9:37deeefbfe45 23 #define ID3 ( 0x1FF800E4 )
mluis 0:8e36e3d5d706 24
mluis 0:8e36e3d5d706 25 DigitalOut RedLed( PB_1 ); // Active Low
mluis 0:8e36e3d5d706 26 DigitalOut YellowLed( PB_10 ); // Active Low
mluis 0:8e36e3d5d706 27 DigitalOut GreenLed( PC_3 ); // Active Low
mluis 0:8e36e3d5d706 28 DigitalOut UsrLed( PA_5 ); // Active High
mluis 0:8e36e3d5d706 29
mluis 0:8e36e3d5d706 30
mluis 0:8e36e3d5d706 31 GPS Gps( PB_6, PB_7, PB_11 ); // Gps(tx, rx, en);
mluis 0:8e36e3d5d706 32
mluis 0:8e36e3d5d706 33 DigitalIn I2cInterrupt( PB_4 );
mluis 0:8e36e3d5d706 34 I2C I2c(I2C_SDA, I2C_SCL);
mluis 0:8e36e3d5d706 35
mluis 0:8e36e3d5d706 36 MPL3115A2 Mpl3115a2( I2c, I2cInterrupt );
mluis 0:8e36e3d5d706 37
mluis 0:8e36e3d5d706 38 DigitalOut Pc7( PC_7 );
mluis 0:8e36e3d5d706 39 DigitalIn Pc1( PC_1 );
mluis 0:8e36e3d5d706 40
mluis 0:8e36e3d5d706 41 AnalogIn *Battery;
mluis 0:8e36e3d5d706 42
mluis 9:37deeefbfe45 43 #define AIN_VREF 3300 // STM32 internal refernce
mluis 0:8e36e3d5d706 44 #define AIN_VBAT_DIV 2 // Resistor divider
mluis 0:8e36e3d5d706 45
mluis 3:847470093298 46 SX1272MB2xAS Radio( NULL );
mluis 0:8e36e3d5d706 47
mluis 9:37deeefbfe45 48 /*!
mluis 9:37deeefbfe45 49 * Nested interrupt counter.
mluis 9:37deeefbfe45 50 *
mluis 9:37deeefbfe45 51 * \remark Interrupt should only be fully disabled once the value is 0
mluis 9:37deeefbfe45 52 */
mluis 9:37deeefbfe45 53 static uint8_t IrqNestLevel = 0;
mluis 9:37deeefbfe45 54
mluis 9:37deeefbfe45 55 void BoardDisableIrq( void )
mluis 9:37deeefbfe45 56 {
mluis 9:37deeefbfe45 57 __disable_irq( );
mluis 9:37deeefbfe45 58 IrqNestLevel++;
mluis 9:37deeefbfe45 59 }
mluis 9:37deeefbfe45 60
mluis 9:37deeefbfe45 61 void BoardEnableIrq( void )
mluis 9:37deeefbfe45 62 {
mluis 9:37deeefbfe45 63 IrqNestLevel--;
mluis 9:37deeefbfe45 64 if( IrqNestLevel == 0 )
mluis 9:37deeefbfe45 65 {
mluis 9:37deeefbfe45 66 __enable_irq( );
mluis 9:37deeefbfe45 67 }
mluis 9:37deeefbfe45 68 }
mluis 9:37deeefbfe45 69
mluis 0:8e36e3d5d706 70 void BoardInit( void )
mluis 0:8e36e3d5d706 71 {
mluis 0:8e36e3d5d706 72 // Initalize LEDs
mluis 0:8e36e3d5d706 73 RedLed = 1; // Active Low
mluis 0:8e36e3d5d706 74 GreenLed = 1; // Active Low
mluis 9:37deeefbfe45 75 YellowLed = 1; // Active Low
mluis 0:8e36e3d5d706 76 UsrLed = 0; // Active High
mluis 0:8e36e3d5d706 77
mluis 0:8e36e3d5d706 78 TimerTimeCounterInit( );
mluis 0:8e36e3d5d706 79
mluis 0:8e36e3d5d706 80 switch( BoardGetVersion( ) )
mluis 0:8e36e3d5d706 81 {
mluis 9:37deeefbfe45 82 case BOARD_VERSION_2:
mluis 0:8e36e3d5d706 83 Battery = new AnalogIn( PA_0 );
mluis 0:8e36e3d5d706 84 Gps.en_invert = true;
mluis 0:8e36e3d5d706 85 break;
mluis 9:37deeefbfe45 86 case BOARD_VERSION_3:
mluis 0:8e36e3d5d706 87 Battery = new AnalogIn( PA_1 );
mluis 0:8e36e3d5d706 88 Gps.en_invert = false;
mluis 0:8e36e3d5d706 89 break;
mluis 0:8e36e3d5d706 90 default:
mluis 0:8e36e3d5d706 91 break;
mluis 0:8e36e3d5d706 92 }
mluis 0:8e36e3d5d706 93 Gps.init( );
mluis 0:8e36e3d5d706 94 Gps.enable( 1 );
mluis 9:37deeefbfe45 95
mluis 0:8e36e3d5d706 96 Mpl3115a2.init( );
mluis 0:8e36e3d5d706 97 }
mluis 0:8e36e3d5d706 98
mluis 0:8e36e3d5d706 99
mluis 0:8e36e3d5d706 100 uint8_t BoardGetBatteryLevel( void )
mluis 0:8e36e3d5d706 101 {
mluis 0:8e36e3d5d706 102 // Per LoRaWAN spec; 0 = Charging; 1...254 = level, 255 = N/A
mluis 0:8e36e3d5d706 103 return ( Battery->read_u16( ) >> 8 ) + ( Battery->read_u16( ) >> 9 );
mluis 0:8e36e3d5d706 104 }
mluis 0:8e36e3d5d706 105
mluis 9:37deeefbfe45 106 uint32_t BoardGetBatteryVoltage( void )
mluis 0:8e36e3d5d706 107 {
mluis 0:8e36e3d5d706 108 return ( Battery->read( ) * AIN_VREF * AIN_VBAT_DIV );
mluis 0:8e36e3d5d706 109 }
mluis 0:8e36e3d5d706 110
mluis 0:8e36e3d5d706 111 uint32_t BoardGetRandomSeed( void )
mluis 0:8e36e3d5d706 112 {
mluis 0:8e36e3d5d706 113 return ( ( *( uint32_t* )ID1 ) ^ ( *( uint32_t* )ID2 ) ^ ( *( uint32_t* )ID3 ) );
mluis 0:8e36e3d5d706 114 }
mluis 0:8e36e3d5d706 115
mluis 9:37deeefbfe45 116 void BoardGetDevEUI( uint8_t *id )
mluis 9:37deeefbfe45 117 {
mluis 9:37deeefbfe45 118 uint32_t *pDevEuiHWord = ( uint32_t* )&id[4];
mluis 9:37deeefbfe45 119
mluis 9:37deeefbfe45 120 if( *pDevEuiHWord == 0 )
mluis 9:37deeefbfe45 121 {
mluis 9:37deeefbfe45 122 *pDevEuiHWord = BoardGetRandomSeed( );
mluis 9:37deeefbfe45 123 }
mluis 9:37deeefbfe45 124
mluis 9:37deeefbfe45 125 }
mluis 9:37deeefbfe45 126
mluis 0:8e36e3d5d706 127 void BoardGetUniqueId( uint8_t *id )
mluis 0:8e36e3d5d706 128 {
mluis 0:8e36e3d5d706 129 id[7] = ( ( *( uint32_t* )ID1 )+ ( *( uint32_t* )ID3 ) ) >> 24;
mluis 0:8e36e3d5d706 130 id[6] = ( ( *( uint32_t* )ID1 )+ ( *( uint32_t* )ID3 ) ) >> 16;
mluis 0:8e36e3d5d706 131 id[5] = ( ( *( uint32_t* )ID1 )+ ( *( uint32_t* )ID3 ) ) >> 8;
mluis 0:8e36e3d5d706 132 id[4] = ( ( *( uint32_t* )ID1 )+ ( *( uint32_t* )ID3 ) );
mluis 0:8e36e3d5d706 133 id[3] = ( ( *( uint32_t* )ID2 ) ) >> 24;
mluis 0:8e36e3d5d706 134 id[2] = ( ( *( uint32_t* )ID2 ) ) >> 16;
mluis 0:8e36e3d5d706 135 id[1] = ( ( *( uint32_t* )ID2 ) ) >> 8;
mluis 0:8e36e3d5d706 136 id[0] = ( ( *( uint32_t* )ID2 ) );
mluis 0:8e36e3d5d706 137 }
mluis 0:8e36e3d5d706 138
mluis 9:37deeefbfe45 139 BoardVersion_t BoardGetVersion( void )
mluis 0:8e36e3d5d706 140 {
mluis 0:8e36e3d5d706 141 Pc7 = 1;
mluis 0:8e36e3d5d706 142 char first = Pc1;
mluis 0:8e36e3d5d706 143 Pc7 = 0;
mluis 0:8e36e3d5d706 144
mluis 0:8e36e3d5d706 145 if( first && !Pc1 )
mluis 0:8e36e3d5d706 146 {
mluis 9:37deeefbfe45 147 return BOARD_VERSION_2;
mluis 0:8e36e3d5d706 148 }
mluis 0:8e36e3d5d706 149 else
mluis 0:8e36e3d5d706 150 {
mluis 9:37deeefbfe45 151 return BOARD_VERSION_3;
mluis 0:8e36e3d5d706 152 }
mluis 0:8e36e3d5d706 153 }