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.
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-deviceLORAWAN_APPLICATION_EUI
(8 Bytes)LORAWAN_APPLICATION_KEY
(or DEVKEY) (16 Bytes)
Activation by Personalization (ABP) can be enabled as shown in the figure below.
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-deviceLORAWAN_NWKSKEY
(16 Bytes)LORAWAN_APPSKEY
(16 Bytes)
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
- 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 thatAPP_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 anACK
by the network server in the subsequent RX window. When set to 0, noACK
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)
The baud-rate for serial terminal display is 115200
Diff: app/main.cpp
- Revision:
- 0:42863a11464a
- Child:
- 1:80c1daf19aa4
diff -r 000000000000 -r 42863a11464a app/main.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/app/main.cpp Fri Aug 26 19:36:35 2016 +0000 @@ -0,0 +1,229 @@ +/* + / _____) _ | | +( (____ _____ ____ _| |_ _____ ____| |__ + \____ \| ___ | (_ _) ___ |/ ___) _ \ + _____) ) ____| | | || |_| ____( (___| | | | +(______/|_____)_|_|_| \__)_____)\____)_| |_| + (C)2015 Semtech + +Description: LoRaMac classA device implementation + +License: Revised BSD License, see LICENSE.TXT file include in the project + +Maintainer: Miguel Luis and Gregory Cristian +*/ +#include "mbed.h" +#include "board.h" +#include "radio.h" + +#include "LoRaMac.h" +#include "Comissioning.h" +#include "SerialDisplay.h" +#include "ComplianceTest.h" +#include "LoRaDeviceStateProc.h" +#include "LoRaEventProc.h" +#include "LoRaApp.h" + +/*! + * Defines a random delay for application data transmission duty cycle. 1s, + * value in [us]. + */ + + +#if( OVER_THE_AIR_ACTIVATION != 0 ) + +uint8_t DevEui[] = LORAWAN_DEVICE_EUI; +uint8_t AppEui[] = LORAWAN_APPLICATION_EUI; +uint8_t AppKey[] = LORAWAN_APPLICATION_KEY; + +#else + +uint8_t NwkSKey[] = LORAWAN_NWKSKEY; +uint8_t AppSKey[] = LORAWAN_APPSKEY; + +/*! + * Device address + */ +uint32_t DevAddr = LORAWAN_DEVICE_ADDRESS; + +#endif + +/*! + * Application port + */ +uint8_t AppPort = LORAWAN_APP_PORT; + +/*! + * User application data size + */ +uint8_t AppDataSize = LORAWAN_APP_DATA_SIZE; + +/*! + * User application data + */ +uint8_t AppData[LORAWAN_APP_DATA_MAX_SIZE]; + +/*! + * Application to handle functions + */ +Application LoRaApp( AppData ); + +/*! + * Indicates if the node is sending confirmed or unconfirmed messages + */ +uint8_t IsTxConfirmed = LORAWAN_CONFIRMED_MSG_ON; + +/*! + * Timer to handle the application data transmission duty cycle + */ +TimerEvent_t TxNextPacketTimer; + +/*! + * Indicates if a new transmit interrupt can be set + */ +bool IsTxIntUpdate = false; + +/*! + * Indicates if a new packet can be sent + */ +bool NextTx = true; + +/*! + * LoRaWAN compliance tests support data + */ +ComplianceTest_s ComplianceTest; + +/*! + * Indicates if the MAC layer network join status has changed. + */ +bool IsNetworkJoinedStatusUpdate = false; + +/*! + * Indicates if the message sent. + */ +bool IsTxUpdate = false; + +/*! + * Indicates if the message received in the RX window. + */ +bool IsRxUpdate = false; + + +/** + * Main application entry point. + */ +int main( void ) +{ + + // Initialize board peripherals + BoardInit( ); + + // Initialize Device state + DeviceState = DEVICE_STATE_INIT; + + while( 1 ) + { + if( IsNetworkJoinedStatusUpdate == true ) + { + IsNetworkJoinedStatusUpdate = false; + + DeviceJoinUpdate( ); + } + + if( IsTxUpdate == true ) + { + // If downlink received then update Serial Terminal and execute Rx event + IsTxUpdate = false; + + // Update serial terminal + SerialDisplayTxUpdate( ); + } + + if( IsTxIntUpdate == true ) + { + IsTxIntUpdate = false; + + // Initialize next Tx Interrupt + InitNextTxInterrupt( AppPort ); + } + + if( IsRxUpdate == true ) + { + // If downlink received then update Serial Terminal and execute Rx event + IsRxUpdate = false; + RxEvent( ); + SerialDisplayRxUpdate( ); + } + + switch( DeviceState ) + { + case DEVICE_STATE_INIT: + { + // Initialize MAC, MAC services, Primitives + DeviceInit( ); + + // Change Device state + DeviceState = DEVICE_STATE_JOIN; + break; + } + case DEVICE_STATE_JOIN: + { +#if( OVER_THE_AIR_ACTIVATION != 0 ) // OTA + + // Generate DevEUI if not defined by User + BoardGetDevEUI( DevEui ); + + // Join N/w server + DeviceJoin( ); + + // Show on serial terminal + SerialDisplayJoinUpdate( ); + + // Execute Join event + JoinEvent( ); + + DeviceState = DEVICE_STATE_SLEEP; + +#else // ABP + DeviceJoin( ); + + DeviceState = DEVICE_STATE_SEND; +#endif + IsNetworkJoinedStatusUpdate = true; + break; + } + case DEVICE_STATE_SEND: + { + if( NextTx == true ) + { + // Prepare payload frame based on application port + PrepareTxFrame( AppPort ); + + // Send payload over the air + NextTx = SendFrame( ); + + // Execute transmit event + TxEvent( ); + } + + if( NextTx == false ) + { + IsTxUpdate = true; + } + + DeviceState = DEVICE_STATE_SLEEP; + break; + } + case DEVICE_STATE_SLEEP: + { + // Wake up through events + break; + } + default: + { + DeviceState = DEVICE_STATE_INIT; + break; + } + } + } +}