Uttam Bhat / LoRaWAN-SX1276-Application-Demo

SX1276 Shield based Applications

Dependencies:   X_NUCLEO_IKS01A1 LoRaWAN-lib SX1276Lib mbed

LoRaWAN-SX1276-Application Demo uses SX1276MB1LAS mbed component shield on a nucleo board platform to demonstrate a Class-A LoRaWAN device in the 915MHz ISM band for North American region. It uses the LoRaWAN-lib and SX1276Lib 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. A few examples are associated to specific Application Port, and are defined in Config.h
  • 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

The baud-rate for serial terminal display is 115200

app/LoRaDeviceStateProc.h@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
SX1276 Shield based Applications

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:42863a11464a 1 /*
ubhat 0:42863a11464a 2 / _____) _ | |
ubhat 0:42863a11464a 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:42863a11464a 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:42863a11464a 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:42863a11464a 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:42863a11464a 7 (C)2015 Semtech
ubhat 0:42863a11464a 8
ubhat 0:42863a11464a 9 Description: Process function calls from various Device states
ubhat 0:42863a11464a 10
ubhat 0:42863a11464a 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:42863a11464a 12
ubhat 0:42863a11464a 13 Maintainer: Uttam Bhat
ubhat 0:42863a11464a 14 */
ubhat 0:42863a11464a 15 #ifndef __LORA_DEVICE_STATE_H__
ubhat 0:42863a11464a 16 #define __LORA_DEVICE_STATE_H__
ubhat 0:42863a11464a 17
ubhat 0:42863a11464a 18 #include "Common.h"
ubhat 0:42863a11464a 19 #include "board.h"
ubhat 0:42863a11464a 20 #include "LoRaMac.h"
ubhat 0:42863a11464a 21 #include "LoRaEventProc.h"
ubhat 0:42863a11464a 22 #include "SerialDisplay.h"
ubhat 0:42863a11464a 23 #include "mbed.h"
ubhat 0:42863a11464a 24 #include "LoRaMacLayerService.h"
ubhat 0:42863a11464a 25
ubhat 0:42863a11464a 26 /*!
ubhat 0:42863a11464a 27 * Strucure containing the Uplink status
ubhat 0:42863a11464a 28 */
ubhat 0:42863a11464a 29 struct sLoRaMacUplinkStatus
ubhat 0:42863a11464a 30 {
ubhat 0:42863a11464a 31 /*!
ubhat 0:42863a11464a 32 * MCPS-Request type
ubhat 0:42863a11464a 33 */
ubhat 0:42863a11464a 34 Mcps_t Type;
ubhat 0:42863a11464a 35 uint8_t Acked;
ubhat 0:42863a11464a 36 int8_t Datarate;
ubhat 0:42863a11464a 37 uint16_t UplinkCounter;
ubhat 0:42863a11464a 38 uint8_t Port;
ubhat 0:42863a11464a 39 uint8_t *Buffer;
ubhat 0:42863a11464a 40 uint8_t BufferSize;
ubhat 0:42863a11464a 41 int8_t TxPower;
ubhat 0:42863a11464a 42 };
ubhat 0:42863a11464a 43
ubhat 0:42863a11464a 44 /*!
ubhat 0:42863a11464a 45 * Strucure containing the Downlink status
ubhat 0:42863a11464a 46 */
ubhat 0:42863a11464a 47 struct sLoRaMacDownlinkStatus
ubhat 0:42863a11464a 48 {
ubhat 0:42863a11464a 49 int16_t Rssi;
ubhat 0:42863a11464a 50 int8_t Snr;
ubhat 0:42863a11464a 51 uint16_t DownlinkCounter;
ubhat 0:42863a11464a 52 bool RxData;
ubhat 0:42863a11464a 53 uint8_t Port;
ubhat 0:42863a11464a 54 uint8_t *Buffer;
ubhat 0:42863a11464a 55 uint8_t BufferSize;
ubhat 0:42863a11464a 56 uint8_t RxSlot;
ubhat 0:42863a11464a 57 };
ubhat 0:42863a11464a 58
ubhat 0:42863a11464a 59 /*!
ubhat 0:42863a11464a 60 * Device states
ubhat 0:42863a11464a 61 */
ubhat 0:42863a11464a 62 enum eDevicState
ubhat 0:42863a11464a 63 {
ubhat 0:42863a11464a 64 DEVICE_STATE_INIT,
ubhat 0:42863a11464a 65 DEVICE_STATE_JOIN,
ubhat 0:42863a11464a 66 DEVICE_STATE_SEND,
ubhat 0:42863a11464a 67 DEVICE_STATE_SLEEP
ubhat 0:42863a11464a 68 };
ubhat 0:42863a11464a 69
ubhat 0:42863a11464a 70 extern sLoRaMacUplinkStatus LoRaMacUplinkStatus;
ubhat 0:42863a11464a 71
ubhat 0:42863a11464a 72 extern sLoRaMacDownlinkStatus LoRaMacDownlinkStatus;
ubhat 0:42863a11464a 73
ubhat 0:42863a11464a 74 extern eDevicState DeviceState;
ubhat 0:42863a11464a 75
ubhat 0:42863a11464a 76 /*!
ubhat 0:42863a11464a 77 * \brief Initialize Device: Timer, MAC Services, MAC
ubhat 0:42863a11464a 78 */
ubhat 0:42863a11464a 79 void DeviceInit( void );
ubhat 0:42863a11464a 80
ubhat 0:42863a11464a 81 /*!
ubhat 0:42863a11464a 82 * \brief Device Join update
ubhat 0:42863a11464a 83 */
ubhat 0:42863a11464a 84 void DeviceJoinUpdate( void );
ubhat 0:42863a11464a 85
ubhat 0:42863a11464a 86 /*!
ubhat 0:42863a11464a 87 * \brief OTA: if device not joined, send JOIN REQUEST to network
ubhat 0:42863a11464a 88 * ABP: Request DevAddr if not already set
ubhat 0:42863a11464a 89 */
ubhat 0:42863a11464a 90 void DeviceJoin( void );
ubhat 0:42863a11464a 91
ubhat 0:42863a11464a 92 /*!
ubhat 0:42863a11464a 93 * \brief Prepares the payload of the frame to be transmitted
ubhat 0:42863a11464a 94 *
ubhat 0:42863a11464a 95 * \param [IN] port application port corresponding to which payload is generated
ubhat 0:42863a11464a 96 */
ubhat 0:42863a11464a 97 void PrepareTxFrame( uint8_t port );
ubhat 0:42863a11464a 98
ubhat 0:42863a11464a 99 /*!
ubhat 0:42863a11464a 100 * \brief Send the frame
ubhat 0:42863a11464a 101 *
ubhat 0:42863a11464a 102 */
ubhat 0:42863a11464a 103 bool SendFrame( void );
ubhat 0:42863a11464a 104
ubhat 0:42863a11464a 105 #endif // __LORA_DEVICE_STATE_H__