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

board/board.h@6:c5f2da0de0b0, 2018-07-18 (annotated)

Committer:
ubhat
Date:
Wed Jul 18 22:26:26 2018 +0000
Revision:
6:c5f2da0de0b0
Parent:
5:8654260e3d16 
Add Channel Block option in Config.h; Fix board specific DevEUI allocation

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: Target board general functions implementation
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: Miguel Luis and Gregory Cristian
ubhat 0:42863a11464a 14 */
ubhat 0:42863a11464a 15 #ifndef __BOARD_H__
ubhat 0:42863a11464a 16 #define __BOARD_H__
ubhat 0:42863a11464a 17
ubhat 0:42863a11464a 18 #include "Config.h"
ubhat 0:42863a11464a 19 #include "mbed.h"
ubhat 0:42863a11464a 20 #include "system/timer.h"
ubhat 0:42863a11464a 21 #include "debug.h"
ubhat 0:42863a11464a 22 #include "system/utilities.h"
ubhat 0:42863a11464a 23 #include "sx1276-hal.h"
ubhat 0:42863a11464a 24
ubhat 2:78df92a365c2 25 #ifdef USE_IKS01A1_SENSOR
ubhat 2:78df92a365c2 26 #include "x_nucleo_iks01a1.h"
ubhat 2:78df92a365c2 27 #endif
ubhat 2:78df92a365c2 28
ubhat 5:8654260e3d16 29 #if defined ( TARGET_NUCLEO_L152RE )
ubhat 0:42863a11464a 30 /*!
ubhat 0:42863a11464a 31 * Unique Devices IDs register set ( STM32L1xxx )
ubhat 0:42863a11464a 32 */
ubhat 0:42863a11464a 33 #define ID1 ( 0x1FF800D0 )
ubhat 0:42863a11464a 34 #define ID2 ( 0x1FF800D4 )
ubhat 0:42863a11464a 35 #define ID3 ( 0x1FF800E4 )
ubhat 0:42863a11464a 36
ubhat 5:8654260e3d16 37 #elif defined ( TARGET_NUCLEO_F401RE ) || defined ( TARGET_NUCLEO_F411RE )
ubhat 5:8654260e3d16 38 /*!
ubhat 5:8654260e3d16 39 * Unique Devices IDs register set ( STM32F4xxx )
ubhat 5:8654260e3d16 40 */
ubhat 5:8654260e3d16 41 #define ID1 ( 0x1FFF7A10 )
ubhat 5:8654260e3d16 42 #define ID2 ( 0x1FFF7A14 )
ubhat 5:8654260e3d16 43 #define ID3 ( 0x1FFF7A18 )
ubhat 5:8654260e3d16 44
ubhat 5:8654260e3d16 45 #elif defined ( TARGET_NUCLEO_L073RZ )
ubhat 5:8654260e3d16 46 /*!
ubhat 5:8654260e3d16 47 * Unique Devices IDs register set ( STM32L0xxx )
ubhat 5:8654260e3d16 48 */
ubhat 5:8654260e3d16 49 #define ID1 ( 0x1FF80050 )
ubhat 5:8654260e3d16 50 #define ID2 ( 0x1FF80054 )
ubhat 5:8654260e3d16 51 #define ID3 ( 0x1FF80064 )
ubhat 5:8654260e3d16 52
ubhat 5:8654260e3d16 53 #endif
ubhat 5:8654260e3d16 54
ubhat 0:42863a11464a 55 #define LOW_BAT_THRESHOLD 3.45
ubhat 2:78df92a365c2 56 #define AIN_VREF 3.3 // STM32 internal refernce
ubhat 2:78df92a365c2 57 #define AIN_VBAT_DIV 2 // Resistor divider
ubhat 0:42863a11464a 58
ubhat 0:42863a11464a 59 extern SX1276MB1xAS Radio;
ubhat 0:42863a11464a 60
ubhat 1:80c1daf19aa4 61 extern DigitalIn UsrButton;
ubhat 1:80c1daf19aa4 62
ubhat 2:78df92a365c2 63 #ifdef USE_IKS01A1_SENSOR
ubhat 2:78df92a365c2 64 extern X_NUCLEO_IKS01A1 *mems_expansion_board;
ubhat 2:78df92a365c2 65 extern MotionSensor *accelerometer;
ubhat 2:78df92a365c2 66 extern HumiditySensor *humidity_sensor;
ubhat 2:78df92a365c2 67 extern PressureSensor *pressure_sensor;
ubhat 2:78df92a365c2 68 extern TempSensor *temp_sensor1;
ubhat 3:4bca7f8f731a 69 extern TempSensor *temp_sensor2;
ubhat 2:78df92a365c2 70 #endif
ubhat 0:42863a11464a 71
ubhat 0:42863a11464a 72 /*!
ubhat 0:42863a11464a 73 * \brief Initializes the target board peripherals.
ubhat 0:42863a11464a 74 */
ubhat 0:42863a11464a 75 void BoardInit( void );
ubhat 0:42863a11464a 76
ubhat 0:42863a11464a 77 /*!
ubhat 0:42863a11464a 78 * \brief Measure the Battery level
ubhat 0:42863a11464a 79 *
ubhat 0:42863a11464a 80 * \retval value battery level ( 0: very low, 254: fully charged )
ubhat 0:42863a11464a 81 */
ubhat 0:42863a11464a 82 uint8_t BoardGetBatteryLevel( void );
ubhat 0:42863a11464a 83
ubhat 0:42863a11464a 84 /*!
ubhat 0:42863a11464a 85 * Returns a pseudo random seed generated using the MCU Unique ID
ubhat 0:42863a11464a 86 *
ubhat 0:42863a11464a 87 * \retval seed Generated pseudo random seed
ubhat 0:42863a11464a 88 */
ubhat 0:42863a11464a 89 uint32_t BoardGetRandomSeed( void );
ubhat 0:42863a11464a 90
ubhat 0:42863a11464a 91 /*!
ubhat 0:42863a11464a 92 * \brief Generates Lower 32 bits of DEVEUI using 96 bits unique device ID
ubhat 0:42863a11464a 93 *
ubhat 0:42863a11464a 94 * \param [IN] id Pointer to an array that will contain the Unique ID
ubhat 0:42863a11464a 95 */
ubhat 0:42863a11464a 96 void BoardGetDevEUI( uint8_t *id );
ubhat 0:42863a11464a 97
ubhat 0:42863a11464a 98 /*!
ubhat 0:42863a11464a 99 * \brief Gets the board 64 bits unique ID
ubhat 0:42863a11464a 100 *
ubhat 0:42863a11464a 101 * \param [IN] id Pointer to an array that will contain the Unique ID
ubhat 0:42863a11464a 102 */
ubhat 0:42863a11464a 103 void BoardGetUniqueId( uint8_t *id );
ubhat 0:42863a11464a 104
ubhat 0:42863a11464a 105 #endif // __BOARD_H__