Uttam Bhat / Mbed 2 deprecated Training-Aug2018-SX1272-X-NUCLEO-IKS01A2

Create Application using SX1272 + X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 driver_mbed_TH02 mbed LoRaWAN-lib-v1_0_1 SX1272Lib

Fork of LoRaWAN-SX1272-Application-Demo by Semtech

LoRaWAN-NAMote72 Application Demo is a Class-A device example project using LoRaWAN-lib and SX1272Lib libraries.

Comissioning.h (LoRaWAN Network Configuration)

The end-device can be activated in one of the two ways:

Over the Air (OTA) activation can be enabled as shown in the figure below. /media/uploads/ubhat/ota_enable.png

The end-device must be configured with the following parameters:

  • LORAWAN_DEVICE_EUI (8 Bytes) : Fist 3 Bytes is the Organizationally Unique Identifier (OUI) followed by 5 bytes of unique ID. If not defined by user, then the firmware automatically assigns one to the end-device
  • LORAWAN_APPLICATION_EUI (8 Bytes)
  • LORAWAN_APPLICATION_KEY (or DEVKEY) (16 Bytes)

/media/uploads/ubhat/ota_eui.png

Activation by Personalization (ABP) can be enabled as shown in the figure below. /media/uploads/ubhat/abp_enable.png

The end-device must be configured with the following parameters:

  • LORAWAN_DEVICE_ADDRESS (4 Bytes) : If not defined by user, then the firmware automatically assigns one to the end-device
  • LORAWAN_NWKSKEY (16 Bytes)
  • LORAWAN_APPSKEY (16 Bytes)

/media/uploads/ubhat/abp_key.png

Config.h (LoRaWAN Communication Parameters)

  • Mode of Operation : Hybrid If the end-device needs to be configured to operate over 8-channels, then Hybrid Mode needs to be enabled /media/uploads/ubhat/hybridenable.png
  • Mode of Operation : Frequency Hop If the end-device needs to be configured to operate over 64-channels, then Hybrid Mode needs to be disabled
  • Delay between successive JOIN REQUESTs : The delay between successive Join Requests (until the end-device joins the network) can be configured using the parameter OVER_THE_AIR_ACTIVATION_DUTYCYCLE
  • Inter-Frame Delay : One can change the delay between each frame transmission using APP_TX_DUTYCYCLE It is advisable that APP_TX_DUTYCYCLE is greater than or equal to 3sec.
  • Data Rate : The data rate can be configured as per LoRaWAN specification using the paramter LORAWAN_DEFAULT_DATARATE. The range of values are DR_0, DR_1, DR_2, DR_3 and DR_4
  • Confirmed/Unconfirmed Messages : The uplink message or payload can be chosen to be confirmed or unconfirmed using the parameter LORAWAN_CONFIRMED_MSG_ON. When set to 1, the transmitted messages need to be confirmed with an ACK by the network server in the subsequent RX window. When set to 0, no ACK is requested.
  • ADR ON/OFF : The ADR can be enabled or disabled using the parameter LORAWAN_ADR_ON. When set to 1, ADR is enabled and disabled when set to 0.
  • Application Port : The application port can be set using parameter LORAWAN_APP_PORT.
  • Payload Length : The lenght of the payload (in bytes) to be transmitted can be configured using LORAWAN_APP_DATA_SIZE
  • Transmit Power : The transmit power can be configured using LORAWAN_TX_POWER (LoRaMAC verifies if the set power is compliant with the LoRaWAN spec and FCC guidelines)

/media/uploads/ubhat/loraconfig.png

Main.cpp (Device State Machine)

The end-device state machine is defined.

  • Initial State : Device is initialized.
  • Join State : For OTA, Join Request is transmitted to the network until Join Accept is received by the end-device. Join event function is called that sets Red LED ON.
  • Send State : Transmit payload frame is prepared. Tx event is called that blinks the Red LED indicating uplink transmission.
  • Cycle State : Next packet transmission is scheduled

LoRaEventProc.cpp (Events and On-board Application)

Define events during Join, Tx & Rx. Prepare TX packet by appending with appropriate application data.

/media/uploads/ubhat/lora_events.png

  • PrepareLoRaFrame(uint8_t port ) : Prepare LoRa payload frame with on-board application data such as GPS, Temperature, Battery, etc. LoRa.ApplicationCall(AppType ) calls application AppType defined in LoRaApp.cpp. AppType is defined in LoRaApp.h

/media/uploads/ubhat/lora_app.png

LoRaApp.cpp

User-defined applications such as GPS, Temp, Accelerometer, LED indications etc. Event based actions such as LED blink on Tx, LED toggle on downlink etc /media/uploads/ubhat/apptype.png

LoRaDeviceStateProc.cpp

Process function calls corresponding to different Device states /media/uploads/ubhat/device_state.png

LoRaMacLayerService.cpp

Define MAC Layer Services: MLME & MCPS

system/utilities.cpp@11:2707638f5915, 2018-08-19 (annotated)

