Semtech / LoRaWAN-SX1272-Application-Demo

Dependencies:   X_NUCLEO_IKS01A1 driver_mbed_TH02 LoRaWAN-lib-v1_0_1 SX1272Lib mbed

Fork of LoRaWAN-SX1272-Application-Demo by Uttam Bhat

LoRaWAN-SX1272-Application Demo uses https://os.mbed.com/components/SX1272MB2xAS/ 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 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. 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

Committer:
ubhat
Date:
Thu Apr 06 21:59:50 2017 +0000
Revision:
0:6cc76d70e2a1
LoRaWAN SX1272 Application

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: End device comissioning parameters
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 __LORA_COMISSIONING_H__
ubhat 0:6cc76d70e2a1 16 #define __LORA_COMISSIONING_H__
ubhat 0:6cc76d70e2a1 17
ubhat 0:6cc76d70e2a1 18 /*!
ubhat 0:6cc76d70e2a1 19 * When set to 1 the application uses the Over-the-Air activation procedure
ubhat 0:6cc76d70e2a1 20 * When set to 0 the application uses the Personalization activation procedure
ubhat 0:6cc76d70e2a1 21 */
ubhat 0:6cc76d70e2a1 22 #define OVER_THE_AIR_ACTIVATION 1
ubhat 0:6cc76d70e2a1 23
ubhat 0:6cc76d70e2a1 24 /*!
ubhat 0:6cc76d70e2a1 25 * Indicates if the end-device is to be connected to a private or public network
ubhat 0:6cc76d70e2a1 26 */
ubhat 0:6cc76d70e2a1 27 #define LORAWAN_PUBLIC_NETWORK true
ubhat 0:6cc76d70e2a1 28
ubhat 0:6cc76d70e2a1 29 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:6cc76d70e2a1 30
ubhat 0:6cc76d70e2a1 31 /*!
ubhat 0:6cc76d70e2a1 32 * Mote device IEEE OUI (big endian)
ubhat 0:6cc76d70e2a1 33 * \remark This is unique to a company or organization
ubhat 0:6cc76d70e2a1 34 */
ubhat 0:6cc76d70e2a1 35 #define IEEE_OUI 0x00, 0x00, 0x00
ubhat 0:6cc76d70e2a1 36
ubhat 0:6cc76d70e2a1 37 /*!
ubhat 0:6cc76d70e2a1 38 * Mote device IEEE EUI (big endian)
ubhat 0:6cc76d70e2a1 39 *
ubhat 0:6cc76d70e2a1 40 * \remark In this application, if the last 4 bytes are all 0, then the 32 bit address is automatically generated using a pseudo random generator seeded with a value derived from BoardUniqueId value
ubhat 0:6cc76d70e2a1 41 * If provided by user, e.g. { IEEE_OUI, 0x00, 0x00, 0x00, 0xFF, 0x01 }, then this value is used by the application
ubhat 0:6cc76d70e2a1 42 */
ubhat 0:6cc76d70e2a1 43 #define LORAWAN_DEVICE_EUI { IEEE_OUI, 0x00, 0x00, 0x00, 0x00, 0x00 }
ubhat 0:6cc76d70e2a1 44
ubhat 0:6cc76d70e2a1 45 /*!
ubhat 0:6cc76d70e2a1 46 * Application IEEE EUI (big endian)
ubhat 0:6cc76d70e2a1 47 */
ubhat 0:6cc76d70e2a1 48 #define LORAWAN_APPLICATION_EUI { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
ubhat 0:6cc76d70e2a1 49
ubhat 0:6cc76d70e2a1 50 /*!
ubhat 0:6cc76d70e2a1 51 * AES encryption/decryption cipher application key
ubhat 0:6cc76d70e2a1 52 */
ubhat 0:6cc76d70e2a1 53 #define LORAWAN_APPLICATION_KEY { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff }
ubhat 0:6cc76d70e2a1 54
ubhat 0:6cc76d70e2a1 55 #else
ubhat 0:6cc76d70e2a1 56
ubhat 0:6cc76d70e2a1 57 /*!
ubhat 0:6cc76d70e2a1 58 * Device address on the network (big endian)
ubhat 0:6cc76d70e2a1 59 *
ubhat 0:6cc76d70e2a1 60 * \remark In this application, if the value is 0, then the address is automatically generated using a pseudo random generator seeded with a value derived from BoardUniqueId value
ubhat 0:6cc76d70e2a1 61 * If provided by user, e.g. 0x78563412, then this value is used by the application
ubhat 0:6cc76d70e2a1 62 */
ubhat 0:6cc76d70e2a1 63 #define LORAWAN_DEVICE_ADDRESS ( uint32_t )0x0
ubhat 0:6cc76d70e2a1 64
ubhat 0:6cc76d70e2a1 65 /*!
ubhat 0:6cc76d70e2a1 66 * AES encryption/decryption cipher network session key
ubhat 0:6cc76d70e2a1 67 */
ubhat 0:6cc76d70e2a1 68 #define LORAWAN_NWKSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
ubhat 0:6cc76d70e2a1 69
ubhat 0:6cc76d70e2a1 70 /*!
ubhat 0:6cc76d70e2a1 71 * AES encryption/decryption cipher application session key
ubhat 0:6cc76d70e2a1 72 */
ubhat 0:6cc76d70e2a1 73 #define LORAWAN_APPSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
ubhat 0:6cc76d70e2a1 74
ubhat 0:6cc76d70e2a1 75 #endif
ubhat 0:6cc76d70e2a1 76
ubhat 0:6cc76d70e2a1 77
ubhat 0:6cc76d70e2a1 78 #endif // __LORA_COMISSIONING_H__