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/crypto/cmac.h@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 Copyright (C) 2009 Lander Casado, Philippas Tsigas
ubhat 0:6cc76d70e2a1 3
ubhat 0:6cc76d70e2a1 4 All rights reserved.
ubhat 0:6cc76d70e2a1 5
ubhat 0:6cc76d70e2a1 6 Permission is hereby granted, free of charge, to any person obtaining
ubhat 0:6cc76d70e2a1 7 a copy of this software and associated documentation files
ubhat 0:6cc76d70e2a1 8 (the "Software"), to deal with the Software without restriction, including
ubhat 0:6cc76d70e2a1 9 without limitation the rights to use, copy, modify, merge, publish,
ubhat 0:6cc76d70e2a1 10 distribute, sublicense, and/or sell copies of the Software, and to
ubhat 0:6cc76d70e2a1 11 permit persons to whom the Software is furnished to do so, subject to
ubhat 0:6cc76d70e2a1 12 the following conditions:
ubhat 0:6cc76d70e2a1 13
ubhat 0:6cc76d70e2a1 14 Redistributions of source code must retain the above copyright notice,
ubhat 0:6cc76d70e2a1 15 this list of conditions and the following disclaimers. Redistributions in
ubhat 0:6cc76d70e2a1 16 binary form must reproduce the above copyright notice, this list of
ubhat 0:6cc76d70e2a1 17 conditions and the following disclaimers in the documentation and/or
ubhat 0:6cc76d70e2a1 18 other materials provided with the distribution.
ubhat 0:6cc76d70e2a1 19
ubhat 0:6cc76d70e2a1 20 In no event shall the authors or copyright holders be liable for any special,
ubhat 0:6cc76d70e2a1 21 incidental, indirect or consequential damages of any kind, or any damages
ubhat 0:6cc76d70e2a1 22 whatsoever resulting from loss of use, data or profits, whether or not
ubhat 0:6cc76d70e2a1 23 advised of the possibility of damage, and on any theory of liability,
ubhat 0:6cc76d70e2a1 24 arising out of or in connection with the use or performance of this software.
ubhat 0:6cc76d70e2a1 25
ubhat 0:6cc76d70e2a1 26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
ubhat 0:6cc76d70e2a1 27 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ubhat 0:6cc76d70e2a1 28 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ubhat 0:6cc76d70e2a1 29 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ubhat 0:6cc76d70e2a1 30 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
ubhat 0:6cc76d70e2a1 31 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
ubhat 0:6cc76d70e2a1 32 DEALINGS WITH THE SOFTWARE
ubhat 0:6cc76d70e2a1 33
ubhat 0:6cc76d70e2a1 34 *****************************************************************************/
ubhat 0:6cc76d70e2a1 35
ubhat 0:6cc76d70e2a1 36 #ifndef _CMAC_H_
ubhat 0:6cc76d70e2a1 37 #define _CMAC_H_
ubhat 0:6cc76d70e2a1 38
ubhat 0:6cc76d70e2a1 39 #include "aes.h"
ubhat 0:6cc76d70e2a1 40
ubhat 0:6cc76d70e2a1 41 #define AES_CMAC_KEY_LENGTH 16
ubhat 0:6cc76d70e2a1 42 #define AES_CMAC_DIGEST_LENGTH 16
ubhat 0:6cc76d70e2a1 43
ubhat 0:6cc76d70e2a1 44 typedef struct _AES_CMAC_CTX {
ubhat 0:6cc76d70e2a1 45 aes_context rijndael;
ubhat 0:6cc76d70e2a1 46 uint8_t X[16];
ubhat 0:6cc76d70e2a1 47 uint8_t M_last[16];
ubhat 0:6cc76d70e2a1 48 uint32_t M_n;
ubhat 0:6cc76d70e2a1 49 } AES_CMAC_CTX;
ubhat 0:6cc76d70e2a1 50
ubhat 0:6cc76d70e2a1 51 //#include <sys/cdefs.h>
ubhat 0:6cc76d70e2a1 52
ubhat 0:6cc76d70e2a1 53 //__BEGIN_DECLS
ubhat 0:6cc76d70e2a1 54 void AES_CMAC_Init(AES_CMAC_CTX * ctx);
ubhat 0:6cc76d70e2a1 55 void AES_CMAC_SetKey(AES_CMAC_CTX * ctx, const uint8_t key[AES_CMAC_KEY_LENGTH]);
ubhat 0:6cc76d70e2a1 56 void AES_CMAC_Update(AES_CMAC_CTX * ctx, const uint8_t * data, uint32_t len);
ubhat 0:6cc76d70e2a1 57 // __attribute__((__bounded__(__string__,2,3)));
ubhat 0:6cc76d70e2a1 58 void AES_CMAC_Final(uint8_t digest[AES_CMAC_DIGEST_LENGTH], AES_CMAC_CTX * ctx);
ubhat 0:6cc76d70e2a1 59 // __attribute__((__bounded__(__minbytes__,1,AES_CMAC_DIGEST_LENGTH)));
ubhat 0:6cc76d70e2a1 60 //__END_DECLS
ubhat 0:6cc76d70e2a1 61
ubhat 0:6cc76d70e2a1 62 #endif /* _CMAC_H_ */
ubhat 0:6cc76d70e2a1 63