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..."
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..."
The image below shows the VT100 application status.
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
History
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
2017-04-24, by mluis [Mon, 24 Apr 2017 13:38:31 +0000] rev 9
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
Updated vt100.h to comply with latest mbed library versions.; Updated mbed library to the latest versions.
2017-04-04, by mluis [Tue, 04 Apr 2017 13:43:31 +0000] rev 8
Updated vt100.h to comply with latest mbed library versions.; Updated mbed library to the latest versions.
Synchronized example application with GitHub LoRaMac-node examples; Updated mbed and LoRaWAN-lib libraries
2016-07-05, by mluis [Tue, 05 Jul 2016 15:01:57 +0000] rev 7
Synchronized example application with GitHub LoRaMac-node examples; Updated mbed and LoRaWAN-lib libraries
Updated LoRaWAN-Lib library
2016-05-18, by mluis [Wed, 18 May 2016 11:34:12 +0000] rev 6
Updated LoRaWAN-Lib library
Updated mbed, LoRaWAN-lib and SX1276Lib libraries.
2016-05-13, by mluis [Fri, 13 May 2016 15:15:13 +0000] rev 5
Updated mbed, LoRaWAN-lib and SX1276Lib libraries.
Updated project with latest version of the used libraries
2016-03-14, by mluis [Mon, 14 Mar 2016 09:20:40 +0000] rev 4
Updated project with latest version of the used libraries
Updated according to https://github.com/Lora-net/LoRaMac-node git revision a2226468d470eceb251338e1acfb24cfd121effa
2016-01-07, by mluis [Thu, 07 Jan 2016 15:14:22 +0000] rev 3
Updated according to https://github.com/Lora-net/LoRaMac-node git revision a2226468d470eceb251338e1acfb24cfd121effa
Updated SX1276Lib library
2015-11-26, by mluis [Thu, 26 Nov 2015 17:22:53 +0000] rev 2
Updated SX1276Lib library
Changed application architecture to mimic GitHub LoRaMac-node repository.
2015-11-26, by mluis [Thu, 26 Nov 2015 12:59:52 +0000] rev 1
Changed application architecture to mimic GitHub LoRaMac-node repository.
LoRaWAN-demo project creation using LoRaWAN-lib library
2015-10-20, by mluis [Tue, 20 Oct 2015 13:23:35 +0000] rev 0
LoRaWAN-demo project creation using LoRaWAN-lib library