LoRaWAN-demo-72 - Application example using LoRaWAN-lib MAC layer i…

Semtech » Code » LoRaWAN-demo-72

Semtech / Mbed 2 deprecated LoRaWAN-demo-72

Application example using LoRaWAN-lib MAC layer implementation

Dependencies: mbed LoRaWAN-lib SX1272Lib

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)
 */
#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/vt100.h@7:5077515c163b, 2017-04-24 (annotated)

Committer:: mluis
Date:: Mon Apr 24 13:29:34 2017 +0000
Revision:: 7:5077515c163b
Parent:: 6:0e8d45c5cbbc

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?

User	Revision	Line number	New contents of line
mluis	0:45496a70a8a5	1	/*
mluis	0:45496a70a8a5	2	/ _____) _ \| \|
mluis	0:45496a70a8a5	3	( (____ _____ ____ _\| \|_ _____ ____\| \|__
mluis	0:45496a70a8a5	4	\____ \\| ___ \| (_ _) ___ \|/ ___) _ \
mluis	0:45496a70a8a5	5	_____) ) ____\| \| \| \|\| \|_\| ____( (___\| \| \| \|
mluis	0:45496a70a8a5	6	(______/\|_____)_\|_\|_\| \__)_____)\____)_\| \|_\|
mluis	0:45496a70a8a5	7	(C)2015 Semtech
mluis	0:45496a70a8a5	8
mluis	0:45496a70a8a5	9	Description: VT100 terminal support class
mluis	0:45496a70a8a5	10
mluis	0:45496a70a8a5	11	License: Revised BSD License, see LICENSE.TXT file include in the project
mluis	0:45496a70a8a5	12
mluis	0:45496a70a8a5	13	Maintainer: Miguel Luis and Gregory Cristian
mluis	0:45496a70a8a5	14	*/
mluis	0:45496a70a8a5	15	#ifndef __VT100_H__
mluis	0:45496a70a8a5	16	#define __VT100_H__
mluis	0:45496a70a8a5	17
mluis	0:45496a70a8a5	18	#ifndef STRING_STACK_LIMIT
mluis	0:45496a70a8a5	19	#define STRING_STACK_LIMIT 120
mluis	0:45496a70a8a5	20	#endif
mluis	0:45496a70a8a5	21
mluis	0:45496a70a8a5	22	/**
mluis	0:45496a70a8a5	23	* Implements VT100 terminal commands support.
mluis	0:45496a70a8a5	24	* Implments also the same behaviour has RawSerial class. The only difference
mluis	0:45496a70a8a5	25	* is located in putc fucntion where writeable check is made befor sending the character.
mluis	0:45496a70a8a5	26	*/
mluis	0:45496a70a8a5	27	class VT100 : public SerialBase
mluis	0:45496a70a8a5	28	{
mluis	0:45496a70a8a5	29	public:
mluis	0:45496a70a8a5	30	enum TextAttributes
mluis	0:45496a70a8a5	31	{
mluis	0:45496a70a8a5	32	ATTR_OFF = 0,
mluis	0:45496a70a8a5	33	BOLD = 1,
mluis	0:45496a70a8a5	34	USCORE = 4,
mluis	0:45496a70a8a5	35	BLINK = 5,
mluis	0:45496a70a8a5	36	REVERSE = 7,
mluis	0:45496a70a8a5	37	BOLD_OFF = 21,
mluis	0:45496a70a8a5	38	USCORE_OFF = 24,
mluis	0:45496a70a8a5	39	BLINK_OFF = 25,
mluis	0:45496a70a8a5	40	REVERSE_OFF = 27,
mluis	0:45496a70a8a5	41	};
mluis	0:45496a70a8a5	42
mluis	0:45496a70a8a5	43	enum Colors
mluis	0:45496a70a8a5	44	{
mluis	0:45496a70a8a5	45	BLACK = 0,
mluis	0:45496a70a8a5	46	RED = 1,
mluis	0:45496a70a8a5	47	GREEN = 2,
mluis	0:45496a70a8a5	48	BROWN = 3,
mluis	0:45496a70a8a5	49	BLUE = 4,
mluis	0:45496a70a8a5	50	MAGENTA = 5,
mluis	0:45496a70a8a5	51	CYAN = 6,
mluis	0:45496a70a8a5	52	WHITE = 7,
mluis	0:45496a70a8a5	53	};
mluis	0:45496a70a8a5	54
mluis	6:0e8d45c5cbbc	55	VT100( PinName tx, PinName rx ): SerialBase( tx, rx, 115200 )
mluis	0:45496a70a8a5	56	{
mluis	0:45496a70a8a5	57	// initializes terminal to "power-on" settings
mluis	0:45496a70a8a5	58	// ESC c
mluis	0:45496a70a8a5	59	this->printf( "\x1B\x63" );
mluis	0:45496a70a8a5	60	}
mluis	0:45496a70a8a5	61
mluis	0:45496a70a8a5	62	void ClearScreen( uint8_t param )
mluis	0:45496a70a8a5	63	{
mluis	0:45496a70a8a5	64	// ESC [ Ps J
mluis	0:45496a70a8a5	65	// 0 Clear screen from cursor down
mluis	0:45496a70a8a5	66	// 1 Clear screen from cursor up
mluis	0:45496a70a8a5	67	// 2 Clear entire screen
mluis	0:45496a70a8a5	68	this->printf( "\x1B[%dJ", param );
mluis	0:45496a70a8a5	69	}
mluis	0:45496a70a8a5	70
mluis	0:45496a70a8a5	71	void ClearLine( uint8_t param )
mluis	0:45496a70a8a5	72	{
mluis	0:45496a70a8a5	73	// ESC [ Ps K
mluis	0:45496a70a8a5	74	// 0 Erase from the active position to the end of the line, inclusive (default)
mluis	0:45496a70a8a5	75	// 1 Erase from the start of the screen to the active position, inclusive
mluis	0:45496a70a8a5	76	// 2 Erase all of the line, inclusive
mluis	0:45496a70a8a5	77	this->printf( "\x1B[%dK", param );
mluis	0:45496a70a8a5	78	}
mluis	0:45496a70a8a5	79
mluis	0:45496a70a8a5	80	void SetAttribute( uint8_t attr )
mluis	0:45496a70a8a5	81	{
mluis	0:45496a70a8a5	82	// ESC [ Ps;...;Ps m
mluis	0:45496a70a8a5	83	this->printf( "\x1B[%dm", attr );
mluis	0:45496a70a8a5	84	}
mluis	0:45496a70a8a5	85
mluis	0:45496a70a8a5	86	void SetAttribute( uint8_t attr, uint8_t fgcolor, uint8_t bgcolor )
mluis	0:45496a70a8a5	87	{
mluis	0:45496a70a8a5	88	// ESC [ Ps;...;Ps m
mluis	0:45496a70a8a5	89	this->printf( "\x1B[%d;%d;%dm", attr, fgcolor + 30, bgcolor + 40 );
mluis	0:45496a70a8a5	90	}
mluis	0:45496a70a8a5	91
mluis	0:45496a70a8a5	92	void SetCursorMode( uint8_t visible )
mluis	0:45496a70a8a5	93	{
mluis	0:45496a70a8a5	94	if( visible == true )
mluis	0:45496a70a8a5	95	{
mluis	0:45496a70a8a5	96	// ESC [ ? 25 h
mluis	0:45496a70a8a5	97	this->printf( "\x1B[?25h" );
mluis	0:45496a70a8a5	98	}
mluis	0:45496a70a8a5	99	else
mluis	0:45496a70a8a5	100	{
mluis	0:45496a70a8a5	101	// ESC [ ? 25 l
mluis	0:45496a70a8a5	102	this->printf( "\x1B[?25l" );
mluis	0:45496a70a8a5	103	}
mluis	0:45496a70a8a5	104	}
mluis	0:45496a70a8a5	105
mluis	0:45496a70a8a5	106	void SetCursorPos( uint8_t line, uint8_t col )
mluis	0:45496a70a8a5	107	{
mluis	0:45496a70a8a5	108	// ESC [ Pl ; Pc H
mluis	0:45496a70a8a5	109	this->printf( "\x1B[%d;%dH", line, col );
mluis	0:45496a70a8a5	110	}
mluis	0:45496a70a8a5	111
mluis	0:45496a70a8a5	112	void PutStringAt( uint8_t line, uint8_t col, const char *s )
mluis	0:45496a70a8a5	113	{
mluis	0:45496a70a8a5	114	this->SetCursorPos( line, col );
mluis	0:45496a70a8a5	115	this->printf( "%s", s );
mluis	0:45496a70a8a5	116	}
mluis	0:45496a70a8a5	117
mluis	0:45496a70a8a5	118	void PutCharAt( uint8_t line, uint8_t col, uint8_t c )
mluis	0:45496a70a8a5	119	{
mluis	0:45496a70a8a5	120	this->SetCursorPos( line, col );
mluis	0:45496a70a8a5	121	this->printf( "%c", c );
mluis	0:45496a70a8a5	122	}
mluis	0:45496a70a8a5	123
mluis	0:45496a70a8a5	124	void PutHexAt( uint8_t line, uint8_t col, uint16_t n )
mluis	0:45496a70a8a5	125	{
mluis	0:45496a70a8a5	126	this->SetCursorPos( line, col );
mluis	0:45496a70a8a5	127	this->printf( "%X", n );
mluis	0:45496a70a8a5	128	}
mluis	0:45496a70a8a5	129
mluis	0:45496a70a8a5	130	void PutBoxDrawingChar( uint8_t c )
mluis	0:45496a70a8a5	131	{
mluis	0:45496a70a8a5	132	this->printf( "\x1B(0%c\x1b(B", c );
mluis	0:45496a70a8a5	133	}
mluis	0:45496a70a8a5	134
mluis	0:45496a70a8a5	135	bool Readable( void )
mluis	0:45496a70a8a5	136	{
mluis	0:45496a70a8a5	137	return this->readable( );
mluis	0:45496a70a8a5	138	}
mluis	0:45496a70a8a5	139
mluis	0:45496a70a8a5	140	uint8_t GetChar( void )
mluis	0:45496a70a8a5	141	{
mluis	0:45496a70a8a5	142	return this->getc( );
mluis	0:45496a70a8a5	143	}
mluis	0:45496a70a8a5	144
mluis	0:45496a70a8a5	145	/*
mluis	0:45496a70a8a5	146	* RawSerial class implmentation copy.
mluis	0:45496a70a8a5	147	*/
mluis	0:45496a70a8a5	148	/** Read a char from the serial port
mluis	0:45496a70a8a5	149	*
mluis	0:45496a70a8a5	150	* @returns The char read from the serial port
mluis	0:45496a70a8a5	151	*/
mluis	0:45496a70a8a5	152	int getc( )
mluis	0:45496a70a8a5	153	{
mluis	6:0e8d45c5cbbc	154	return _base_getc( );
mluis	0:45496a70a8a5	155	}
mluis	0:45496a70a8a5	156
mluis	0:45496a70a8a5	157	/** Write a char to the serial port
mluis	0:45496a70a8a5	158	*
mluis	0:45496a70a8a5	159	* @param c The char to write
mluis	0:45496a70a8a5	160	*
mluis	0:45496a70a8a5	161	* @returns The written char or -1 if an error occured
mluis	0:45496a70a8a5	162	*/
mluis	0:45496a70a8a5	163	int putc( int c )
mluis	0:45496a70a8a5	164	{
mluis	0:45496a70a8a5	165	while( this->writeable( ) != 1 );
mluis	0:45496a70a8a5	166	return _base_putc( c );
mluis	0:45496a70a8a5	167	}
mluis	0:45496a70a8a5	168
mluis	0:45496a70a8a5	169	/** Write a string to the serial port
mluis	0:45496a70a8a5	170	*
mluis	0:45496a70a8a5	171	* @param str The string to write
mluis	0:45496a70a8a5	172	*
mluis	0:45496a70a8a5	173	* @returns 0 if the write succeeds, EOF for error
mluis	0:45496a70a8a5	174	*/
mluis	0:45496a70a8a5	175	int puts( const char *str )
mluis	0:45496a70a8a5	176	{
mluis	0:45496a70a8a5	177	while( *str )
mluis	0:45496a70a8a5	178	putc( *str++ );
mluis	0:45496a70a8a5	179	return 0;
mluis	0:45496a70a8a5	180	}
mluis	0:45496a70a8a5	181
mluis	0:45496a70a8a5	182	// Experimental support for printf in RawSerial. No Stream inheritance
mluis	0:45496a70a8a5	183	// means we can't call printf() directly, so we use sprintf() instead.
mluis	0:45496a70a8a5	184	// We only call malloc() for the sprintf() buffer if the buffer
mluis	0:45496a70a8a5	185	// length is above a certain threshold, otherwise we use just the stack.
mluis	0:45496a70a8a5	186	int printf( const char *format, ... )
mluis	0:45496a70a8a5	187	{
mluis	0:45496a70a8a5	188	std::va_list arg;
mluis	0:45496a70a8a5	189	va_start( arg, format );
mluis	0:45496a70a8a5	190	int len = vsnprintf( NULL, 0, format, arg );
mluis	0:45496a70a8a5	191	if( len < STRING_STACK_LIMIT )
mluis	0:45496a70a8a5	192	{
mluis	0:45496a70a8a5	193	char temp[STRING_STACK_LIMIT];
mluis	0:45496a70a8a5	194	vsprintf( temp, format, arg );
mluis	0:45496a70a8a5	195	puts( temp );
mluis	0:45496a70a8a5	196	}
mluis	0:45496a70a8a5	197	else
mluis	0:45496a70a8a5	198	{
mluis	0:45496a70a8a5	199	char *temp = new char[len + 1];
mluis	0:45496a70a8a5	200	vsprintf( temp, format, arg );
mluis	0:45496a70a8a5	201	puts( temp );
mluis	0:45496a70a8a5	202	delete[] temp;
mluis	0:45496a70a8a5	203	}
mluis	0:45496a70a8a5	204	va_end( arg );
mluis	0:45496a70a8a5	205	return len;
mluis	0:45496a70a8a5	206	}
mluis	0:45496a70a8a5	207
mluis	0:45496a70a8a5	208	private:
mluis	0:45496a70a8a5	209
mluis	0:45496a70a8a5	210	};
mluis	0:45496a70a8a5	211
mluis	0:45496a70a8a5	212	#endif // __VT100_H__

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	03 Dec 2015
Imports:	2121
Forks:	13
Commits:	8
Dependents:	0
Dependencies:	3
Followers:	148

Components

SX1272MB2xAS / SX1272MB2DAS