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

system/crypto/cmac.cpp@7:5077515c163b, 2017-04-24 (annotated)

Committer:: mluis
Date:: Mon Apr 24 13:29:34 2017 +0000
Revision:: 7:5077515c163b
Parent:: 3:3152aa75c58d

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	Copyright (C) 2009 Lander Casado, Philippas Tsigas
mluis	0:45496a70a8a5	3
mluis	0:45496a70a8a5	4	All rights reserved.
mluis	0:45496a70a8a5	5
mluis	0:45496a70a8a5	6	Permission is hereby granted, free of charge, to any person obtaining
mluis	0:45496a70a8a5	7	a copy of this software and associated documentation files
mluis	0:45496a70a8a5	8	(the "Software"), to deal with the Software without restriction, including
mluis	0:45496a70a8a5	9	without limitation the rights to use, copy, modify, merge, publish,
mluis	0:45496a70a8a5	10	distribute, sublicense, and/or sell copies of the Software, and to
mluis	0:45496a70a8a5	11	permit persons to whom the Software is furnished to do so, subject to
mluis	0:45496a70a8a5	12	the following conditions:
mluis	0:45496a70a8a5	13
mluis	0:45496a70a8a5	14	Redistributions of source code must retain the above copyright notice,
mluis	0:45496a70a8a5	15	this list of conditions and the following disclaimers. Redistributions in
mluis	0:45496a70a8a5	16	binary form must reproduce the above copyright notice, this list of
mluis	0:45496a70a8a5	17	conditions and the following disclaimers in the documentation and/or
mluis	0:45496a70a8a5	18	other materials provided with the distribution.
mluis	0:45496a70a8a5	19
mluis	0:45496a70a8a5	20	In no event shall the authors or copyright holders be liable for any special,
mluis	0:45496a70a8a5	21	incidental, indirect or consequential damages of any kind, or any damages
mluis	0:45496a70a8a5	22	whatsoever resulting from loss of use, data or profits, whether or not
mluis	0:45496a70a8a5	23	advised of the possibility of damage, and on any theory of liability,
mluis	0:45496a70a8a5	24	arising out of or in connection with the use or performance of this software.
mluis	0:45496a70a8a5	25
mluis	0:45496a70a8a5	26	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
mluis	0:45496a70a8a5	27	OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mluis	0:45496a70a8a5	28	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mluis	0:45496a70a8a5	29	CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mluis	0:45496a70a8a5	30	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
mluis	0:45496a70a8a5	31	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
mluis	0:45496a70a8a5	32	DEALINGS WITH THE SOFTWARE
mluis	0:45496a70a8a5	33
mluis	0:45496a70a8a5	34	*****************************************************************************/
mluis	0:45496a70a8a5	35	//#include <sys/param.h>
mluis	0:45496a70a8a5	36	//#include <sys/systm.h>
mluis	0:45496a70a8a5	37	#include <stdint.h>
mluis	0:45496a70a8a5	38	#include "aes.h"
mluis	0:45496a70a8a5	39	#include "cmac.h"
mluis	0:45496a70a8a5	40	#include "utilities.h"
mluis	0:45496a70a8a5	41
mluis	0:45496a70a8a5	42	#define LSHIFT(v, r) do { \
mluis	0:45496a70a8a5	43	int32_t i; \
mluis	0:45496a70a8a5	44	for (i = 0; i < 15; i++) \
mluis	0:45496a70a8a5	45	(r)[i] = (v)[i] << 1 \| (v)[i + 1] >> 7; \
mluis	0:45496a70a8a5	46	(r)[15] = (v)[15] << 1; \
mluis	0:45496a70a8a5	47	} while (0)
mluis	0:45496a70a8a5	48
mluis	0:45496a70a8a5	49	#define XOR(v, r) do { \
mluis	0:45496a70a8a5	50	int32_t i; \
mluis	0:45496a70a8a5	51	for (i = 0; i < 16; i++) \
mluis	0:45496a70a8a5	52	{ \
mluis	0:45496a70a8a5	53	(r)[i] = (r)[i] ^ (v)[i]; \
mluis	0:45496a70a8a5	54	} \
mluis	0:45496a70a8a5	55	} while (0) \
mluis	0:45496a70a8a5	56
mluis	0:45496a70a8a5	57
mluis	0:45496a70a8a5	58	void AES_CMAC_Init(AES_CMAC_CTX *ctx)
mluis	0:45496a70a8a5	59	{
mluis	0:45496a70a8a5	60	memset1(ctx->X, 0, sizeof ctx->X);
mluis	0:45496a70a8a5	61	ctx->M_n = 0;
mluis	0:45496a70a8a5	62	memset1(ctx->rijndael.ksch, '\0', 240);
mluis	0:45496a70a8a5	63	}
mluis	0:45496a70a8a5	64
mluis	0:45496a70a8a5	65	void AES_CMAC_SetKey(AES_CMAC_CTX *ctx, const uint8_t key[AES_CMAC_KEY_LENGTH])
mluis	0:45496a70a8a5	66	{
mluis	0:45496a70a8a5	67	//rijndael_set_key_enc_only(&ctx->rijndael, key, 128);
mluis	0:45496a70a8a5	68	aes_set_key( key, AES_CMAC_KEY_LENGTH, &ctx->rijndael);
mluis	0:45496a70a8a5	69	}
mluis	0:45496a70a8a5	70
mluis	0:45496a70a8a5	71	void AES_CMAC_Update(AES_CMAC_CTX ctx, const uint8_t data, uint32_t len)
mluis	0:45496a70a8a5	72	{
mluis	0:45496a70a8a5	73	uint32_t mlen;
mluis	0:45496a70a8a5	74	uint8_t in[16];
mluis	0:45496a70a8a5	75
mluis	0:45496a70a8a5	76	if (ctx->M_n > 0) {
mluis	0:45496a70a8a5	77	mlen = MIN(16 - ctx->M_n, len);
mluis	0:45496a70a8a5	78	memcpy1(ctx->M_last + ctx->M_n, data, mlen);
mluis	0:45496a70a8a5	79	ctx->M_n += mlen;
mluis	0:45496a70a8a5	80	if (ctx->M_n < 16 \|\| len == mlen)
mluis	0:45496a70a8a5	81	return;
mluis	0:45496a70a8a5	82	XOR(ctx->M_last, ctx->X);
mluis	0:45496a70a8a5	83	//rijndael_encrypt(&ctx->rijndael, ctx->X, ctx->X);
mluis	0:45496a70a8a5	84	aes_encrypt( ctx->X, ctx->X, &ctx->rijndael);
mluis	0:45496a70a8a5	85	data += mlen;
mluis	0:45496a70a8a5	86	len -= mlen;
mluis	0:45496a70a8a5	87	}
mluis	0:45496a70a8a5	88	while (len > 16) { /* not last block */
mluis	3:3152aa75c58d	89
mluis	0:45496a70a8a5	90	XOR(data, ctx->X);
mluis	0:45496a70a8a5	91	//rijndael_encrypt(&ctx->rijndael, ctx->X, ctx->X);
mluis	0:45496a70a8a5	92
mluis	0:45496a70a8a5	93	memcpy1(in, &ctx->X[0], 16); //Bestela ez du ondo iten
mluis	0:45496a70a8a5	94	aes_encrypt( in, in, &ctx->rijndael);
mluis	0:45496a70a8a5	95	memcpy1(&ctx->X[0], in, 16);
mluis	0:45496a70a8a5	96
mluis	0:45496a70a8a5	97	data += 16;
mluis	0:45496a70a8a5	98	len -= 16;
mluis	0:45496a70a8a5	99	}
mluis	0:45496a70a8a5	100	/* potential last block, save it */
mluis	0:45496a70a8a5	101	memcpy1(ctx->M_last, data, len);
mluis	0:45496a70a8a5	102	ctx->M_n = len;
mluis	0:45496a70a8a5	103	}
mluis	0:45496a70a8a5	104
mluis	0:45496a70a8a5	105	void AES_CMAC_Final(uint8_t digest[AES_CMAC_DIGEST_LENGTH], AES_CMAC_CTX *ctx)
mluis	0:45496a70a8a5	106	{
mluis	0:45496a70a8a5	107	uint8_t K[16];
mluis	0:45496a70a8a5	108	uint8_t in[16];
mluis	0:45496a70a8a5	109	/* generate subkey K1 */
mluis	0:45496a70a8a5	110	memset1(K, '\0', 16);
mluis	0:45496a70a8a5	111
mluis	0:45496a70a8a5	112	//rijndael_encrypt(&ctx->rijndael, K, K);
mluis	0:45496a70a8a5	113
mluis	0:45496a70a8a5	114	aes_encrypt( K, K, &ctx->rijndael);
mluis	0:45496a70a8a5	115
mluis	0:45496a70a8a5	116	if (K[0] & 0x80) {
mluis	0:45496a70a8a5	117	LSHIFT(K, K);
mluis	0:45496a70a8a5	118	K[15] ^= 0x87;
mluis	0:45496a70a8a5	119	} else
mluis	0:45496a70a8a5	120	LSHIFT(K, K);
mluis	0:45496a70a8a5	121
mluis	3:3152aa75c58d	122
mluis	0:45496a70a8a5	123	if (ctx->M_n == 16) {
mluis	0:45496a70a8a5	124	/* last block was a complete block */
mluis	0:45496a70a8a5	125	XOR(K, ctx->M_last);
mluis	0:45496a70a8a5	126
mluis	0:45496a70a8a5	127	} else {
mluis	0:45496a70a8a5	128	/* generate subkey K2 */
mluis	0:45496a70a8a5	129	if (K[0] & 0x80) {
mluis	0:45496a70a8a5	130	LSHIFT(K, K);
mluis	0:45496a70a8a5	131	K[15] ^= 0x87;
mluis	0:45496a70a8a5	132	} else
mluis	0:45496a70a8a5	133	LSHIFT(K, K);
mluis	0:45496a70a8a5	134
mluis	0:45496a70a8a5	135	/* padding(M_last) */
mluis	0:45496a70a8a5	136	ctx->M_last[ctx->M_n] = 0x80;
mluis	0:45496a70a8a5	137	while (++ctx->M_n < 16)
mluis	0:45496a70a8a5	138	ctx->M_last[ctx->M_n] = 0;
mluis	0:45496a70a8a5	139
mluis	0:45496a70a8a5	140	XOR(K, ctx->M_last);
mluis	3:3152aa75c58d	141
mluis	3:3152aa75c58d	142
mluis	0:45496a70a8a5	143	}
mluis	0:45496a70a8a5	144	XOR(ctx->M_last, ctx->X);
mluis	3:3152aa75c58d	145
mluis	0:45496a70a8a5	146	//rijndael_encrypt(&ctx->rijndael, ctx->X, digest);
mluis	3:3152aa75c58d	147
mluis	0:45496a70a8a5	148	memcpy1(in, &ctx->X[0], 16); //Bestela ez du ondo iten
mluis	0:45496a70a8a5	149	aes_encrypt(in, digest, &ctx->rijndael);
mluis	0:45496a70a8a5	150	memset1(K, 0, sizeof K);
mluis	0:45496a70a8a5	151
mluis	0:45496a70a8a5	152	}
mluis	0:45496a70a8a5	153

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