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/LoRaApp.h
- Revision:
- 0:42863a11464a
- Child:
- 2:78df92a365c2
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/app/LoRaApp.h Fri Aug 26 19:36:35 2016 +0000 @@ -0,0 +1,151 @@ +/* + / _____) _ | | +( (____ _____ ____ _| |_ _____ ____| |__ + \____ \| ___ | (_ _) ___ |/ ___) _ \ + _____) ) ____| | | || |_| ____( (___| | | | +(______/|_____)_|_|_| \__)_____)\____)_| |_| + (C)2015 Semtech + +Description: 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 + +License: Revised BSD License, see LICENSE.TXT file include in the project + +Maintainer: Uttam Bhat +*/ + +#ifndef __APPLICATION_H__ +#define __APPLICATION_H__ + +#include "board.h" +#include "Common.h" +#include "SerialDisplay.h" + +/*! + * LED ON/OFF definition + */ +#define LED_ON 0 +#define LED_OFF 1 + +/*! + * LED types + */ +enum eLedType +{ + Red = 0,// Red LED + Yellow = 1, // Yellow LED + Green = 2, // Green LED + Usr = 3, // USR LED +}; + +/*! + * user-defined Application names + */ +enum eAppType +{ + AppGps = 0, // GPS application + AppTemp = 1, // Temperature measurement application + AppBat = 2, // Battery measurement application + AppRamp = 3, // Generate Ramp bytes + AppAccl = 4, // Accelerometer application + AppAcclSenet = 5, // Senet + M2X application example + AppPushButton = 6, // Push button application example +}; + +/*! + * Application + */ +class Application +{ +public: + /*! + * \brief Initializes TX buffer address to private pointer + * + * \param [IN] memptr pointer to TX buffer + */ + Application( uint8_t * memptr ); + + /*! + * \brief Application Destructor + */ + ~Application( ); + + /*! + * \brief Call application type and append to application buffer + * + * \param [IN] AppType application type: GPS, Battery, Temp etc. + */ + void ApplicationCall( eAppType AppType ); + + /*! + * \brief Append data to the TX buffer + * + * \param [IN] pData pointer to the data to be appended to TX buffer + * \param [IN] Len lenght of the data to be appended to TX buffer + */ + void ApplicationAppendData( uint8_t *pData, uint8_t len ); + + /*! + * \brief Point the pointer corresponding to the TX buffer to specified index + * + * \param [IN] ptrPos index to where to point to in the TX buffer + */ + void ApplicationPtrPos( uint8_t ptrPos ); + +private: + /*! + * Index to the application buffer + */ + uint8_t BuffPtr; + /*! + * Application buffer address pointer + */ + uint8_t *BuffAddr; +}; + +class TimerLed +{ +public: + TimerEvent_t LedTimer; + TimerLed( eLedType ); + ~TimerLed( ); +}; + +extern TimerLed RedLedTimer; + +extern TimerLed YellowLedTimer; + +extern TimerLed GreenLedTimer; + +extern Application LoRaApp; + +extern bool AppLed; + +extern bool VerticalStatus; + +/*! +* \brief Blink LED +* +* \param [IN] led Red, yellow or green LED +* \param [IN] time time in usec for which the LED must be ON + */ +void BlinkLED( eLedType led, uint32_t time ); + +/*! +* \brief Turn LED ON if OFF; OFF if ON +* +* \param [IN] led Red, yellow or green LED +*/ +void ToggleLED( eLedType led ); + +/*! +* \brief Control the State of the LED +* +* \param [IN] led Red, yellow or green LED +* \param [IN] state ON or OFF +*/ +void CtrlLED( eLedType led, uint8_t state ); + +void CheckOrientation( void ); + +#endif // __APPLICATION_H__ \ No newline at end of file