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:
13:6b6f4be13633
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: End device communication parameters
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
ubhat 0:69f2e28d12c1 16 #ifndef __LORA_CONFIG_H__
ubhat 0:69f2e28d12c1 17 #define __LORA_CONFIG_H__
ubhat 0:69f2e28d12c1 18
ubhat 0:69f2e28d12c1 19 /*!
ubhat 0:69f2e28d12c1 20 * Configure End-Device to use 8-channels corresponding to Block A
ubhat 0:69f2e28d12c1 21 * Comment/Uncomment to disable/enable Hybrid mode
ubhat 0:69f2e28d12c1 22 */
mluis 18:18408c3c2d0c 23 // #define USE_BAND_915_HYBRID
ubhat 0:69f2e28d12c1 24
ubhat 0:69f2e28d12c1 25 #ifndef USE_BAND_915_HYBRID
ubhat 0:69f2e28d12c1 26 /*!
ubhat 0:69f2e28d12c1 27 * Configure End-Device to use 64-channels across to Block A thru Block H
ubhat 0:69f2e28d12c1 28 */
ubhat 0:69f2e28d12c1 29 #define USE_BAND_915
ubhat 0:69f2e28d12c1 30
ubhat 0:69f2e28d12c1 31 #endif
ubhat 0:69f2e28d12c1 32
ubhat 0:69f2e28d12c1 33 /*!
ubhat 6:f8194e691dd4 34 * Defines the application data transmission periodicity. It is the time between RX1/RX2 and next TX
ubhat 6:f8194e691dd4 35 */
mluis 18:18408c3c2d0c 36 #define APP_TX_DUTYCYCLE 5000 // value in ms
ubhat 6:f8194e691dd4 37
ubhat 6:f8194e691dd4 38 /*!
ubhat 0:69f2e28d12c1 39 * LoRaWAN confirmed messages
ubhat 0:69f2e28d12c1 40 * \remark 1 : Confirmed messages enabled. Must receive ACK from network server
ubhat 0:69f2e28d12c1 41 0 : Confirmed messages disabled.
ubhat 0:69f2e28d12c1 42 */
ubhat 0:69f2e28d12c1 43 #define LORAWAN_CONFIRMED_MSG_ON 1
ubhat 0:69f2e28d12c1 44
ubhat 0:69f2e28d12c1 45 /*!
ubhat 0:69f2e28d12c1 46 * LoRaWAN Adaptive Data Rate
ubhat 0:69f2e28d12c1 47 *
ubhat 0:69f2e28d12c1 48 * \remark Please note that when ADR is enabled the end-device uses default datarate of DR_0
ubhat 0:69f2e28d12c1 49 */
mluis 18:18408c3c2d0c 50 #define LORAWAN_ADR_ON 1
ubhat 0:69f2e28d12c1 51
ubhat 0:69f2e28d12c1 52 /*!
ubhat 6:f8194e691dd4 53 * Default mote datarate
ubhat 6:f8194e691dd4 54 * \remark DR_0 : 980 bps; DR_1 : 1760 bps; DR_2 : 3125 bps; DR_3 : 5470 bps; DR_4 : 12500 bps
ubhat 6:f8194e691dd4 55 */
ubhat 6:f8194e691dd4 56 #define LORAWAN_DEFAULT_DATARATE DR_0
ubhat 6:f8194e691dd4 57
ubhat 6:f8194e691dd4 58 /*!
ubhat 0:69f2e28d12c1 59 * LoRaWAN application port
ubhat 0:69f2e28d12c1 60 */
ubhat 6:f8194e691dd4 61 #define LORAWAN_APP_PORT 5
ubhat 0:69f2e28d12c1 62
ubhat 0:69f2e28d12c1 63 /*!
ubhat 0:69f2e28d12c1 64 * LoRaWAN User defined Tx Power
ubhat 0:69f2e28d12c1 65 *
ubhat 0:69f2e28d12c1 66 * \remark The Tx power level is set as TX_POWER_P_DBM, where 10 <= P <= 30 and P is even value { i.e. P = 10, 12, 14 ... 28 or 30 }
ubhat 0:69f2e28d12c1 67 */
ubhat 0:69f2e28d12c1 68 #define LORAWAN_TX_POWER TX_POWER_20_DBM
ubhat 0:69f2e28d12c1 69
ubhat 8:14521932100a 70 #if ( LORAWAN_APP_PORT == 5 )
ubhat 5:6ffeac53b7cb 71 /*====================================================
ubhat 5:6ffeac53b7cb 72 US01 GPS APPLICATION DEMO (PORT 5)
ubhat 5:6ffeac53b7cb 73 ====================================================*/
ubhat 5:6ffeac53b7cb 74
ubhat 5:6ffeac53b7cb 75 /*!
ubhat 5:6ffeac53b7cb 76 * User application data buffer size
ubhat 5:6ffeac53b7cb 77 */
ubhat 5:6ffeac53b7cb 78 #define LORAWAN_APP_DATA_SIZE 11
ubhat 5:6ffeac53b7cb 79
ubhat 5:6ffeac53b7cb 80 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 5:6ffeac53b7cb 81
ubhat 8:14521932100a 82 #elif ( LORAWAN_APP_PORT == 6 )
ubhat 5:6ffeac53b7cb 83 /*====================================================
ubhat 5:6ffeac53b7cb 84 SENET M2X DEMO (PORT 6)
ubhat 5:6ffeac53b7cb 85 ====================================================*/
ubhat 5:6ffeac53b7cb 86
ubhat 5:6ffeac53b7cb 87 /*!
ubhat 5:6ffeac53b7cb 88 * User application data buffer size
ubhat 5:6ffeac53b7cb 89 */
ubhat 5:6ffeac53b7cb 90 #define LORAWAN_APP_DATA_SIZE 2
ubhat 5:6ffeac53b7cb 91
ubhat 5:6ffeac53b7cb 92 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 5:6ffeac53b7cb 93
ubhat 8:14521932100a 94 #elif ( LORAWAN_APP_PORT == 7 )
ubhat 5:6ffeac53b7cb 95 /*====================================================
ubhat 5:6ffeac53b7cb 96 SENET GPS DEMO (PORT 7)
ubhat 5:6ffeac53b7cb 97 ====================================================*/
ubhat 5:6ffeac53b7cb 98
ubhat 5:6ffeac53b7cb 99 /*!
ubhat 6:f8194e691dd4 100 * User application data buffer size
ubhat 5:6ffeac53b7cb 101 */
ubhat 6:f8194e691dd4 102 #define LORAWAN_APP_DATA_SIZE 11
ubhat 5:6ffeac53b7cb 103
ubhat 6:f8194e691dd4 104 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 6:f8194e691dd4 105
ubhat 8:14521932100a 106 #elif ( LORAWAN_APP_PORT == 11 )
ubhat 6:f8194e691dd4 107 /*====================================================
ubhat 6:f8194e691dd4 108 PUSH BUTTON DEMO (PORT 11)
ubhat 6:f8194e691dd4 109 ====================================================*/
ubhat 5:6ffeac53b7cb 110
ubhat 5:6ffeac53b7cb 111 /*!
ubhat 5:6ffeac53b7cb 112 * User application data buffer size
ubhat 5:6ffeac53b7cb 113 */
ubhat 6:f8194e691dd4 114 #define LORAWAN_APP_DATA_SIZE 2
ubhat 6:f8194e691dd4 115
ubhat 6:f8194e691dd4 116 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 5:6ffeac53b7cb 117
ubhat 8:14521932100a 118 #elif ( LORAWAN_APP_PORT == 12 )
ubhat 7:92f4f419f91f 119 /*====================================================
ubhat 7:92f4f419f91f 120 TRANSMIT ON VERTICAL ORIENTATION DEMO (PORT 12)
ubhat 7:92f4f419f91f 121 ====================================================*/
ubhat 7:92f4f419f91f 122
ubhat 7:92f4f419f91f 123 /*!
ubhat 7:92f4f419f91f 124 * User application data buffer size
ubhat 7:92f4f419f91f 125 */
ubhat 7:92f4f419f91f 126 #define LORAWAN_APP_DATA_SIZE 2
ubhat 7:92f4f419f91f 127
ubhat 7:92f4f419f91f 128 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
ubhat 7:92f4f419f91f 129
ubhat 7:92f4f419f91f 130
ubhat 5:6ffeac53b7cb 131 #endif
ubhat 5:6ffeac53b7cb 132
ubhat 5:6ffeac53b7cb 133 #endif // __LORA_CONFIG_H__