Committer:
ubhat
Date:
Sun Aug 19 20:09:55 2018 +0000
Revision:
11:2707638f5915
Parent:
0:6cc76d70e2a1 
Create Application using SX1272 + X-NUCLEO-IKS01A2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:6cc76d70e2a1 1 /*
ubhat 0:6cc76d70e2a1 2 / _____) _ | |
ubhat 0:6cc76d70e2a1 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:6cc76d70e2a1 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:6cc76d70e2a1 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:6cc76d70e2a1 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:6cc76d70e2a1 7 (C)2013 Semtech
ubhat 0:6cc76d70e2a1 8
ubhat 0:6cc76d70e2a1 9 Description: Helper functions implementation
ubhat 0:6cc76d70e2a1 10
ubhat 0:6cc76d70e2a1 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:6cc76d70e2a1 12
ubhat 0:6cc76d70e2a1 13 Maintainer: Miguel Luis and Gregory Cristian
ubhat 0:6cc76d70e2a1 14 */
ubhat 0:6cc76d70e2a1 15 #include <stdlib.h>
ubhat 0:6cc76d70e2a1 16 #include <stdio.h>
ubhat 0:6cc76d70e2a1 17 #include "board.h"
ubhat 0:6cc76d70e2a1 18 #include "utilities.h"
ubhat 0:6cc76d70e2a1 19
ubhat 0:6cc76d70e2a1 20 /*!
ubhat 0:6cc76d70e2a1 21 * Redefinition of rand() and srand() standard C functions.
ubhat 0:6cc76d70e2a1 22 * These functions are redefined in order to get the same behavior across
ubhat 0:6cc76d70e2a1 23 * different compiler toolchains implementations.
ubhat 0:6cc76d70e2a1 24 */
ubhat 0:6cc76d70e2a1 25 // Standard random functions redefinition start
ubhat 0:6cc76d70e2a1 26 #define RAND_LOCAL_MAX 2147483647L
ubhat 0:6cc76d70e2a1 27
ubhat 0:6cc76d70e2a1 28 static uint32_t next = 1;
ubhat 0:6cc76d70e2a1 29
ubhat 0:6cc76d70e2a1 30 int32_t rand1( void )
ubhat 0:6cc76d70e2a1 31 {
ubhat 0:6cc76d70e2a1 32 return ( ( next = next * 1103515245L + 12345L ) % RAND_LOCAL_MAX );
ubhat 0:6cc76d70e2a1 33 }
ubhat 0:6cc76d70e2a1 34
ubhat 0:6cc76d70e2a1 35 void srand1( uint32_t seed )
ubhat 0:6cc76d70e2a1 36 {
ubhat 0:6cc76d70e2a1 37 next = seed;
ubhat 0:6cc76d70e2a1 38 }
ubhat 0:6cc76d70e2a1 39 // Standard random functions redefinition end
ubhat 0:6cc76d70e2a1 40
ubhat 0:6cc76d70e2a1 41 int32_t randr( int32_t min, int32_t max )
ubhat 0:6cc76d70e2a1 42 {
ubhat 0:6cc76d70e2a1 43 return ( int32_t )rand1( ) % ( max - min + 1 ) + min;
ubhat 0:6cc76d70e2a1 44 }
ubhat 0:6cc76d70e2a1 45
ubhat 0:6cc76d70e2a1 46 void memcpy1( uint8_t *dst, const uint8_t *src, uint16_t size )
ubhat 0:6cc76d70e2a1 47 {
ubhat 0:6cc76d70e2a1 48 while( size-- )
ubhat 0:6cc76d70e2a1 49 {
ubhat 0:6cc76d70e2a1 50 *dst++ = *src++;
ubhat 0:6cc76d70e2a1 51 }
ubhat 0:6cc76d70e2a1 52 }
ubhat 0:6cc76d70e2a1 53
ubhat 0:6cc76d70e2a1 54 void memcpyr( uint8_t *dst, const uint8_t *src, uint16_t size )
ubhat 0:6cc76d70e2a1 55 {
ubhat 0:6cc76d70e2a1 56 dst = dst + ( size - 1 );
ubhat 0:6cc76d70e2a1 57 while( size-- )
ubhat 0:6cc76d70e2a1 58 {
ubhat 0:6cc76d70e2a1 59 *dst-- = *src++;
ubhat 0:6cc76d70e2a1 60 }
ubhat 0:6cc76d70e2a1 61 }
ubhat 0:6cc76d70e2a1 62
ubhat 0:6cc76d70e2a1 63 void memset1( uint8_t *dst, uint8_t value, uint16_t size )
ubhat 0:6cc76d70e2a1 64 {
ubhat 0:6cc76d70e2a1 65 while( size-- )
ubhat 0:6cc76d70e2a1 66 {
ubhat 0:6cc76d70e2a1 67 *dst++ = value;
ubhat 0:6cc76d70e2a1 68 }
ubhat 0:6cc76d70e2a1 69 }
ubhat 0:6cc76d70e2a1 70
ubhat 0:6cc76d70e2a1 71 int8_t Nibble2HexChar( uint8_t a )
ubhat 0:6cc76d70e2a1 72 {
ubhat 0:6cc76d70e2a1 73 if( a < 10 )
ubhat 0:6cc76d70e2a1 74 {
ubhat 0:6cc76d70e2a1 75 return '0' + a;
ubhat 0:6cc76d70e2a1 76 }
ubhat 0:6cc76d70e2a1 77 else if( a < 16 )
ubhat 0:6cc76d70e2a1 78 {
ubhat 0:6cc76d70e2a1 79 return 'A' + ( a - 10 );
ubhat 0:6cc76d70e2a1 80 }
ubhat 0:6cc76d70e2a1 81 else
ubhat 0:6cc76d70e2a1 82 {
ubhat 0:6cc76d70e2a1 83 return '?';
ubhat 0:6cc76d70e2a1 84 }
ubhat 0:6cc76d70e2a1 85 }