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:
ubhat
Date:
Wed Jun 08 22:06:26 2016 +0000
Revision:
6:f8194e691dd4
Parent:
0:69f2e28d12c1
Child:
18:18408c3c2d0c
Add push-button application demo (assigned to Application PORT 11)

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: Target board general functions implementation
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: Miguel Luis and Gregory Cristian
ubhat 0:69f2e28d12c1 14 */
ubhat 0:69f2e28d12c1 15 #ifndef __BOARD_H__
ubhat 0:69f2e28d12c1 16 #define __BOARD_H__
ubhat 0:69f2e28d12c1 17
ubhat 0:69f2e28d12c1 18 #include "Config.h"
ubhat 0:69f2e28d12c1 19 #include "mbed.h"
ubhat 0:69f2e28d12c1 20 #include "system/timer.h"
ubhat 0:69f2e28d12c1 21 #include "debug.h"
ubhat 0:69f2e28d12c1 22 #include "system/utilities.h"
ubhat 0:69f2e28d12c1 23 #include "sx1272-hal.h"
ubhat 0:69f2e28d12c1 24 #include "gps.h"
ubhat 0:69f2e28d12c1 25 #include "mpl3115a2.h"
ubhat 0:69f2e28d12c1 26 #include "mma8451q.h"
ubhat 0:69f2e28d12c1 27
ubhat 0:69f2e28d12c1 28 /*!
ubhat 0:69f2e28d12c1 29 * Unique Devices IDs register set ( STM32L1xxx )
ubhat 0:69f2e28d12c1 30 */
ubhat 0:69f2e28d12c1 31 #define ID1 ( 0x1FF800D0 )
ubhat 0:69f2e28d12c1 32 #define ID2 ( 0x1FF800D4 )
ubhat 0:69f2e28d12c1 33 #define ID3 ( 0x1FF800E4 )
ubhat 0:69f2e28d12c1 34
ubhat 0:69f2e28d12c1 35 #define LOW_BAT_THRESHOLD 3.45
ubhat 0:69f2e28d12c1 36
ubhat 0:69f2e28d12c1 37 extern DigitalOut RedLed;
ubhat 0:69f2e28d12c1 38 extern DigitalOut GreenLed;
ubhat 0:69f2e28d12c1 39 extern DigitalOut YellowLed;
ubhat 0:69f2e28d12c1 40 extern DigitalOut UsrLed;
ubhat 0:69f2e28d12c1 41 extern GPS Gps;
ubhat 0:69f2e28d12c1 42 extern MPL3115A2 Mpl3115a2;
ubhat 0:69f2e28d12c1 43 extern MMA8451Q Mma8451q;
ubhat 0:69f2e28d12c1 44
ubhat 6:f8194e691dd4 45 extern DigitalIn PC0; // Used for Push button application demo
ubhat 6:f8194e691dd4 46
ubhat 0:69f2e28d12c1 47 extern SX1272MB2xAS Radio;
ubhat 0:69f2e28d12c1 48
ubhat 0:69f2e28d12c1 49 typedef enum
ubhat 0:69f2e28d12c1 50 {
ubhat 0:69f2e28d12c1 51 MOTE_VERSION_NONE = 0,
ubhat 0:69f2e28d12c1 52 MOTE_VERSION_2,
ubhat 0:69f2e28d12c1 53 MOTE_VERSION_3,
ubhat 0:69f2e28d12c1 54 }MoteVersion_t;
ubhat 0:69f2e28d12c1 55
ubhat 0:69f2e28d12c1 56
ubhat 0:69f2e28d12c1 57 /*!
ubhat 0:69f2e28d12c1 58 * \brief Initializes the target board peripherals.
ubhat 0:69f2e28d12c1 59 */
ubhat 0:69f2e28d12c1 60 void BoardInit( void );
ubhat 0:69f2e28d12c1 61
ubhat 0:69f2e28d12c1 62 /*!
ubhat 0:69f2e28d12c1 63 * \brief Measure the Battery level
ubhat 0:69f2e28d12c1 64 *
ubhat 0:69f2e28d12c1 65 * \retval value battery level ( 0: very low, 254: fully charged )
ubhat 0:69f2e28d12c1 66 */
ubhat 0:69f2e28d12c1 67 uint8_t BoardGetBatteryLevel( void );
ubhat 0:69f2e28d12c1 68
ubhat 0:69f2e28d12c1 69 /*!
ubhat 0:69f2e28d12c1 70 * \brief Measure the Battery voltage
ubhat 0:69f2e28d12c1 71 *
ubhat 0:69f2e28d12c1 72 * \retval value battery voltage in volts
ubhat 0:69f2e28d12c1 73 */
ubhat 0:69f2e28d12c1 74 float BoardGetBatteryVoltage( void );
ubhat 0:69f2e28d12c1 75
ubhat 0:69f2e28d12c1 76 /*!
ubhat 0:69f2e28d12c1 77 * Returns a pseudo random seed generated using the MCU Unique ID
ubhat 0:69f2e28d12c1 78 *
ubhat 0:69f2e28d12c1 79 * \retval seed Generated pseudo random seed
ubhat 0:69f2e28d12c1 80 */
ubhat 0:69f2e28d12c1 81 uint32_t BoardGetRandomSeed( void );
ubhat 0:69f2e28d12c1 82
ubhat 0:69f2e28d12c1 83 /*!
ubhat 0:69f2e28d12c1 84 * \brief Generates Lower 32 bits of DEVEUI using 96 bits unique device ID
ubhat 0:69f2e28d12c1 85 *
ubhat 0:69f2e28d12c1 86 * \param [IN] id Pointer to an array that will contain the Unique ID
ubhat 0:69f2e28d12c1 87 */
ubhat 0:69f2e28d12c1 88 void BoardGetDevEUI( uint8_t *id );
ubhat 0:69f2e28d12c1 89
ubhat 0:69f2e28d12c1 90 /*!
ubhat 0:69f2e28d12c1 91 * \brief Gets the board 64 bits unique ID
ubhat 0:69f2e28d12c1 92 *
ubhat 0:69f2e28d12c1 93 * \param [IN] id Pointer to an array that will contain the Unique ID
ubhat 0:69f2e28d12c1 94 */
ubhat 0:69f2e28d12c1 95 void BoardGetUniqueId( uint8_t *id );
ubhat 0:69f2e28d12c1 96
ubhat 0:69f2e28d12c1 97 #endif // __BOARD_H__