LoRaWAN-demo-NAMote72 - NAMote72 application example using LoRaWAN-lib MA…

Semtech » Code » LoRaWAN-demo-NAMote72

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

board/board.cpp@3:847470093298, 2016-02-18 (annotated)

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?

User	Revision	Line number	New 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	0:8e36e3d5d706	19	* Unique Devices IDs register set ( STM32L1xxx )
mluis	0:8e36e3d5d706	20	*/
mluis	0:8e36e3d5d706	21	#define ID1 ( 0x1FF800D0 )
mluis	0:8e36e3d5d706	22	#define ID2 ( 0x1FF800D4 )
mluis	0:8e36e3d5d706	23	#define ID3 ( 0x1FF800D4 )
mluis	0:8e36e3d5d706	24
mluis	0:8e36e3d5d706	25	typedef enum
mluis	0:8e36e3d5d706	26	{
mluis	0:8e36e3d5d706	27	MOTE_VERSION_NONE = 0,
mluis	0:8e36e3d5d706	28	MOTE_VERSION_2,
mluis	0:8e36e3d5d706	29	MOTE_VERSION_3,
mluis	0:8e36e3d5d706	30	}MoteVersion_t;
mluis	0:8e36e3d5d706	31
mluis	0:8e36e3d5d706	32	MoteVersion_t BoardGetVersion( void );
mluis	0:8e36e3d5d706	33
mluis	0:8e36e3d5d706	34	DigitalOut RedLed( PB_1 ); // Active Low
mluis	0:8e36e3d5d706	35	DigitalOut YellowLed( PB_10 ); // Active Low
mluis	0:8e36e3d5d706	36	DigitalOut GreenLed( PC_3 ); // Active Low
mluis	0:8e36e3d5d706	37	DigitalOut UsrLed( PA_5 ); // Active High
mluis	0:8e36e3d5d706	38
mluis	0:8e36e3d5d706	39
mluis	0:8e36e3d5d706	40	GPS Gps( PB_6, PB_7, PB_11 ); // Gps(tx, rx, en);
mluis	0:8e36e3d5d706	41
mluis	0:8e36e3d5d706	42	DigitalIn I2cInterrupt( PB_4 );
mluis	0:8e36e3d5d706	43	I2C I2c(I2C_SDA, I2C_SCL);
mluis	0:8e36e3d5d706	44
mluis	0:8e36e3d5d706	45	MPL3115A2 Mpl3115a2( I2c, I2cInterrupt );
mluis	0:8e36e3d5d706	46
mluis	0:8e36e3d5d706	47	DigitalOut Pc7( PC_7 );
mluis	0:8e36e3d5d706	48	DigitalIn Pc1( PC_1 );
mluis	0:8e36e3d5d706	49
mluis	0:8e36e3d5d706	50	AnalogIn *Battery;
mluis	0:8e36e3d5d706	51
mluis	0:8e36e3d5d706	52	#define AIN_VREF 3.3 // STM32 internal refernce
mluis	0:8e36e3d5d706	53	#define AIN_VBAT_DIV 2 // Resistor divider
mluis	0:8e36e3d5d706	54
mluis	3:847470093298	55	SX1272MB2xAS Radio( NULL );
mluis	0:8e36e3d5d706	56
mluis	0:8e36e3d5d706	57	void BoardInit( void )
mluis	0:8e36e3d5d706	58	{
mluis	0:8e36e3d5d706	59	// Initalize LEDs
mluis	0:8e36e3d5d706	60	RedLed = 1; // Active Low
mluis	0:8e36e3d5d706	61	GreenLed = 1; // Active Low
mluis	0:8e36e3d5d706	62	YellowLed = 1; // Active Low
mluis	0:8e36e3d5d706	63	UsrLed = 0; // Active High
mluis	0:8e36e3d5d706	64
mluis	0:8e36e3d5d706	65	TimerTimeCounterInit( );
mluis	0:8e36e3d5d706	66
mluis	0:8e36e3d5d706	67	switch( BoardGetVersion( ) )
mluis	0:8e36e3d5d706	68	{
mluis	0:8e36e3d5d706	69	case MOTE_VERSION_2:
mluis	0:8e36e3d5d706	70	Battery = new AnalogIn( PA_0 );
mluis	0:8e36e3d5d706	71	Gps.en_invert = true;
mluis	0:8e36e3d5d706	72	break;
mluis	0:8e36e3d5d706	73	case MOTE_VERSION_3:
mluis	0:8e36e3d5d706	74	Battery = new AnalogIn( PA_1 );
mluis	0:8e36e3d5d706	75	Gps.en_invert = false;
mluis	0:8e36e3d5d706	76	break;
mluis	0:8e36e3d5d706	77	default:
mluis	0:8e36e3d5d706	78	break;
mluis	0:8e36e3d5d706	79	}
mluis	0:8e36e3d5d706	80	Gps.init( );
mluis	0:8e36e3d5d706	81	Gps.enable( 1 );
mluis	0:8e36e3d5d706	82
mluis	0:8e36e3d5d706	83	Mpl3115a2.init( );
mluis	0:8e36e3d5d706	84	}
mluis	0:8e36e3d5d706	85
mluis	0:8e36e3d5d706	86
mluis	0:8e36e3d5d706	87	uint8_t BoardGetBatteryLevel( void )
mluis	0:8e36e3d5d706	88	{
mluis	0:8e36e3d5d706	89	// Per LoRaWAN spec; 0 = Charging; 1...254 = level, 255 = N/A
mluis	0:8e36e3d5d706	90	return ( Battery->read_u16( ) >> 8 ) + ( Battery->read_u16( ) >> 9 );
mluis	0:8e36e3d5d706	91	}
mluis	0:8e36e3d5d706	92
mluis	0:8e36e3d5d706	93	float BoardGetBatteryVoltage( void )
mluis	0:8e36e3d5d706	94	{
mluis	0:8e36e3d5d706	95	return ( Battery->read( ) * AIN_VREF * AIN_VBAT_DIV );
mluis	0:8e36e3d5d706	96	}
mluis	0:8e36e3d5d706	97
mluis	0:8e36e3d5d706	98	uint32_t BoardGetRandomSeed( void )
mluis	0:8e36e3d5d706	99	{
mluis	0:8e36e3d5d706	100	return ( ( ( uint32_t )ID1 ) ^ ( ( uint32_t )ID2 ) ^ ( ( uint32_t )ID3 ) );
mluis	0:8e36e3d5d706	101	}
mluis	0:8e36e3d5d706	102
mluis	0:8e36e3d5d706	103	void BoardGetUniqueId( uint8_t *id )
mluis	0:8e36e3d5d706	104	{
mluis	0:8e36e3d5d706	105	id[7] = ( ( ( uint32_t )ID1 )+ ( ( uint32_t )ID3 ) ) >> 24;
mluis	0:8e36e3d5d706	106	id[6] = ( ( ( uint32_t )ID1 )+ ( ( uint32_t )ID3 ) ) >> 16;
mluis	0:8e36e3d5d706	107	id[5] = ( ( ( uint32_t )ID1 )+ ( ( uint32_t )ID3 ) ) >> 8;
mluis	0:8e36e3d5d706	108	id[4] = ( ( ( uint32_t )ID1 )+ ( ( uint32_t )ID3 ) );
mluis	0:8e36e3d5d706	109	id[3] = ( ( ( uint32_t )ID2 ) ) >> 24;
mluis	0:8e36e3d5d706	110	id[2] = ( ( ( uint32_t )ID2 ) ) >> 16;
mluis	0:8e36e3d5d706	111	id[1] = ( ( ( uint32_t )ID2 ) ) >> 8;
mluis	0:8e36e3d5d706	112	id[0] = ( ( ( uint32_t )ID2 ) );
mluis	0:8e36e3d5d706	113	}
mluis	0:8e36e3d5d706	114
mluis	0:8e36e3d5d706	115	MoteVersion_t BoardGetVersion( void )
mluis	0:8e36e3d5d706	116	{
mluis	0:8e36e3d5d706	117	Pc7 = 1;
mluis	0:8e36e3d5d706	118	char first = Pc1;
mluis	0:8e36e3d5d706	119	Pc7 = 0;
mluis	0:8e36e3d5d706	120
mluis	0:8e36e3d5d706	121	if( first && !Pc1 )
mluis	0:8e36e3d5d706	122	{
mluis	0:8e36e3d5d706	123	return MOTE_VERSION_2;
mluis	0:8e36e3d5d706	124	}
mluis	0:8e36e3d5d706	125	else
mluis	0:8e36e3d5d706	126	{
mluis	0:8e36e3d5d706	127	return MOTE_VERSION_3;
mluis	0:8e36e3d5d706	128	}
mluis	0:8e36e3d5d706	129	}

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Created:	27 Nov 2015
Imports:	69
Forks:	0
Commits:	10
Dependents:	0
Dependencies:	5
Followers:	93

This repository is Public (Unlisted).

Quote:

board/board.cpp@3:847470093298, 2016-02-18 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning