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/main.cpp@0:6cc76d70e2a1, 2017-04-06 (annotated)

Committer:
ubhat
Date:
Thu Apr 06 21:59:50 2017 +0000
Revision:
0:6cc76d70e2a1
Child:
1:428dbf097fe6
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: LoRaMac classA device 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 #include "mbed.h"
ubhat 0:6cc76d70e2a1 16 #include "board.h"
ubhat 0:6cc76d70e2a1 17 #include "radio.h"
ubhat 0:6cc76d70e2a1 18
ubhat 0:6cc76d70e2a1 19 #include "LoRaMac.h"
ubhat 0:6cc76d70e2a1 20 #include "Comissioning.h"
ubhat 0:6cc76d70e2a1 21 #include "SerialDisplay.h"
ubhat 0:6cc76d70e2a1 22 #include "ComplianceTest.h"
ubhat 0:6cc76d70e2a1 23 #include "LoRaDeviceStateProc.h"
ubhat 0:6cc76d70e2a1 24 #include "LoRaEventProc.h"
ubhat 0:6cc76d70e2a1 25 #include "LoRaApp.h"
ubhat 0:6cc76d70e2a1 26
ubhat 0:6cc76d70e2a1 27 /*!
ubhat 0:6cc76d70e2a1 28 * Defines a random delay for application data transmission duty cycle. 1s,
ubhat 0:6cc76d70e2a1 29 * value in [us].
ubhat 0:6cc76d70e2a1 30 */
ubhat 0:6cc76d70e2a1 31
ubhat 0:6cc76d70e2a1 32
ubhat 0:6cc76d70e2a1 33 #if( OVER_THE_AIR_ACTIVATION != 0 )
ubhat 0:6cc76d70e2a1 34
ubhat 0:6cc76d70e2a1 35 uint8_t DevEui[] = LORAWAN_DEVICE_EUI;
ubhat 0:6cc76d70e2a1 36 uint8_t AppEui[] = LORAWAN_APPLICATION_EUI;
ubhat 0:6cc76d70e2a1 37 uint8_t AppKey[] = LORAWAN_APPLICATION_KEY;
ubhat 0:6cc76d70e2a1 38
ubhat 0:6cc76d70e2a1 39 #else
ubhat 0:6cc76d70e2a1 40
ubhat 0:6cc76d70e2a1 41 uint8_t NwkSKey[] = LORAWAN_NWKSKEY;
ubhat 0:6cc76d70e2a1 42 uint8_t AppSKey[] = LORAWAN_APPSKEY;
ubhat 0:6cc76d70e2a1 43
ubhat 0:6cc76d70e2a1 44 /*!
ubhat 0:6cc76d70e2a1 45 * Device address
ubhat 0:6cc76d70e2a1 46 */
ubhat 0:6cc76d70e2a1 47 uint32_t DevAddr = LORAWAN_DEVICE_ADDRESS;
ubhat 0:6cc76d70e2a1 48
ubhat 0:6cc76d70e2a1 49 #endif
ubhat 0:6cc76d70e2a1 50
ubhat 0:6cc76d70e2a1 51 /*!
ubhat 0:6cc76d70e2a1 52 * Application port
ubhat 0:6cc76d70e2a1 53 */
ubhat 0:6cc76d70e2a1 54 uint8_t AppPort = LORAWAN_APP_PORT;
ubhat 0:6cc76d70e2a1 55
ubhat 0:6cc76d70e2a1 56 /*!
ubhat 0:6cc76d70e2a1 57 * User application data size
ubhat 0:6cc76d70e2a1 58 */
ubhat 0:6cc76d70e2a1 59 uint8_t AppDataSize = LORAWAN_APP_DATA_SIZE;
ubhat 0:6cc76d70e2a1 60
ubhat 0:6cc76d70e2a1 61 /*!
ubhat 0:6cc76d70e2a1 62 * User application data
ubhat 0:6cc76d70e2a1 63 */
ubhat 0:6cc76d70e2a1 64 uint8_t AppData[LORAWAN_APP_DATA_MAX_SIZE];
ubhat 0:6cc76d70e2a1 65
ubhat 0:6cc76d70e2a1 66 /*!
ubhat 0:6cc76d70e2a1 67 * Application to handle functions
ubhat 0:6cc76d70e2a1 68 */
ubhat 0:6cc76d70e2a1 69 Application LoRaApp( AppData );
ubhat 0:6cc76d70e2a1 70
ubhat 0:6cc76d70e2a1 71 /*!
ubhat 0:6cc76d70e2a1 72 * Indicates if the node is sending confirmed or unconfirmed messages
ubhat 0:6cc76d70e2a1 73 */
ubhat 0:6cc76d70e2a1 74 uint8_t IsTxConfirmed = LORAWAN_CONFIRMED_MSG_ON;
ubhat 0:6cc76d70e2a1 75
ubhat 0:6cc76d70e2a1 76 /*!
ubhat 0:6cc76d70e2a1 77 * Timer to handle the application data transmission duty cycle
ubhat 0:6cc76d70e2a1 78 */
ubhat 0:6cc76d70e2a1 79 TimerEvent_t TxNextPacketTimer;
ubhat 0:6cc76d70e2a1 80
ubhat 0:6cc76d70e2a1 81 /*!
ubhat 0:6cc76d70e2a1 82 * Indicates if a new transmit interrupt can be set
ubhat 0:6cc76d70e2a1 83 */
ubhat 0:6cc76d70e2a1 84 bool IsTxIntUpdate = false;
ubhat 0:6cc76d70e2a1 85
ubhat 0:6cc76d70e2a1 86 /*!
ubhat 0:6cc76d70e2a1 87 * Indicates if a new packet can be sent
ubhat 0:6cc76d70e2a1 88 */
ubhat 0:6cc76d70e2a1 89 bool NextTx = true;
ubhat 0:6cc76d70e2a1 90
ubhat 0:6cc76d70e2a1 91 /*!
ubhat 0:6cc76d70e2a1 92 * LoRaWAN compliance tests support data
ubhat 0:6cc76d70e2a1 93 */
ubhat 0:6cc76d70e2a1 94 ComplianceTest_s ComplianceTest;
ubhat 0:6cc76d70e2a1 95
ubhat 0:6cc76d70e2a1 96 /*!
ubhat 0:6cc76d70e2a1 97 * Indicates if the MAC layer network join status has changed.
ubhat 0:6cc76d70e2a1 98 */
ubhat 0:6cc76d70e2a1 99 bool IsNetworkJoinedStatusUpdate = false;
ubhat 0:6cc76d70e2a1 100
ubhat 0:6cc76d70e2a1 101 /*!
ubhat 0:6cc76d70e2a1 102 * Indicates if the message sent.
ubhat 0:6cc76d70e2a1 103 */
ubhat 0:6cc76d70e2a1 104 bool IsTxUpdate = false;
ubhat 0:6cc76d70e2a1 105
ubhat 0:6cc76d70e2a1 106 /*!
ubhat 0:6cc76d70e2a1 107 * Indicates if the message received in the RX window.
ubhat 0:6cc76d70e2a1 108 */
ubhat 0:6cc76d70e2a1 109 bool IsRxUpdate = false;
ubhat 0:6cc76d70e2a1 110
ubhat 0:6cc76d70e2a1 111
ubhat 0:6cc76d70e2a1 112 /**
ubhat 0:6cc76d70e2a1 113 * Main application entry point.
ubhat 0:6cc76d70e2a1 114 */
ubhat 0:6cc76d70e2a1 115 int main( void )
ubhat 0:6cc76d70e2a1 116 {
ubhat 0:6cc76d70e2a1 117
ubhat 0:6cc76d70e2a1 118 // Initialize board peripherals
ubhat 0:6cc76d70e2a1 119 BoardInit( );
ubhat 0:6cc76d70e2a1 120
ubhat 0:6cc76d70e2a1 121 // Initialize Device state
ubhat 0:6cc76d70e2a1 122 DeviceState = DEVICE_STATE_INIT;
ubhat 0:6cc76d70e2a1 123
ubhat 0:6cc76d70e2a1 124 while( 1 )
ubhat 0:6cc76d70e2a1 125 {
ubhat 0:6cc76d70e2a1 126 if( IsNetworkJoinedStatusUpdate == true )
ubhat 0:6cc76d70e2a1 127 {
ubhat 0:6cc76d70e2a1 128 IsNetworkJoinedStatusUpdate = false;
ubhat 0:6cc76d70e2a1 129
ubhat 0:6cc76d70e2a1 130 DeviceJoinUpdate( );
ubhat 0:6cc76d70e2a1 131 }
ubhat 0:6cc76d70e2a1 132
ubhat 0:6cc76d70e2a1 133 if( IsTxUpdate == true )
ubhat 0:6cc76d70e2a1 134 {
ubhat 0:6cc76d70e2a1 135 // If downlink received then update Serial Terminal and execute Rx event
ubhat 0:6cc76d70e2a1 136 IsTxUpdate = false;
ubhat 0:6cc76d70e2a1 137
ubhat 0:6cc76d70e2a1 138 // Update serial terminal
ubhat 0:6cc76d70e2a1 139 SerialDisplayTxUpdate( );
ubhat 0:6cc76d70e2a1 140 }
ubhat 0:6cc76d70e2a1 141
ubhat 0:6cc76d70e2a1 142 if( IsTxIntUpdate == true )
ubhat 0:6cc76d70e2a1 143 {
ubhat 0:6cc76d70e2a1 144 IsTxIntUpdate = false;
ubhat 0:6cc76d70e2a1 145
ubhat 0:6cc76d70e2a1 146 // Initialize next Tx Interrupt
ubhat 0:6cc76d70e2a1 147 InitNextTxInterrupt( AppPort );
ubhat 0:6cc76d70e2a1 148 }
ubhat 0:6cc76d70e2a1 149
ubhat 0:6cc76d70e2a1 150 if( IsRxUpdate == true )
ubhat 0:6cc76d70e2a1 151 {
ubhat 0:6cc76d70e2a1 152 // If downlink received then update Serial Terminal and execute Rx event
ubhat 0:6cc76d70e2a1 153 IsRxUpdate = false;
ubhat 0:6cc76d70e2a1 154 RxEvent( );
ubhat 0:6cc76d70e2a1 155 SerialDisplayRxUpdate( );
ubhat 0:6cc76d70e2a1 156 }
ubhat 0:6cc76d70e2a1 157
ubhat 0:6cc76d70e2a1 158 switch( DeviceState )
ubhat 0:6cc76d70e2a1 159 {
ubhat 0:6cc76d70e2a1 160 case DEVICE_STATE_INIT:
ubhat 0:6cc76d70e2a1 161 {
ubhat 0:6cc76d70e2a1 162 // Initialize MAC, MAC services, Primitives
ubhat 0:6cc76d70e2a1 163 DeviceInit( );
ubhat 0:6cc76d70e2a1 164
ubhat 0:6cc76d70e2a1 165 // Change Device state
ubhat 0:6cc76d70e2a1 166 DeviceState = DEVICE_STATE_JOIN;
ubhat 0:6cc76d70e2a1 167 break;
ubhat 0:6cc76d70e2a1 168 }
ubhat 0:6cc76d70e2a1 169 case DEVICE_STATE_JOIN:
ubhat 0:6cc76d70e2a1 170 {
ubhat 0:6cc76d70e2a1 171 #if( OVER_THE_AIR_ACTIVATION != 0 ) // OTA
ubhat 0:6cc76d70e2a1 172
ubhat 0:6cc76d70e2a1 173 // Generate DevEUI if not defined by User
ubhat 0:6cc76d70e2a1 174 BoardGetDevEUI( DevEui );
ubhat 0:6cc76d70e2a1 175
ubhat 0:6cc76d70e2a1 176 // Join N/w server
ubhat 0:6cc76d70e2a1 177 DeviceJoin( );
ubhat 0:6cc76d70e2a1 178
ubhat 0:6cc76d70e2a1 179 // Show on serial terminal
ubhat 0:6cc76d70e2a1 180 SerialDisplayJoinUpdate( );
ubhat 0:6cc76d70e2a1 181
ubhat 0:6cc76d70e2a1 182 // Execute Join event
ubhat 0:6cc76d70e2a1 183 JoinEvent( );
ubhat 0:6cc76d70e2a1 184
ubhat 0:6cc76d70e2a1 185 DeviceState = DEVICE_STATE_SLEEP;
ubhat 0:6cc76d70e2a1 186
ubhat 0:6cc76d70e2a1 187 #else // ABP
ubhat 0:6cc76d70e2a1 188 DeviceJoin( );
ubhat 0:6cc76d70e2a1 189
ubhat 0:6cc76d70e2a1 190 DeviceState = DEVICE_STATE_SEND;
ubhat 0:6cc76d70e2a1 191 #endif
ubhat 0:6cc76d70e2a1 192 IsNetworkJoinedStatusUpdate = true;
ubhat 0:6cc76d70e2a1 193 break;
ubhat 0:6cc76d70e2a1 194 }
ubhat 0:6cc76d70e2a1 195 case DEVICE_STATE_SEND:
ubhat 0:6cc76d70e2a1 196 {
ubhat 0:6cc76d70e2a1 197 if( NextTx == true )
ubhat 0:6cc76d70e2a1 198 {
ubhat 0:6cc76d70e2a1 199 // Prepare payload frame based on application port
ubhat 0:6cc76d70e2a1 200 PrepareTxFrame( AppPort );
ubhat 0:6cc76d70e2a1 201
ubhat 0:6cc76d70e2a1 202 // Send payload over the air
ubhat 0:6cc76d70e2a1 203 NextTx = SendFrame( );
ubhat 0:6cc76d70e2a1 204
ubhat 0:6cc76d70e2a1 205 // Execute transmit event
ubhat 0:6cc76d70e2a1 206 TxEvent( );
ubhat 0:6cc76d70e2a1 207 }
ubhat 0:6cc76d70e2a1 208
ubhat 0:6cc76d70e2a1 209 if( NextTx == false )
ubhat 0:6cc76d70e2a1 210 {
ubhat 0:6cc76d70e2a1 211 IsTxUpdate = true;
ubhat 0:6cc76d70e2a1 212 }
ubhat 0:6cc76d70e2a1 213
ubhat 0:6cc76d70e2a1 214 DeviceState = DEVICE_STATE_SLEEP;
ubhat 0:6cc76d70e2a1 215 break;
ubhat 0:6cc76d70e2a1 216 }
ubhat 0:6cc76d70e2a1 217 case DEVICE_STATE_SLEEP:
ubhat 0:6cc76d70e2a1 218 {
ubhat 0:6cc76d70e2a1 219 // Wake up through events
ubhat 0:6cc76d70e2a1 220 break;
ubhat 0:6cc76d70e2a1 221 }
ubhat 0:6cc76d70e2a1 222 default:
ubhat 0:6cc76d70e2a1 223 {
ubhat 0:6cc76d70e2a1 224 DeviceState = DEVICE_STATE_INIT;
ubhat 0:6cc76d70e2a1 225 break;
ubhat 0:6cc76d70e2a1 226 }
ubhat 0:6cc76d70e2a1 227 }
ubhat 0:6cc76d70e2a1 228 }
ubhat 0:6cc76d70e2a1 229 }