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:
5:6ffeac53b7cb
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: Process function calls from various Device states
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 __LORA_DEVICE_STATE_H__
ubhat 0:69f2e28d12c1 16 #define __LORA_DEVICE_STATE_H__
ubhat 0:69f2e28d12c1 17
ubhat 0:69f2e28d12c1 18 #include "Common.h"
ubhat 0:69f2e28d12c1 19 #include "board.h"
ubhat 0:69f2e28d12c1 20 #include "LoRaMac.h"
ubhat 0:69f2e28d12c1 21 #include "LoRaEventProc.h"
ubhat 0:69f2e28d12c1 22 #include "SerialDisplay.h"
ubhat 0:69f2e28d12c1 23 #include "mbed.h"
ubhat 0:69f2e28d12c1 24 #include "LoRaMacLayerService.h"
ubhat 0:69f2e28d12c1 25
ubhat 0:69f2e28d12c1 26 /*!
ubhat 0:69f2e28d12c1 27 * Strucure containing the Uplink status
ubhat 0:69f2e28d12c1 28 */
ubhat 0:69f2e28d12c1 29 struct sLoRaMacUplinkStatus
ubhat 0:69f2e28d12c1 30 {
ubhat 0:69f2e28d12c1 31 /*!
ubhat 0:69f2e28d12c1 32 * MCPS-Request type
ubhat 0:69f2e28d12c1 33 */
mluis 18:18408c3c2d0c 34 Mcps_t Type;
ubhat 0:69f2e28d12c1 35 uint8_t Acked;
ubhat 0:69f2e28d12c1 36 int8_t Datarate;
ubhat 0:69f2e28d12c1 37 uint16_t UplinkCounter;
ubhat 0:69f2e28d12c1 38 uint8_t Port;
ubhat 0:69f2e28d12c1 39 uint8_t *Buffer;
ubhat 0:69f2e28d12c1 40 uint8_t BufferSize;
ubhat 0:69f2e28d12c1 41 int8_t TxPower;
mluis 18:18408c3c2d0c 42 uint32_t UpLinkFrequency;
ubhat 0:69f2e28d12c1 43 };
ubhat 0:69f2e28d12c1 44
ubhat 0:69f2e28d12c1 45 /*!
ubhat 0:69f2e28d12c1 46 * Strucure containing the Downlink status
ubhat 0:69f2e28d12c1 47 */
ubhat 0:69f2e28d12c1 48 struct sLoRaMacDownlinkStatus
ubhat 0:69f2e28d12c1 49 {
ubhat 0:69f2e28d12c1 50 int16_t Rssi;
ubhat 0:69f2e28d12c1 51 int8_t Snr;
ubhat 0:69f2e28d12c1 52 uint16_t DownlinkCounter;
ubhat 0:69f2e28d12c1 53 bool RxData;
ubhat 0:69f2e28d12c1 54 uint8_t Port;
ubhat 0:69f2e28d12c1 55 uint8_t *Buffer;
ubhat 0:69f2e28d12c1 56 uint8_t BufferSize;
ubhat 0:69f2e28d12c1 57 uint8_t RxSlot;
ubhat 0:69f2e28d12c1 58 };
ubhat 0:69f2e28d12c1 59
ubhat 0:69f2e28d12c1 60 /*!
mluis 18:18408c3c2d0c 61 * Structure containing OTAA Join status
mluis 18:18408c3c2d0c 62 */
mluis 18:18408c3c2d0c 63 struct sLoRaMacJoinStatus
mluis 18:18408c3c2d0c 64 {
mluis 18:18408c3c2d0c 65 int8_t LastDatarate;
mluis 18:18408c3c2d0c 66 int8_t Status;
mluis 18:18408c3c2d0c 67 };
mluis 18:18408c3c2d0c 68
mluis 18:18408c3c2d0c 69 /*!
ubhat 0:69f2e28d12c1 70 * Device states
ubhat 0:69f2e28d12c1 71 */
ubhat 0:69f2e28d12c1 72 enum eDevicState
ubhat 0:69f2e28d12c1 73 {
ubhat 0:69f2e28d12c1 74 DEVICE_STATE_INIT,
ubhat 0:69f2e28d12c1 75 DEVICE_STATE_JOIN,
ubhat 0:69f2e28d12c1 76 DEVICE_STATE_SEND,
ubhat 0:69f2e28d12c1 77 DEVICE_STATE_SLEEP
ubhat 0:69f2e28d12c1 78 };
ubhat 0:69f2e28d12c1 79
ubhat 0:69f2e28d12c1 80 extern sLoRaMacUplinkStatus LoRaMacUplinkStatus;
ubhat 0:69f2e28d12c1 81
ubhat 0:69f2e28d12c1 82 extern sLoRaMacDownlinkStatus LoRaMacDownlinkStatus;
ubhat 0:69f2e28d12c1 83
ubhat 0:69f2e28d12c1 84 extern eDevicState DeviceState;
ubhat 0:69f2e28d12c1 85
mluis 18:18408c3c2d0c 86 extern sLoRaMacJoinStatus LoRaMacJoinStatus;
mluis 18:18408c3c2d0c 87
ubhat 0:69f2e28d12c1 88 /*!
ubhat 0:69f2e28d12c1 89 * \brief Initialize Device: Timer, MAC Services, MAC
ubhat 0:69f2e28d12c1 90 */
ubhat 0:69f2e28d12c1 91 void DeviceInit( void );
ubhat 0:69f2e28d12c1 92
ubhat 0:69f2e28d12c1 93 /*!
ubhat 0:69f2e28d12c1 94 * \brief Device Join update
ubhat 0:69f2e28d12c1 95 */
ubhat 0:69f2e28d12c1 96 void DeviceJoinUpdate( void );
ubhat 0:69f2e28d12c1 97
ubhat 0:69f2e28d12c1 98 /*!
ubhat 0:69f2e28d12c1 99 * \brief OTA: if device not joined, send JOIN REQUEST to network
ubhat 0:69f2e28d12c1 100 * ABP: Request DevAddr if not already set
ubhat 0:69f2e28d12c1 101 */
ubhat 0:69f2e28d12c1 102 void DeviceJoin( void );
ubhat 0:69f2e28d12c1 103
ubhat 0:69f2e28d12c1 104 /*!
ubhat 0:69f2e28d12c1 105 * \brief Prepares the payload of the frame to be transmitted
ubhat 0:69f2e28d12c1 106 *
ubhat 0:69f2e28d12c1 107 * \param [IN] port application port corresponding to which payload is generated
ubhat 0:69f2e28d12c1 108 */
ubhat 0:69f2e28d12c1 109 void PrepareTxFrame( uint8_t port );
ubhat 0:69f2e28d12c1 110
ubhat 0:69f2e28d12c1 111 /*!
ubhat 0:69f2e28d12c1 112 * \brief Send the frame
ubhat 0:69f2e28d12c1 113 *
ubhat 0:69f2e28d12c1 114 */
ubhat 0:69f2e28d12c1 115 bool SendFrame( void );
ubhat 0:69f2e28d12c1 116
mluis 18:18408c3c2d0c 117 #endif // __LORA_DEVICE_STATE_H__