Demonstration of Class-A LoRaWAN device using NAMote-72

Dependencies:   LoRaWAN-lib mbed lib_mpl3115a2 lib_mma8451q lib_gps SX1272Lib

Dependents:   LoRaWAN-NAMote72-BVS-confirmed-tester-0-7v1_copy

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

This project is compliant with LoRaWAN V1.0.1 specification.

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

Serial Terminal Display

By using a serial port connection using applications such as teraterm or putty, one can view the status of the End-Device. Once the End-Device Joins the network, transmission parameters such as payload data, application port, message type etc. are displayed on the terminal.

/media/uploads/ubhat/serial.png

Default Application Payload

This application defaults to sending uplink data to logical port 5. The application payload consists of: /media/uploads/jknapp_smtc/payload.png

Sample Application Payload Calculation for Longitude/Latitude

Payload => 00 19 F6 352BBA A94C20 FFFF

Temperature Calculation

19H => 2510

Temp = 25/2 = 12.5 oC

Battery Level

FFH => 100 %

F6H => 96.5 %

Longitude Calculation

longitude = A94C20H => 1109507210

longitudinal coordinate = -360 + (longitude10 x 180/(223))

longitudinal coordinate = -121.93

Latitude Calculation

latitude = 352BBAH = 348460210

latitude coordinate = (latitude10 x 90/(223-1))

latitude coordinate = 37.39

Committer:
mluis
Date:
Mon Apr 24 13:47:27 2017 +0000
Revision:
18:18408c3c2d0c
Parent:
9:617844f7fdb1
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?

UserRevisionLine numberNew contents of line
ubhat 0:69f2e28d12c1 1 /*
ubhat 0:69f2e28d12c1 2 / _____) _ | |
ubhat 0:69f2e28d12c1 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:69f2e28d12c1 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:69f2e28d12c1 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:69f2e28d12c1 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:69f2e28d12c1 7 (C)2015 Semtech
ubhat 0:69f2e28d12c1 8
ubhat 0:69f2e28d12c1 9 Description: Extern declaration of parameters defined in main.cpp
ubhat 0:69f2e28d12c1 10
ubhat 0:69f2e28d12c1 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:69f2e28d12c1 12
ubhat 0:69f2e28d12c1 13 Maintainer: Uttam Bhat
ubhat 0:69f2e28d12c1 14 */
ubhat 0:69f2e28d12c1 15 #ifndef __COMMON_H__
ubhat 0:69f2e28d12c1 16 #define __COMMON_H__
ubhat 0:69f2e28d12c1 17
mluis 18:18408c3c2d0c 18 #include "Commissioning.h"
ubhat 0:69f2e28d12c1 19 #include "board.h"
ubhat 0:69f2e28d12c1 20
ubhat 0:69f2e28d12c1 21 /*!
ubhat 0:69f2e28d12c1 22 * User application data buffer size
ubhat 0:69f2e28d12c1 23 */
mluis 18:18408c3c2d0c 24 #define LORAWAN_APP_DATA_MAX_SIZE 242
ubhat 0:69f2e28d12c1 25
ubhat 9:617844f7fdb1 26 /*!
ubhat 9:617844f7fdb1 27 * Current network ID
ubhat 9:617844f7fdb1 28 */
ubhat 9:617844f7fdb1 29 #define LORAWAN_NETWORK_ID ( uint32_t )0
ubhat 9:617844f7fdb1 30
mluis 18:18408c3c2d0c 31 /*
mluis 18:18408c3c2d0c 32 * Indicates if the end-device is currently activated by OTAA procedure.
mluis 18:18408c3c2d0c 33 */
mluis 18:18408c3c2d0c 34 extern bool Otaa;
ubhat 0:69f2e28d12c1 35
ubhat 0:69f2e28d12c1 36 /*!
ubhat 0:69f2e28d12c1 37 * Over the Air Activation
ubhat 0:69f2e28d12c1 38 */
ubhat 0:69f2e28d12c1 39
ubhat 0:69f2e28d12c1 40 extern uint8_t DevEui[];
ubhat 0:69f2e28d12c1 41 extern uint8_t AppEui[];
ubhat 0:69f2e28d12c1 42 extern uint8_t AppKey[];
ubhat 0:69f2e28d12c1 43
mluis 18:18408c3c2d0c 44 #if( OVER_THE_AIR_ACTIVATION == 0 )
ubhat 0:69f2e28d12c1 45 /*!
ubhat 0:69f2e28d12c1 46 * Activation by Personalization
ubhat 0:69f2e28d12c1 47 */
ubhat 0:69f2e28d12c1 48
ubhat 0:69f2e28d12c1 49 extern uint8_t NwkSKey[];
ubhat 0:69f2e28d12c1 50 extern uint8_t AppSKey[];
ubhat 0:69f2e28d12c1 51 extern uint32_t DevAddr;
ubhat 0:69f2e28d12c1 52
ubhat 0:69f2e28d12c1 53 #endif
ubhat 0:69f2e28d12c1 54
ubhat 0:69f2e28d12c1 55 extern uint8_t AppData[LORAWAN_APP_DATA_MAX_SIZE]; // User application data size
ubhat 0:69f2e28d12c1 56
ubhat 0:69f2e28d12c1 57 extern uint8_t AppPort; // Application port
ubhat 0:69f2e28d12c1 58
ubhat 0:69f2e28d12c1 59 extern uint8_t AppDataSize; // Application size
ubhat 0:69f2e28d12c1 60
ubhat 0:69f2e28d12c1 61 extern uint8_t IsTxConfirmed; // Indicates if the node is sending confirmed or unconfirmed messages
ubhat 0:69f2e28d12c1 62
ubhat 5:6ffeac53b7cb 63 extern bool IsTxIntUpdate; // Indicates if a new transmit interrupt can be set
ubhat 5:6ffeac53b7cb 64
ubhat 0:69f2e28d12c1 65 extern bool NextTx; // Indicates if a new packet can be sent
ubhat 0:69f2e28d12c1 66
ubhat 0:69f2e28d12c1 67 extern bool IsNetworkJoinedStatusUpdate; // Indicates if the MAC layer network join status has changed.
ubhat 0:69f2e28d12c1 68
ubhat 0:69f2e28d12c1 69 extern bool IsTxUpdate; // Indicates if the message sent
ubhat 0:69f2e28d12c1 70
ubhat 0:69f2e28d12c1 71 extern bool IsRxUpdate; // Indicates if the message received in the RX window.
ubhat 0:69f2e28d12c1 72
ubhat 0:69f2e28d12c1 73 extern TimerEvent_t TxNextPacketTimer; // Timer to handle the application data transmission duty cycle
ubhat 0:69f2e28d12c1 74
mluis 18:18408c3c2d0c 75 #endif // __COMMON_H__