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

Semtech » Code » LoRaWAN-demo-76

Semtech / Mbed 2 deprecated LoRaWAN-demo-76

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..."

/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@9:ee9dcbb9708d, 2017-04-24 (annotated)

Committer:: mluis
Date:: Mon Apr 24 13:38:31 2017 +0000
Revision:: 9:ee9dcbb9708d
Parent:: 5:1e9f6a365854

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	28 Sep 2015
Imports:	2357
Forks:	4
Commits:	10
Dependents:	1
Dependencies:	3
Followers:	151

Quote:

system/crypto/cmac.cpp@9:ee9dcbb9708d, 2017-04-24 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning