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

app/vt100.h@0:8e36e3d5d706, 2016-01-07 (annotated)

Committer:: mluis
Date:: Thu Jan 07 15:19:23 2016 +0000
Revision:: 0:8e36e3d5d706
Child:: 8:33e4503d4370

Initial commit

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

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:

app/vt100.h@0:8e36e3d5d706, 2016-01-07 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning