Terence Huang / Canada-SX1272-LoRaWAN-Bootcamp-rotary

add rotary

Dependencies:   X_NUCLEO_IKS01A1 LoRaWAN-lib SX1272Lib mbed

Fork of Canada-SX1272-LoRaWAN-Bootcamp by Uttam Bhat

LoRaWAN-SX1272-Mbed-Shield

Overview

LoRaWAN-SX1272-Mbed-Shield application demo is a LoRaWAN Class-A device example project using LoRaWAN-lib and SX1272Lib libraries that send out sensors data.

Prerequisites

1. NUCLEO_L152RE board.
2. SX1272-mbed-shield board.
3. X-NUCLEO-IKS01A1.
4. Grove Red LED.
5. Grove Button.
6. Grove Rotary Angle Sensor.
7. mbed online compiler.
8. Tera Term.

Hardware Configuration

Application 8, 9, 11
1. Connect NUCLEO_L152RE with X-NUCLEO-IKS01A1.
2. On top of X-NUCLEO-IKS01A1, connect SX1272-mbed-shield.
Application 13
1. Connect NUCLEO_L152RE with SX1272-mbed-shield.
2. Connect Grove Red LED with DIO_D6 port on SX1272-mbed-shield.
3. Connect Grove Button with DIO_D8 port on SX1272-mbed-shield.
4. Connect Grove Rotary Angle Sensor with ANA_A1 port SX1272-mbed-shield.

Software Configuration

The end-device must be configured with the following parameters:

  • Commissioning.h
    • Activation Type: OTA or ABP
      • OTA: #define OVER_THE_AIR_ACTIVATION 1
    • Network Type: Public or Private
      • Public: #define LORAWAN_PUBLIC_NETWORK true
    • 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. (For OTA)
      • #define IEEE_OUI 0x00, 0x00, 0x00
      • #define LORAWAN_DEVICE_EUI { IEEE_OUI, 0x00, 0x00, 0x00, 0x00, 0x00 }
    • LORAWAN_APPLICATION_EUI (8 Bytes) (For OTA)
      • #define LORAWAN_APPLICATION_EUI { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
    • LORAWAN_APPLICATION_KEY (16 Bytes) (For OTA)
      • #define LORAWAN_APPLICATION_KEY { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff }
    • LORAWAN_DEVICE_ADDRESS (For ABP)
      • #define LORAWAN_DEVICE_ADDRESS ( uint32_t )0x0
    • LORAWAN_NWKSKEY (For ABP)
      • #define LORAWAN_NWKSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
    • LORAWAN_APPSKEY (For ABP)
      • #define LORAWAN_APPSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
  • Configure.h
    • Communication Type: Hybrid or FHSS
      • Hybrid: #define USE_BAND_915_HYBRID
    • Join request Period:
      • 5 sec: #define OVER_THE_AIR_ACTIVATION_DUTYCYCLE 5000000 value in us
    • TX Period:
      • 5 sec: #define APP_TX_DUTYCYCLE 5000000 value in us
    • Uplink message: Confirmed or Unconfirmed
      • Confirmed: #define LORAWAN_CONFIRMED_MSG_ON 1
    • ADR(Adaptive Data Rate): ON or OFF
      • OFF: #define LORAWAN_ADR_ON 0
    • Default data rate: DR_0 or DR_1 or DR_2 or DR_3 or DR_4
      • DR_0: #define LORAWAN_DEFAULT_DATARATE DR_0
    • Application Type: 8 (IKS01A1) or 9 (IKS01A1+Cayenne) or 11 (Push Button) or 13 (rotary+Cayenne)
      • 9: #define LORAWAN_APP_PORT 9
    • Tx Power: 10 to 30
      • 20 dBm: #define LORAWAN_TX_POWER TX_POWER_20_DBM

Serial Terminal Display

  • Use Tera Term to see the sending message (baud rate: 115200):
    • button = 0 (if not press) button = 1 (if pressed)
    • rotary = 0 ~ 300

1800

app/LoRaDeviceStateProc.cpp@0:6cc76d70e2a1, 2017-04-06 (annotated)

