Demonstration of Class-A LoRaWAN device using NAMote-72
Dependencies: LoRaWAN-lib mbed lib_mpl3115a2 lib_mma8451q lib_gps SX1272Lib
Dependents: LoRaWAN-NAMote72-BVS-confirmed-tester-0-7v1_copy
LoRaWAN-NAMote72 Application Demo is a Class-A device example project using LoRaWAN-lib and SX1272Lib libraries.
This project is compliant with LoRaWAN V1.0.1 specification.
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
.
- 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)
Main.cpp (Device State Machine)
The end-device state machine is defined.
- Initial State : Device is initialized.
- Join State : For OTA, Join Request is transmitted to the network until Join Accept is received by the end-device. Join event function is called that sets Red LED ON.
- Send State : Transmit payload frame is prepared. Tx event is called that blinks the Red LED indicating uplink transmission.
- Cycle State : Next packet transmission is scheduled
LoRaEventProc.cpp (Events and On-board Application)
Define events during Join, Tx & Rx. Prepare TX packet by appending with appropriate application data.
- PrepareLoRaFrame(uint8_t port ) :
Prepare LoRa payload frame with on-board application data such as GPS, Temperature, Battery, etc. LoRa.ApplicationCall(AppType ) calls application AppType defined in
LoRaApp.cpp
. AppType is defined inLoRaApp.h
LoRaApp.cpp
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
LoRaDeviceStateProc.cpp
Process function calls corresponding to different Device states
LoRaMacLayerService.cpp
Define MAC Layer Services: MLME & MCPS
Serial Terminal Display
By using a serial port connection using applications such as teraterm or putty, one can view the status of the End-Device. Once the End-Device Joins the network, transmission parameters such as payload data, application port, message type etc. are displayed on the terminal.
Default Application Payload
This application defaults to sending uplink data to logical port 5. The application payload consists of:
Sample Application Payload Calculation for Longitude/Latitude
Payload => 00 19 F6 352BBA A94C20 FFFF
Temperature Calculation
19H => 2510
Temp = 25/2 = 12.5 oC
Battery Level
FFH => 100 %
F6H => 96.5 %
Longitude Calculation
longitude = A94C20H => 1109507210
longitudinal coordinate = -360 + (longitude10 x 180/(223))
longitudinal coordinate = -121.93
Latitude Calculation
latitude = 352BBAH = 348460210
latitude coordinate = (latitude10 x 90/(223-1))
latitude coordinate = 37.39
app/LoRaMacLayerService.cpp@19:678f15b08d8a, 2020-01-28 (annotated)
- Committer:
- nlam
- Date:
- Tue Jan 28 19:10:15 2020 +0000
- Revision:
- 19:678f15b08d8a
- Parent:
- 18:18408c3c2d0c
Updated to the Mbed latest libraries and resolved build error, uncommented debug.h.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ubhat | 0:69f2e28d12c1 | 1 | /* |
ubhat | 0:69f2e28d12c1 | 2 | / _____) _ | | |
ubhat | 0:69f2e28d12c1 | 3 | ( (____ _____ ____ _| |_ _____ ____| |__ |
ubhat | 0:69f2e28d12c1 | 4 | \____ \| ___ | (_ _) ___ |/ ___) _ \ |
ubhat | 0:69f2e28d12c1 | 5 | _____) ) ____| | | || |_| ____( (___| | | | |
ubhat | 0:69f2e28d12c1 | 6 | (______/|_____)_|_|_| \__)_____)\____)_| |_| |
ubhat | 0:69f2e28d12c1 | 7 | (C)2015 Semtech |
ubhat | 0:69f2e28d12c1 | 8 | |
ubhat | 0:69f2e28d12c1 | 9 | Description: MAC Layer Services: MLME & MCPS |
ubhat | 0:69f2e28d12c1 | 10 | |
ubhat | 0:69f2e28d12c1 | 11 | License: Revised BSD License, see LICENSE.TXT file include in the project |
ubhat | 0:69f2e28d12c1 | 12 | |
ubhat | 0:69f2e28d12c1 | 13 | Maintainer: Uttam Bhat |
ubhat | 0:69f2e28d12c1 | 14 | */ |
ubhat | 0:69f2e28d12c1 | 15 | |
ubhat | 0:69f2e28d12c1 | 16 | #include "LoRaMacLayerService.h" |
mluis | 18:18408c3c2d0c | 17 | #include "SerialDisplay.h" |
ubhat | 0:69f2e28d12c1 | 18 | |
ubhat | 0:69f2e28d12c1 | 19 | /*! |
ubhat | 0:69f2e28d12c1 | 20 | * \brief MCPS-Confirm event function |
ubhat | 0:69f2e28d12c1 | 21 | * |
ubhat | 0:69f2e28d12c1 | 22 | * \param [IN] McpsConfirm - Pointer to the confirm structure, |
ubhat | 0:69f2e28d12c1 | 23 | * containing confirm attributes. |
ubhat | 0:69f2e28d12c1 | 24 | */ |
mluis | 18:18408c3c2d0c | 25 | void McpsConfirm( McpsConfirm_t *mcpsConfirm ) |
ubhat | 0:69f2e28d12c1 | 26 | { |
mluis | 18:18408c3c2d0c | 27 | if( mcpsConfirm->Status == LORAMAC_EVENT_INFO_STATUS_OK ) |
ubhat | 0:69f2e28d12c1 | 28 | { |
mluis | 18:18408c3c2d0c | 29 | switch( mcpsConfirm->McpsRequest ) |
ubhat | 0:69f2e28d12c1 | 30 | { |
ubhat | 0:69f2e28d12c1 | 31 | case MCPS_UNCONFIRMED: |
ubhat | 0:69f2e28d12c1 | 32 | { |
ubhat | 0:69f2e28d12c1 | 33 | // Check Datarate |
ubhat | 0:69f2e28d12c1 | 34 | // Check TxPower |
ubhat | 0:69f2e28d12c1 | 35 | break; |
ubhat | 0:69f2e28d12c1 | 36 | } |
ubhat | 0:69f2e28d12c1 | 37 | case MCPS_CONFIRMED: |
ubhat | 0:69f2e28d12c1 | 38 | { |
ubhat | 0:69f2e28d12c1 | 39 | // Check Datarate |
ubhat | 0:69f2e28d12c1 | 40 | // Check TxPower |
ubhat | 0:69f2e28d12c1 | 41 | // Check AckReceived |
ubhat | 0:69f2e28d12c1 | 42 | // Check NbRetries |
mluis | 18:18408c3c2d0c | 43 | LoRaMacUplinkStatus.Acked = mcpsConfirm->AckReceived; |
ubhat | 0:69f2e28d12c1 | 44 | break; |
ubhat | 0:69f2e28d12c1 | 45 | } |
ubhat | 0:69f2e28d12c1 | 46 | case MCPS_PROPRIETARY: |
ubhat | 0:69f2e28d12c1 | 47 | { |
ubhat | 0:69f2e28d12c1 | 48 | break; |
ubhat | 0:69f2e28d12c1 | 49 | } |
ubhat | 0:69f2e28d12c1 | 50 | default: |
ubhat | 0:69f2e28d12c1 | 51 | break; |
ubhat | 0:69f2e28d12c1 | 52 | } |
ubhat | 0:69f2e28d12c1 | 53 | } |
ubhat | 0:69f2e28d12c1 | 54 | |
mluis | 18:18408c3c2d0c | 55 | LoRaMacUplinkStatus.Datarate = mcpsConfirm->Datarate; |
mluis | 18:18408c3c2d0c | 56 | LoRaMacUplinkStatus.UplinkCounter = mcpsConfirm->UpLinkCounter; |
mluis | 18:18408c3c2d0c | 57 | LoRaMacUplinkStatus.TxPower = mcpsConfirm->TxPower; |
mluis | 18:18408c3c2d0c | 58 | LoRaMacUplinkStatus.UpLinkFrequency = mcpsConfirm->UpLinkFrequency; |
mluis | 18:18408c3c2d0c | 59 | SerialDisplayTxUpdate( ); |
ubhat | 0:69f2e28d12c1 | 60 | |
ubhat | 5:6ffeac53b7cb | 61 | IsTxIntUpdate = true; |
mluis | 18:18408c3c2d0c | 62 | NextTx = true; |
ubhat | 0:69f2e28d12c1 | 63 | } |
ubhat | 0:69f2e28d12c1 | 64 | |
ubhat | 0:69f2e28d12c1 | 65 | /*! |
ubhat | 0:69f2e28d12c1 | 66 | * \brief MCPS-Indication event function |
ubhat | 0:69f2e28d12c1 | 67 | * |
ubhat | 0:69f2e28d12c1 | 68 | * \param [IN] McpsIndication - Pointer to the indication structure, |
ubhat | 0:69f2e28d12c1 | 69 | * containing indication attributes. |
ubhat | 0:69f2e28d12c1 | 70 | */ |
mluis | 18:18408c3c2d0c | 71 | void McpsIndication( McpsIndication_t *mcpsIndication ) |
ubhat | 0:69f2e28d12c1 | 72 | { |
ubhat | 0:69f2e28d12c1 | 73 | Gps.service( ); |
ubhat | 0:69f2e28d12c1 | 74 | |
mluis | 18:18408c3c2d0c | 75 | if( mcpsIndication->Status != LORAMAC_EVENT_INFO_STATUS_OK ) |
ubhat | 0:69f2e28d12c1 | 76 | { |
ubhat | 0:69f2e28d12c1 | 77 | return; |
ubhat | 0:69f2e28d12c1 | 78 | } |
ubhat | 0:69f2e28d12c1 | 79 | |
mluis | 18:18408c3c2d0c | 80 | switch( mcpsIndication->McpsIndication ) |
ubhat | 0:69f2e28d12c1 | 81 | { |
ubhat | 0:69f2e28d12c1 | 82 | case MCPS_UNCONFIRMED: |
ubhat | 0:69f2e28d12c1 | 83 | { |
ubhat | 0:69f2e28d12c1 | 84 | break; |
ubhat | 0:69f2e28d12c1 | 85 | } |
ubhat | 0:69f2e28d12c1 | 86 | case MCPS_CONFIRMED: |
ubhat | 0:69f2e28d12c1 | 87 | { |
ubhat | 0:69f2e28d12c1 | 88 | break; |
ubhat | 0:69f2e28d12c1 | 89 | } |
ubhat | 0:69f2e28d12c1 | 90 | case MCPS_PROPRIETARY: |
ubhat | 0:69f2e28d12c1 | 91 | { |
ubhat | 0:69f2e28d12c1 | 92 | break; |
ubhat | 0:69f2e28d12c1 | 93 | } |
ubhat | 0:69f2e28d12c1 | 94 | case MCPS_MULTICAST: |
ubhat | 0:69f2e28d12c1 | 95 | { |
ubhat | 0:69f2e28d12c1 | 96 | break; |
ubhat | 0:69f2e28d12c1 | 97 | } |
ubhat | 0:69f2e28d12c1 | 98 | default: |
ubhat | 0:69f2e28d12c1 | 99 | break; |
ubhat | 0:69f2e28d12c1 | 100 | } |
ubhat | 0:69f2e28d12c1 | 101 | |
ubhat | 0:69f2e28d12c1 | 102 | // Check Multicast |
ubhat | 0:69f2e28d12c1 | 103 | // Check Port |
ubhat | 0:69f2e28d12c1 | 104 | // Check Datarate |
ubhat | 0:69f2e28d12c1 | 105 | // Check FramePending |
ubhat | 0:69f2e28d12c1 | 106 | // Check Buffer |
ubhat | 0:69f2e28d12c1 | 107 | // Check BufferSize |
ubhat | 0:69f2e28d12c1 | 108 | // Check Rssi |
ubhat | 0:69f2e28d12c1 | 109 | // Check Snr |
ubhat | 0:69f2e28d12c1 | 110 | // Check RxSlot |
mluis | 18:18408c3c2d0c | 111 | LoRaMacDownlinkStatus.Rssi = mcpsIndication->Rssi; |
mluis | 18:18408c3c2d0c | 112 | if( mcpsIndication->Snr & 0x80 ) // The SNR sign bit is 1 |
ubhat | 0:69f2e28d12c1 | 113 | { |
ubhat | 0:69f2e28d12c1 | 114 | // Invert and divide by 4 |
mluis | 18:18408c3c2d0c | 115 | LoRaMacDownlinkStatus.Snr = ( ( ~mcpsIndication->Snr + 1 ) & 0xFF ) >> 2; |
ubhat | 0:69f2e28d12c1 | 116 | LoRaMacDownlinkStatus.Snr = -LoRaMacDownlinkStatus.Snr; |
ubhat | 0:69f2e28d12c1 | 117 | } |
ubhat | 0:69f2e28d12c1 | 118 | else |
ubhat | 0:69f2e28d12c1 | 119 | { |
ubhat | 0:69f2e28d12c1 | 120 | // Divide by 4 |
mluis | 18:18408c3c2d0c | 121 | LoRaMacDownlinkStatus.Snr = ( mcpsIndication->Snr & 0xFF ) >> 2; |
ubhat | 0:69f2e28d12c1 | 122 | } |
ubhat | 0:69f2e28d12c1 | 123 | LoRaMacDownlinkStatus.DownlinkCounter++; |
mluis | 18:18408c3c2d0c | 124 | LoRaMacDownlinkStatus.RxData = mcpsIndication->RxData; |
mluis | 18:18408c3c2d0c | 125 | LoRaMacDownlinkStatus.Port = mcpsIndication->Port; |
mluis | 18:18408c3c2d0c | 126 | LoRaMacDownlinkStatus.Buffer = mcpsIndication->Buffer; |
mluis | 18:18408c3c2d0c | 127 | LoRaMacDownlinkStatus.BufferSize = mcpsIndication->BufferSize; |
mluis | 18:18408c3c2d0c | 128 | LoRaMacDownlinkStatus.RxSlot = mcpsIndication->RxSlot; |
ubhat | 0:69f2e28d12c1 | 129 | |
ubhat | 0:69f2e28d12c1 | 130 | if( ComplianceTest.Running == 1 ) |
ubhat | 0:69f2e28d12c1 | 131 | { |
ubhat | 0:69f2e28d12c1 | 132 | ComplianceTest.DownLinkCounter++; |
ubhat | 0:69f2e28d12c1 | 133 | } |
mluis | 18:18408c3c2d0c | 134 | |
mluis | 18:18408c3c2d0c | 135 | if( mcpsIndication->RxData == true ) |
ubhat | 0:69f2e28d12c1 | 136 | { |
mluis | 18:18408c3c2d0c | 137 | switch( mcpsIndication->Port ) |
ubhat | 0:69f2e28d12c1 | 138 | { |
ubhat | 0:69f2e28d12c1 | 139 | case 1: // The application LED can be controlled on port 1 or 2 |
mluis | 18:18408c3c2d0c | 140 | case 2: |
ubhat | 0:69f2e28d12c1 | 141 | break; |
ubhat | 0:69f2e28d12c1 | 142 | case 224: |
mluis | 18:18408c3c2d0c | 143 | PrepareComplianceTestFrame( mcpsIndication ); |
ubhat | 0:69f2e28d12c1 | 144 | break; |
ubhat | 0:69f2e28d12c1 | 145 | default: |
ubhat | 0:69f2e28d12c1 | 146 | break; |
ubhat | 0:69f2e28d12c1 | 147 | } |
ubhat | 0:69f2e28d12c1 | 148 | } |
ubhat | 0:69f2e28d12c1 | 149 | |
ubhat | 0:69f2e28d12c1 | 150 | IsRxUpdate = true; |
ubhat | 0:69f2e28d12c1 | 151 | } |
ubhat | 0:69f2e28d12c1 | 152 | |
ubhat | 0:69f2e28d12c1 | 153 | /*! |
ubhat | 0:69f2e28d12c1 | 154 | * \brief MLME-Confirm event function |
ubhat | 0:69f2e28d12c1 | 155 | * |
ubhat | 0:69f2e28d12c1 | 156 | * \param [IN] MlmeConfirm - Pointer to the confirm structure, |
ubhat | 0:69f2e28d12c1 | 157 | * containing confirm attributes. |
ubhat | 0:69f2e28d12c1 | 158 | */ |
ubhat | 0:69f2e28d12c1 | 159 | void MlmeConfirm( MlmeConfirm_t *MlmeConfirm ) |
ubhat | 0:69f2e28d12c1 | 160 | { |
mluis | 18:18408c3c2d0c | 161 | MibRequestConfirm_t mibGet; |
mluis | 18:18408c3c2d0c | 162 | |
mluis | 18:18408c3c2d0c | 163 | // Debug for join not alternating between DR0/DR4 |
mluis | 18:18408c3c2d0c | 164 | if( MlmeConfirm->MlmeRequest == MLME_JOIN ) |
mluis | 18:18408c3c2d0c | 165 | { |
mluis | 18:18408c3c2d0c | 166 | mibGet.Type = MIB_CHANNELS_DATARATE; |
mluis | 18:18408c3c2d0c | 167 | LoRaMacMibGetRequestConfirm( &mibGet ); |
mluis | 18:18408c3c2d0c | 168 | SerialDisplayJoinDataRateUpdate( mibGet.Param.ChannelsDatarate ); |
mluis | 18:18408c3c2d0c | 169 | LoRaMacJoinStatus.LastDatarate = mibGet.Param.ChannelsDatarate; |
mluis | 18:18408c3c2d0c | 170 | } |
mluis | 18:18408c3c2d0c | 171 | |
ubhat | 0:69f2e28d12c1 | 172 | if( MlmeConfirm->Status == LORAMAC_EVENT_INFO_STATUS_OK ) |
ubhat | 0:69f2e28d12c1 | 173 | { |
ubhat | 0:69f2e28d12c1 | 174 | switch( MlmeConfirm->MlmeRequest ) |
ubhat | 0:69f2e28d12c1 | 175 | { |
ubhat | 0:69f2e28d12c1 | 176 | case MLME_JOIN: |
ubhat | 0:69f2e28d12c1 | 177 | { |
ubhat | 0:69f2e28d12c1 | 178 | // Status is OK, node has joined the network |
ubhat | 0:69f2e28d12c1 | 179 | IsNetworkJoinedStatusUpdate = true; |
mluis | 18:18408c3c2d0c | 180 | DeviceState = DEVICE_STATE_SEND; |
ubhat | 0:69f2e28d12c1 | 181 | break; |
ubhat | 0:69f2e28d12c1 | 182 | } |
ubhat | 0:69f2e28d12c1 | 183 | case MLME_LINK_CHECK: |
ubhat | 0:69f2e28d12c1 | 184 | { |
ubhat | 0:69f2e28d12c1 | 185 | // Check DemodMargin |
ubhat | 0:69f2e28d12c1 | 186 | // Check NbGateways |
ubhat | 0:69f2e28d12c1 | 187 | if( ComplianceTest.Running == true ) |
ubhat | 0:69f2e28d12c1 | 188 | { |
ubhat | 0:69f2e28d12c1 | 189 | ComplianceTest.LinkCheck = true; |
ubhat | 0:69f2e28d12c1 | 190 | ComplianceTest.DemodMargin = MlmeConfirm->DemodMargin; |
ubhat | 0:69f2e28d12c1 | 191 | ComplianceTest.NbGateways = MlmeConfirm->NbGateways; |
ubhat | 0:69f2e28d12c1 | 192 | } |
ubhat | 0:69f2e28d12c1 | 193 | break; |
ubhat | 0:69f2e28d12c1 | 194 | } |
ubhat | 0:69f2e28d12c1 | 195 | default: |
ubhat | 0:69f2e28d12c1 | 196 | break; |
ubhat | 0:69f2e28d12c1 | 197 | } |
ubhat | 0:69f2e28d12c1 | 198 | } |
ubhat | 0:69f2e28d12c1 | 199 | |
mluis | 18:18408c3c2d0c | 200 | NextTx = true; |
mluis | 18:18408c3c2d0c | 201 | } |