Semtech / Mbed 2 deprecated LoRaWAN-demo-76

Application example using LoRaWAN-lib MAC layer implementation

Dependencies:   mbed LoRaWAN-lib SX1276Lib

Dependents:   LoRaWAN-mbed-client-ttn0

LoRaWAN-demo is a ClassA device example project using LoRaWAN-lib and SX1276Lib 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)
 */
#define LORAWAN_DEVICE_EUI                          { 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88 }

/*!
 * 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)
 */
#define LORAWAN_DEVICE_ADDRESS                      ( uint32_t )0x12345678

/*!
 * 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 15:
        {
            AppData[0] = AppLedStateOn;
            if( IsTxConfirmed == true )
            {
                AppData[1] = LoRaMacDownlinkStatus.DownlinkCounter >> 8;
                AppData[2] = LoRaMacDownlinkStatus.DownlinkCounter;
                AppData[3] = LoRaMacDownlinkStatus.Rssi >> 8;
                AppData[4] = LoRaMacDownlinkStatus.Rssi;
                AppData[5] = LoRaMacDownlinkStatus.Snr;
            }
        }
        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                            15

app/Commissioning.h@9:ee9dcbb9708d, 2017-04-24 (annotated)

Committer:
mluis
Date:
Mon Apr 24 13:38:31 2017 +0000
Revision:
9:ee9dcbb9708d
Parent:
app/Comissioning.h@7:3173f0508a98 
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 3:9c6f7f082151 1 /*
mluis 3:9c6f7f082151 2 / _____) _ | |
mluis 3:9c6f7f082151 3 ( (____ _____ ____ _| |_ _____ ____| |__
mluis 3:9c6f7f082151 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
mluis 3:9c6f7f082151 5 _____) ) ____| | | || |_| ____( (___| | | |
mluis 3:9c6f7f082151 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
mluis 3:9c6f7f082151 7 (C)2015 Semtech
mluis 3:9c6f7f082151 8
mluis 7:3173f0508a98 9 Description: End device commissioning parameters
mluis 3:9c6f7f082151 10
mluis 3:9c6f7f082151 11 License: Revised BSD License, see LICENSE.TXT file include in the project
mluis 3:9c6f7f082151 12
mluis 3:9c6f7f082151 13 Maintainer: Miguel Luis and Gregory Cristian
mluis 3:9c6f7f082151 14 */
mluis 7:3173f0508a98 15 #ifndef __LORA_COMMISSIONING_H__
mluis 7:3173f0508a98 16 #define __LORA_COMMISSIONING_H__
mluis 3:9c6f7f082151 17
mluis 3:9c6f7f082151 18 /*!
mluis 3:9c6f7f082151 19 * When set to 1 the application uses the Over-the-Air activation procedure
mluis 3:9c6f7f082151 20 * When set to 0 the application uses the Personalization activation procedure
mluis 3:9c6f7f082151 21 */
mluis 3:9c6f7f082151 22 #define OVER_THE_AIR_ACTIVATION 1
mluis 3:9c6f7f082151 23
mluis 3:9c6f7f082151 24 /*!
mluis 3:9c6f7f082151 25 * Indicates if the end-device is to be connected to a private or public network
mluis 3:9c6f7f082151 26 */
mluis 3:9c6f7f082151 27 #define LORAWAN_PUBLIC_NETWORK true
mluis 3:9c6f7f082151 28
mluis 3:9c6f7f082151 29 /*!
mluis 5:1e9f6a365854 30 * IEEE Organizationally Unique Identifier ( OUI ) (big endian)
mluis 9:ee9dcbb9708d 31 * \remark This is unique to a company or organization
mluis 5:1e9f6a365854 32 */
mluis 5:1e9f6a365854 33 #define IEEE_OUI 0x11, 0x22, 0x33
mluis 5:1e9f6a365854 34
mluis 5:1e9f6a365854 35 /*!
mluis 3:9c6f7f082151 36 * Mote device IEEE EUI (big endian)
mluis 3:9c6f7f082151 37 */
mluis 5:1e9f6a365854 38 #define LORAWAN_DEVICE_EUI { IEEE_OUI, 0x44, 0x55, 0x66, 0x77, 0x88 }
mluis 3:9c6f7f082151 39
mluis 3:9c6f7f082151 40 /*!
mluis 3:9c6f7f082151 41 * Application IEEE EUI (big endian)
mluis 3:9c6f7f082151 42 */
mluis 3:9c6f7f082151 43 #define LORAWAN_APPLICATION_EUI { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
mluis 3:9c6f7f082151 44
mluis 3:9c6f7f082151 45 /*!
mluis 3:9c6f7f082151 46 * AES encryption/decryption cipher application key
mluis 3:9c6f7f082151 47 */
mluis 3:9c6f7f082151 48 #define LORAWAN_APPLICATION_KEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
mluis 3:9c6f7f082151 49
mluis 3:9c6f7f082151 50 /*!
mluis 3:9c6f7f082151 51 * Current network ID
mluis 3:9c6f7f082151 52 */
mluis 3:9c6f7f082151 53 #define LORAWAN_NETWORK_ID ( uint32_t )0
mluis 3:9c6f7f082151 54
mluis 3:9c6f7f082151 55 /*!
mluis 3:9c6f7f082151 56 * Device address on the network (big endian)
mluis 3:9c6f7f082151 57 */
mluis 3:9c6f7f082151 58 #define LORAWAN_DEVICE_ADDRESS ( uint32_t )0x12345678
mluis 3:9c6f7f082151 59
mluis 3:9c6f7f082151 60 /*!
mluis 3:9c6f7f082151 61 * AES encryption/decryption cipher network session key
mluis 3:9c6f7f082151 62 */
mluis 3:9c6f7f082151 63 #define LORAWAN_NWKSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
mluis 3:9c6f7f082151 64
mluis 3:9c6f7f082151 65 /*!
mluis 3:9c6f7f082151 66 * AES encryption/decryption cipher application session key
mluis 3:9c6f7f082151 67 */
mluis 3:9c6f7f082151 68 #define LORAWAN_APPSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
mluis 3:9c6f7f082151 69
mluis 7:3173f0508a98 70 #endif // __LORA_COMMISSIONING_H__