Create Application using SX1272 + X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 driver_mbed_TH02 mbed LoRaWAN-lib-v1_0_1 SX1272Lib

Fork of LoRaWAN-SX1272-Application-Demo by Semtech

LoRaWAN-NAMote72 Application Demo is a Class-A device example project using LoRaWAN-lib and SX1272Lib 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.
  • 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

Committer:
ubhat
Date:
Sun Aug 19 20:08:35 2018 +0000
Revision:
10:bba416e2c3e1
Parent:
7:b43f071aefb7
Create Application with SX1272 + X-NUCLEO-IKS01A2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:6cc76d70e2a1 1 /*
ubhat 0:6cc76d70e2a1 2 / _____) _ | |
ubhat 0:6cc76d70e2a1 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:6cc76d70e2a1 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:6cc76d70e2a1 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:6cc76d70e2a1 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:6cc76d70e2a1 7 (C)2015 Semtech
ubhat 0:6cc76d70e2a1 8
ubhat 0:6cc76d70e2a1 9 Description: Target board general functions implementation
ubhat 0:6cc76d70e2a1 10
ubhat 0:6cc76d70e2a1 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:6cc76d70e2a1 12
ubhat 0:6cc76d70e2a1 13 Maintainer: Miguel Luis and Gregory Cristian
ubhat 0:6cc76d70e2a1 14 */
ubhat 0:6cc76d70e2a1 15 #ifndef __BOARD_H__
ubhat 0:6cc76d70e2a1 16 #define __BOARD_H__
ubhat 0:6cc76d70e2a1 17
ubhat 0:6cc76d70e2a1 18 #include "Config.h"
ubhat 0:6cc76d70e2a1 19 #include "mbed.h"
ubhat 0:6cc76d70e2a1 20 #include "system/timer.h"
ubhat 0:6cc76d70e2a1 21 #include "system/utilities.h"
ubhat 0:6cc76d70e2a1 22 #include "sx1272-hal.h"
ubhat 10:bba416e2c3e1 23 #include "XNucleoIKS01A2.h"
ubhat 0:6cc76d70e2a1 24
ubhat 2:19dd7bfcacf7 25 #ifdef USE_GROVE_SENSOR
ubhat 2:19dd7bfcacf7 26 // Grove temperature-humidity sensor
ubhat 2:19dd7bfcacf7 27 #include "driver_mbed_TH02.h"
ubhat 2:19dd7bfcacf7 28 #endif
ubhat 2:19dd7bfcacf7 29
ubhat 7:b43f071aefb7 30 #if defined ( TARGET_NUCLEO_L152RE )
ubhat 0:6cc76d70e2a1 31 /*!
ubhat 0:6cc76d70e2a1 32 * Unique Devices IDs register set ( STM32L1xxx )
ubhat 0:6cc76d70e2a1 33 */
ubhat 0:6cc76d70e2a1 34 #define ID1 ( 0x1FF800D0 )
ubhat 0:6cc76d70e2a1 35 #define ID2 ( 0x1FF800D4 )
ubhat 0:6cc76d70e2a1 36 #define ID3 ( 0x1FF800E4 )
ubhat 0:6cc76d70e2a1 37
ubhat 7:b43f071aefb7 38 #elif defined ( TARGET_NUCLEO_F401RE )
ubhat 7:b43f071aefb7 39 /*!
ubhat 7:b43f071aefb7 40 * Unique Devices IDs register set ( STM32F4xxx )
ubhat 7:b43f071aefb7 41 */
ubhat 7:b43f071aefb7 42 #define ID1 ( 0x1FFF7A10 )
ubhat 7:b43f071aefb7 43 #define ID2 ( 0x1FFF7A14 )
ubhat 7:b43f071aefb7 44 #define ID3 ( 0x1FFF7A18 )
ubhat 7:b43f071aefb7 45
ubhat 7:b43f071aefb7 46 #elif defined ( TARGET_NUCLEO_L073RZ )
ubhat 7:b43f071aefb7 47 /*!
ubhat 7:b43f071aefb7 48 * Unique Devices IDs register set ( STM32L0xxx )
ubhat 7:b43f071aefb7 49 */
ubhat 7:b43f071aefb7 50 #define ID1 ( 0x1FF80050 )
ubhat 7:b43f071aefb7 51 #define ID2 ( 0x1FF80054 )
ubhat 7:b43f071aefb7 52 #define ID3 ( 0x1FF80064 )
ubhat 7:b43f071aefb7 53
ubhat 7:b43f071aefb7 54 #endif
ubhat 7:b43f071aefb7 55
ubhat 0:6cc76d70e2a1 56 #define LOW_BAT_THRESHOLD 3.45
ubhat 0:6cc76d70e2a1 57 #define AIN_VREF 3.3 // STM32 internal refernce
ubhat 0:6cc76d70e2a1 58 #define AIN_VBAT_DIV 2 // Resistor divider
ubhat 0:6cc76d70e2a1 59
ubhat 0:6cc76d70e2a1 60 extern SX1272MB2xAS Radio;
ubhat 0:6cc76d70e2a1 61
ubhat 0:6cc76d70e2a1 62 extern DigitalIn UsrButton;
ubhat 0:6cc76d70e2a1 63
ubhat 1:428dbf097fe6 64 extern DigitalOut Led;
ubhat 0:6cc76d70e2a1 65
ubhat 10:bba416e2c3e1 66 /* Instantiate the expansion board */
ubhat 10:bba416e2c3e1 67 extern XNucleoIKS01A2 *mems_expansion_board;
ubhat 10:bba416e2c3e1 68
ubhat 10:bba416e2c3e1 69 /* Retrieve the composing elements of the expansion board */
ubhat 10:bba416e2c3e1 70 extern LSM303AGRMagSensor *magnetometer;
ubhat 10:bba416e2c3e1 71 extern HTS221Sensor *hum_temp;
ubhat 10:bba416e2c3e1 72 extern LPS22HBSensor *press_temp;
ubhat 10:bba416e2c3e1 73 extern LSM6DSLSensor *acc_gyro;
ubhat 10:bba416e2c3e1 74 extern LSM303AGRAccSensor *accelerometer;
ubhat 0:6cc76d70e2a1 75
ubhat 0:6cc76d70e2a1 76 /*!
ubhat 0:6cc76d70e2a1 77 * \brief Initializes the target board peripherals.
ubhat 0:6cc76d70e2a1 78 */
ubhat 0:6cc76d70e2a1 79 void BoardInit( void );
ubhat 0:6cc76d70e2a1 80
ubhat 0:6cc76d70e2a1 81 /*!
ubhat 0:6cc76d70e2a1 82 * \brief Measure the Battery level
ubhat 0:6cc76d70e2a1 83 *
ubhat 0:6cc76d70e2a1 84 * \retval value battery level ( 0: very low, 254: fully charged )
ubhat 0:6cc76d70e2a1 85 */
ubhat 0:6cc76d70e2a1 86 uint8_t BoardGetBatteryLevel( void );
ubhat 0:6cc76d70e2a1 87
ubhat 0:6cc76d70e2a1 88 /*!
ubhat 0:6cc76d70e2a1 89 * Returns a pseudo random seed generated using the MCU Unique ID
ubhat 0:6cc76d70e2a1 90 *
ubhat 0:6cc76d70e2a1 91 * \retval seed Generated pseudo random seed
ubhat 0:6cc76d70e2a1 92 */
ubhat 0:6cc76d70e2a1 93 uint32_t BoardGetRandomSeed( void );
ubhat 0:6cc76d70e2a1 94
ubhat 0:6cc76d70e2a1 95 /*!
ubhat 0:6cc76d70e2a1 96 * \brief Generates Lower 32 bits of DEVEUI using 96 bits unique device ID
ubhat 0:6cc76d70e2a1 97 *
ubhat 0:6cc76d70e2a1 98 * \param [IN] id Pointer to an array that will contain the Unique ID
ubhat 0:6cc76d70e2a1 99 */
ubhat 0:6cc76d70e2a1 100 void BoardGetDevEUI( uint8_t *id );
ubhat 0:6cc76d70e2a1 101
ubhat 0:6cc76d70e2a1 102 /*!
ubhat 0:6cc76d70e2a1 103 * \brief Gets the board 64 bits unique ID
ubhat 0:6cc76d70e2a1 104 *
ubhat 0:6cc76d70e2a1 105 * \param [IN] id Pointer to an array that will contain the Unique ID
ubhat 0:6cc76d70e2a1 106 */
ubhat 0:6cc76d70e2a1 107 void BoardGetUniqueId( uint8_t *id );
ubhat 0:6cc76d70e2a1 108
ubhat 0:6cc76d70e2a1 109 #endif // __BOARD_H__