NAMote72 application example using LoRaWAN-lib MAC layer implementation

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
Committer:
mluis
Date:
Thu Feb 18 07:53:02 2016 +0000
Revision:
3:847470093298
Parent:
0:8e36e3d5d706
Child:
9:37deeefbfe45
Updated to the new version of SX1272Lib library

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 #ifndef __BOARD_H__
mluis 0:8e36e3d5d706 16 #define __BOARD_H__
mluis 0:8e36e3d5d706 17
mluis 0:8e36e3d5d706 18 #include "mbed.h"
mluis 0:8e36e3d5d706 19 #include "system/timer.h"
mluis 0:8e36e3d5d706 20 #include "debug.h"
mluis 0:8e36e3d5d706 21 #include "system/utilities.h"
mluis 0:8e36e3d5d706 22 #include "sx1272-hal.h"
mluis 0:8e36e3d5d706 23 #include "gps.h"
mluis 0:8e36e3d5d706 24 #include "mpl3115a2.h"
mluis 0:8e36e3d5d706 25
mluis 0:8e36e3d5d706 26 #define USE_BAND_915_HYBRID
mluis 0:8e36e3d5d706 27
mluis 0:8e36e3d5d706 28 #define LOW_BAT_THRESHOLD 3.45
mluis 0:8e36e3d5d706 29
mluis 0:8e36e3d5d706 30 extern DigitalOut RedLed;
mluis 0:8e36e3d5d706 31 extern DigitalOut GreenLed;
mluis 0:8e36e3d5d706 32 extern DigitalOut YellowLed;
mluis 0:8e36e3d5d706 33 extern DigitalOut UsrLed;
mluis 0:8e36e3d5d706 34 extern GPS Gps;
mluis 0:8e36e3d5d706 35 extern MPL3115A2 Mpl3115a2;
mluis 0:8e36e3d5d706 36
mluis 3:847470093298 37 extern SX1272MB2xAS Radio;
mluis 0:8e36e3d5d706 38
mluis 0:8e36e3d5d706 39 /*!
mluis 0:8e36e3d5d706 40 * \brief Initializes the target board peripherals.
mluis 0:8e36e3d5d706 41 */
mluis 0:8e36e3d5d706 42 void BoardInit( void );
mluis 0:8e36e3d5d706 43
mluis 0:8e36e3d5d706 44 /*!
mluis 0:8e36e3d5d706 45 * \brief Measure the Battery level
mluis 0:8e36e3d5d706 46 *
mluis 0:8e36e3d5d706 47 * \retval value battery level ( 0: very low, 254: fully charged )
mluis 0:8e36e3d5d706 48 */
mluis 0:8e36e3d5d706 49 uint8_t BoardGetBatteryLevel( void );
mluis 0:8e36e3d5d706 50
mluis 0:8e36e3d5d706 51 /*!
mluis 0:8e36e3d5d706 52 * \brief Measure the Battery voltage
mluis 0:8e36e3d5d706 53 *
mluis 0:8e36e3d5d706 54 * \retval value battery voltage in volts
mluis 0:8e36e3d5d706 55 */
mluis 0:8e36e3d5d706 56 float BoardGetBatteryVoltage( void );
mluis 0:8e36e3d5d706 57
mluis 0:8e36e3d5d706 58 /*!
mluis 0:8e36e3d5d706 59 * Returns a pseudo random seed generated using the MCU Unique ID
mluis 0:8e36e3d5d706 60 *
mluis 0:8e36e3d5d706 61 * \retval seed Generated pseudo random seed
mluis 0:8e36e3d5d706 62 */
mluis 0:8e36e3d5d706 63 uint32_t BoardGetRandomSeed( void );
mluis 0:8e36e3d5d706 64
mluis 0:8e36e3d5d706 65 /*!
mluis 0:8e36e3d5d706 66 * \brief Gets the board 64 bits unique ID
mluis 0:8e36e3d5d706 67 *
mluis 0:8e36e3d5d706 68 * \param [IN] id Pointer to an array that will contain the Unique ID
mluis 0:8e36e3d5d706 69 */
mluis 0:8e36e3d5d706 70 void BoardGetUniqueId( uint8_t *id );
mluis 0:8e36e3d5d706 71
mluis 0:8e36e3d5d706 72 #endif // __BOARD_H__