Committer:
ubhat
Date:
Thu Apr 06 21:59:50 2017 +0000
Revision:
0:6cc76d70e2a1
Child:
5:e21b38612c21
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: Process function calls from various Device states
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: Uttam Bhat
ubhat 0:6cc76d70e2a1 14 */
ubhat 0:6cc76d70e2a1 15
ubhat 0:6cc76d70e2a1 16 #include "LoRaDeviceStateProc.h"
ubhat 0:6cc76d70e2a1 17 #include "LoRaMacLayerService.h"
ubhat 0:6cc76d70e2a1 18
ubhat 0:6cc76d70e2a1 19 eDevicState DeviceState;
ubhat 0:6cc76d70e2a1 20
ubhat 0:6cc76d70e2a1 21 sLoRaMacUplinkStatus LoRaMacUplinkStatus;
ubhat 0:6cc76d70e2a1 22
ubhat 0:6cc76d70e2a1 23 sLoRaMacDownlinkStatus LoRaMacDownlinkStatus;
ubhat 0:6cc76d70e2a1 24
ubhat 0:6cc76d70e2a1 25 LoRaMacPrimitives_t LoRaPrimitives;
ubhat 0:6cc76d70e2a1 26
ubhat 0:6cc76d70e2a1 27 LoRaMacCallback_t LoRaCallbacks;
ubhat 0:6cc76d70e2a1 28
ubhat 0:6cc76d70e2a1 29 MibRequestConfirm_t LoRaMibReq;
ubhat 0:6cc76d70e2a1 30
ubhat 0:6cc76d70e2a1 31 MlmeReq_t mlmeReq;
ubhat 0:6cc76d70e2a1 32
ubhat 0:6cc76d70e2a1 33
ubhat 0:6cc76d70e2a1 34 /*!
ubhat 0:6cc76d70e2a1 35 * \brief Function executed on TxNextPacket Timeout event
ubhat 0:6cc76d70e2a1 36 */
ubhat 0:6cc76d70e2a1 37 static void OnTxNextPacketTimerEvent( void )
ubhat 0:6cc76d70e2a1 38 {
ubhat 0:6cc76d70e2a1 39 MibRequestConfirm_t mibReq;
ubhat 0:6cc76d70e2a1 40 LoRaMacStatus_t status;
ubhat 0:6cc76d70e2a1 41
ubhat 0:6cc76d70e2a1 42 TimerStop( &TxNextPacketTimer );
ubhat 0:6cc76d70e2a1 43
ubhat 0:6cc76d70e2a1 44 mibReq.Type = MIB_NETWORK_JOINED;
ubhat 0:6cc76d70e2a1 45 status = LoRaMacMibGetRequestConfirm( &mibReq );
ubhat 0:6cc76d70e2a1 46
ubhat 0:6cc76d70e2a1 47 if( status == LORAMAC_STATUS_OK )
ubhat 0:6cc76d70e2a1 48 {
ubhat 0:6cc76d70e2a1 49 if( mibReq.Param.IsNetworkJoined == true )
ubhat 0:6cc76d70e2a1 50 {
ubhat 0:6cc76d70e2a1 51 DeviceState = DEVICE_STATE_SEND;
ubhat 0:6cc76d70e2a1 52 }
ubhat 0:6cc76d70e2a1 53 else
ubhat 0:6cc76d70e2a1 54 {
ubhat 0:6cc76d70e2a1 55 DeviceState = DEVICE_STATE_JOIN;
ubhat 0:6cc76d70e2a1 56 }
ubhat 0:6cc76d70e2a1 57 NextTx = true;
ubhat 0:6cc76d70e2a1 58 }
ubhat 0:6cc76d70e2a1 59 }
ubhat 0:6cc76d70e2a1 60
ubhat 0:6cc76d70e2a1 61 void DeviceInit( void )
ubhat 0:6cc76d70e2a1 62 {
ubhat 0:6cc76d70e2a1 63 LoRaPrimitives.MacMcpsConfirm = McpsConfirm;
ubhat 0:6cc76d70e2a1 64 LoRaPrimitives.MacMcpsIndication = McpsIndication;
ubhat 0:6cc76d70e2a1 65 LoRaPrimitives.MacMlmeConfirm = MlmeConfirm;
ubhat 0:6cc76d70e2a1 66 LoRaCallbacks.GetBatteryLevel = BoardGetBatteryLevel;
ubhat 0:6cc76d70e2a1 67 LoRaMacInitialization( &LoRaPrimitives, &LoRaCallbacks );
ubhat 0:6cc76d70e2a1 68
ubhat 0:6cc76d70e2a1 69 TimerInit( &TxNextPacketTimer, OnTxNextPacketTimerEvent );
ubhat 0:6cc76d70e2a1 70
ubhat 0:6cc76d70e2a1 71 LoRaMibReq.Type = MIB_ADR;
ubhat 0:6cc76d70e2a1 72 LoRaMibReq.Param.AdrEnable = LORAWAN_ADR_ON;
ubhat 0:6cc76d70e2a1 73 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 74
ubhat 0:6cc76d70e2a1 75 LoRaMibReq.Type = MIB_PUBLIC_NETWORK;
ubhat 0:6cc76d70e2a1 76 LoRaMibReq.Param.EnablePublicNetwork = LORAWAN_PUBLIC_NETWORK;
ubhat 0:6cc76d70e2a1 77 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 78
ubhat 0:6cc76d70e2a1 79 LoRaMibReq.Type = MIB_CHANNELS_TX_POWER;
ubhat 0:6cc76d70e2a1 80 LoRaMibReq.Param.ChannelsTxPower = LORAWAN_TX_POWER;
ubhat 0:6cc76d70e2a1 81 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 82
ubhat 0:6cc76d70e2a1 83 LoRaMacDownlinkStatus.DownlinkCounter = 0;
ubhat 0:6cc76d70e2a1 84 }
ubhat 0:6cc76d70e2a1 85
ubhat 0:6cc76d70e2a1 86 void DeviceJoinUpdate( void )
ubhat 0:6cc76d70e2a1 87 {
ubhat 0:6cc76d70e2a1 88 LoRaMibReq.Type = MIB_NETWORK_JOINED;
ubhat 0:6cc76d70e2a1 89 LoRaMacMibGetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 90 }
ubhat 0:6cc76d70e2a1 91
ubhat 0:6cc76d70e2a1 92 void DeviceJoin( void )
ubhat 0:6cc76d70e2a1 93 {
ubhat 0:6cc76d70e2a1 94 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:6cc76d70e2a1 95
ubhat 0:6cc76d70e2a1 96 mlmeReq.Type = MLME_JOIN;
ubhat 0:6cc76d70e2a1 97
ubhat 0:6cc76d70e2a1 98 mlmeReq.Req.Join.DevEui = DevEui;
ubhat 0:6cc76d70e2a1 99 mlmeReq.Req.Join.AppEui = AppEui;
ubhat 0:6cc76d70e2a1 100 mlmeReq.Req.Join.AppKey = AppKey;
ubhat 0:6cc76d70e2a1 101
ubhat 0:6cc76d70e2a1 102 if( NextTx == true )
ubhat 0:6cc76d70e2a1 103 {
ubhat 0:6cc76d70e2a1 104 LoRaMacMlmeRequest( &mlmeReq );
ubhat 0:6cc76d70e2a1 105 }
ubhat 0:6cc76d70e2a1 106
ubhat 0:6cc76d70e2a1 107 #else
ubhat 0:6cc76d70e2a1 108 // Choose a random device address if not already defined in Config.h
ubhat 0:6cc76d70e2a1 109 if( DevAddr == 0 )
ubhat 0:6cc76d70e2a1 110 {
ubhat 0:6cc76d70e2a1 111 // Random seed initialization
ubhat 0:6cc76d70e2a1 112 srand1( BoardGetRandomSeed( ) );
ubhat 0:6cc76d70e2a1 113 DevAddr = randr( 0, 0x01FFFFFF );
ubhat 0:6cc76d70e2a1 114 }
ubhat 0:6cc76d70e2a1 115
ubhat 0:6cc76d70e2a1 116 LoRaMibReq.Type = MIB_NET_ID;
ubhat 0:6cc76d70e2a1 117 LoRaMibReq.Param.NetID = LORAWAN_NETWORK_ID;
ubhat 0:6cc76d70e2a1 118 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 119
ubhat 0:6cc76d70e2a1 120 LoRaMibReq.Type = MIB_DEV_ADDR;
ubhat 0:6cc76d70e2a1 121 LoRaMibReq.Param.DevAddr = DevAddr;
ubhat 0:6cc76d70e2a1 122 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 123
ubhat 0:6cc76d70e2a1 124 LoRaMibReq.Type = MIB_NWK_SKEY;
ubhat 0:6cc76d70e2a1 125 LoRaMibReq.Param.NwkSKey = NwkSKey;
ubhat 0:6cc76d70e2a1 126 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 127
ubhat 0:6cc76d70e2a1 128 LoRaMibReq.Type = MIB_APP_SKEY;
ubhat 0:6cc76d70e2a1 129 LoRaMibReq.Param.AppSKey = AppSKey;
ubhat 0:6cc76d70e2a1 130 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 131
ubhat 0:6cc76d70e2a1 132 LoRaMibReq.Type = MIB_NETWORK_JOINED;
ubhat 0:6cc76d70e2a1 133 LoRaMibReq.Param.IsNetworkJoined = true;
ubhat 0:6cc76d70e2a1 134 LoRaMacMibSetRequestConfirm( &LoRaMibReq );
ubhat 0:6cc76d70e2a1 135
ubhat 0:6cc76d70e2a1 136 #endif
ubhat 0:6cc76d70e2a1 137 }
ubhat 0:6cc76d70e2a1 138
ubhat 0:6cc76d70e2a1 139 /*!
ubhat 0:6cc76d70e2a1 140 * \brief Prepares the payload of the frame
ubhat 0:6cc76d70e2a1 141 */
ubhat 0:6cc76d70e2a1 142 void PrepareTxFrame( uint8_t port )
ubhat 0:6cc76d70e2a1 143 {
ubhat 0:6cc76d70e2a1 144 MibRequestConfirm_t mibReq;
ubhat 0:6cc76d70e2a1 145
ubhat 0:6cc76d70e2a1 146 if( BoardGetBatteryLevel( ) < LOW_BAT_THRESHOLD )
ubhat 0:6cc76d70e2a1 147 {
ubhat 0:6cc76d70e2a1 148 mibReq.Type = MIB_CHANNELS_TX_POWER;
ubhat 0:6cc76d70e2a1 149 LoRaMacMibGetRequestConfirm( &mibReq );
ubhat 0:6cc76d70e2a1 150 // TX_POWER_30_DBM = 0, TX_POWER_28_DBM = 1, ..., TX_POWER_20_DBM = 5, ..., TX_POWER_10_DBM = 10
ubhat 0:6cc76d70e2a1 151 // The if condition is then "less than" to check if the power is greater than 20 dBm
ubhat 0:6cc76d70e2a1 152 if( mibReq.Param.ChannelsTxPower < TX_POWER_20_DBM )
ubhat 0:6cc76d70e2a1 153 {
ubhat 0:6cc76d70e2a1 154 mibReq.Param.ChannelsTxPower = TX_POWER_20_DBM;
ubhat 0:6cc76d70e2a1 155 LoRaMacMibSetRequestConfirm( &mibReq );
ubhat 0:6cc76d70e2a1 156 }
ubhat 0:6cc76d70e2a1 157 }
ubhat 0:6cc76d70e2a1 158
ubhat 0:6cc76d70e2a1 159 if( port == 224 )
ubhat 0:6cc76d70e2a1 160 {
ubhat 0:6cc76d70e2a1 161 RunComplianceTest( );
ubhat 0:6cc76d70e2a1 162 }
ubhat 0:6cc76d70e2a1 163 else
ubhat 0:6cc76d70e2a1 164 {
ubhat 0:6cc76d70e2a1 165 PrepareLoRaFrame( port );
ubhat 0:6cc76d70e2a1 166 }
ubhat 0:6cc76d70e2a1 167 }
ubhat 0:6cc76d70e2a1 168
ubhat 0:6cc76d70e2a1 169 /*!
ubhat 0:6cc76d70e2a1 170 * \brief Prepares the payload of the frame
ubhat 0:6cc76d70e2a1 171 *
ubhat 0:6cc76d70e2a1 172 * \retval [0: frame could be send, 1: error]
ubhat 0:6cc76d70e2a1 173 */
ubhat 0:6cc76d70e2a1 174 bool SendFrame( void )
ubhat 0:6cc76d70e2a1 175 {
ubhat 0:6cc76d70e2a1 176 McpsReq_t mcpsReq;
ubhat 0:6cc76d70e2a1 177 LoRaMacTxInfo_t txInfo;
ubhat 0:6cc76d70e2a1 178
ubhat 0:6cc76d70e2a1 179 if( LoRaMacQueryTxPossible( AppDataSize, &txInfo ) != LORAMAC_STATUS_OK )
ubhat 0:6cc76d70e2a1 180 {
ubhat 0:6cc76d70e2a1 181 // Send empty frame in order to flush MAC commands
ubhat 0:6cc76d70e2a1 182 mcpsReq.Type = MCPS_UNCONFIRMED;
ubhat 0:6cc76d70e2a1 183 mcpsReq.Req.Unconfirmed.fBuffer = NULL;
ubhat 0:6cc76d70e2a1 184 mcpsReq.Req.Unconfirmed.fBufferSize = 0;
ubhat 0:6cc76d70e2a1 185 mcpsReq.Req.Unconfirmed.Datarate = LORAWAN_DEFAULT_DATARATE;
ubhat 0:6cc76d70e2a1 186
ubhat 0:6cc76d70e2a1 187 LoRaMacUplinkStatus.Acked = false;
ubhat 0:6cc76d70e2a1 188 LoRaMacUplinkStatus.Port = 0;
ubhat 0:6cc76d70e2a1 189 LoRaMacUplinkStatus.Buffer = NULL;
ubhat 0:6cc76d70e2a1 190 LoRaMacUplinkStatus.BufferSize = 0;
ubhat 0:6cc76d70e2a1 191 }
ubhat 0:6cc76d70e2a1 192 else
ubhat 0:6cc76d70e2a1 193 {
ubhat 0:6cc76d70e2a1 194 LoRaMacUplinkStatus.Acked = false;
ubhat 0:6cc76d70e2a1 195 LoRaMacUplinkStatus.Port = AppPort;
ubhat 0:6cc76d70e2a1 196 LoRaMacUplinkStatus.Buffer = AppData;
ubhat 0:6cc76d70e2a1 197 LoRaMacUplinkStatus.BufferSize = AppDataSize;
ubhat 0:6cc76d70e2a1 198
ubhat 0:6cc76d70e2a1 199 if( ( IsTxConfirmed == false ) || ( LoRaMacUplinkStatus.UplinkCounter == 0 ) )
ubhat 0:6cc76d70e2a1 200 {
ubhat 0:6cc76d70e2a1 201 mcpsReq.Type = MCPS_UNCONFIRMED;
ubhat 0:6cc76d70e2a1 202 mcpsReq.Req.Unconfirmed.fPort = AppPort;
ubhat 0:6cc76d70e2a1 203 mcpsReq.Req.Unconfirmed.fBuffer = AppData;
ubhat 0:6cc76d70e2a1 204 mcpsReq.Req.Unconfirmed.fBufferSize = AppDataSize;
ubhat 0:6cc76d70e2a1 205 mcpsReq.Req.Unconfirmed.Datarate = LORAWAN_DEFAULT_DATARATE;
ubhat 0:6cc76d70e2a1 206 }
ubhat 0:6cc76d70e2a1 207 else
ubhat 0:6cc76d70e2a1 208 {
ubhat 0:6cc76d70e2a1 209 mcpsReq.Type = MCPS_CONFIRMED;
ubhat 0:6cc76d70e2a1 210 mcpsReq.Req.Confirmed.fPort = AppPort;
ubhat 0:6cc76d70e2a1 211 mcpsReq.Req.Confirmed.fBuffer = AppData;
ubhat 0:6cc76d70e2a1 212 mcpsReq.Req.Confirmed.fBufferSize = AppDataSize;
ubhat 0:6cc76d70e2a1 213 mcpsReq.Req.Confirmed.NbTrials = 8;
ubhat 0:6cc76d70e2a1 214 mcpsReq.Req.Confirmed.Datarate = LORAWAN_DEFAULT_DATARATE;
ubhat 0:6cc76d70e2a1 215 }
ubhat 0:6cc76d70e2a1 216 }
ubhat 0:6cc76d70e2a1 217
ubhat 0:6cc76d70e2a1 218 LoRaMacUplinkStatus.Type = mcpsReq.Type;
ubhat 0:6cc76d70e2a1 219
ubhat 0:6cc76d70e2a1 220 if( LoRaMacMcpsRequest( &mcpsReq ) == LORAMAC_STATUS_OK )
ubhat 0:6cc76d70e2a1 221 {
ubhat 0:6cc76d70e2a1 222 return false;
ubhat 0:6cc76d70e2a1 223 }
ubhat 0:6cc76d70e2a1 224 return true;
ubhat 0:6cc76d70e2a1 225 }