Mick Mick / LoRaWAN-lib

Forked LoRaWAN-lib for Legacy Gateway testing

Fork of LoRaWAN-lib by Miguel Luis

LoRaMac.h@10:e52525844705, 2017-04-20 (annotated)

Committer:
mick_ccc
Date:
Thu Apr 20 14:26:48 2017 +0000
Revision:
10:e52525844705
Parent:
8:2d237e069df2
Child:
9:d2da17dee1e2
Hacked for Legacy Gateway testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mluis 2:14a5d6ad92d5 1 /*!
mluis 2:14a5d6ad92d5 2 * \file LoRaMac.h
mluis 2:14a5d6ad92d5 3 *
mluis 2:14a5d6ad92d5 4 * \brief LoRa MAC layer implementation
mluis 2:14a5d6ad92d5 5 *
mluis 2:14a5d6ad92d5 6 * \copyright Revised BSD License, see section \ref LICENSE.
mluis 2:14a5d6ad92d5 7 *
mluis 2:14a5d6ad92d5 8 * \code
mluis 2:14a5d6ad92d5 9 * ______ _
mluis 2:14a5d6ad92d5 10 * / _____) _ | |
mluis 2:14a5d6ad92d5 11 * ( (____ _____ ____ _| |_ _____ ____| |__
mluis 2:14a5d6ad92d5 12 * \____ \| ___ | (_ _) ___ |/ ___) _ \
mluis 2:14a5d6ad92d5 13 * _____) ) ____| | | || |_| ____( (___| | | |
mluis 2:14a5d6ad92d5 14 * (______/|_____)_|_|_| \__)_____)\____)_| |_|
mluis 2:14a5d6ad92d5 15 * (C)2013 Semtech
mluis 2:14a5d6ad92d5 16 *
mluis 2:14a5d6ad92d5 17 * ___ _____ _ ___ _ _____ ___ ___ ___ ___
mluis 2:14a5d6ad92d5 18 * / __|_ _/_\ / __| |/ / __/ _ \| _ \/ __| __|
mluis 2:14a5d6ad92d5 19 * \__ \ | |/ _ \ (__| ' <| _| (_) | / (__| _|
mluis 2:14a5d6ad92d5 20 * |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
mluis 2:14a5d6ad92d5 21 * embedded.connectivity.solutions===============
mluis 2:14a5d6ad92d5 22 *
mluis 2:14a5d6ad92d5 23 * \endcode
mluis 2:14a5d6ad92d5 24 *
mluis 2:14a5d6ad92d5 25 * \author Miguel Luis ( Semtech )
mluis 2:14a5d6ad92d5 26 *
mluis 2:14a5d6ad92d5 27 * \author Gregory Cristian ( Semtech )
mluis 2:14a5d6ad92d5 28 *
mluis 2:14a5d6ad92d5 29 * \author Daniel Jäckle ( STACKFORCE )
mluis 2:14a5d6ad92d5 30 *
mluis 2:14a5d6ad92d5 31 * \defgroup LORAMAC LoRa MAC layer implementation
mluis 2:14a5d6ad92d5 32 * This module specifies the API implementation of the LoRaMAC layer.
mluis 2:14a5d6ad92d5 33 * This is a placeholder for a detailed description of the LoRaMac
mluis 2:14a5d6ad92d5 34 * layer and the supported features.
mluis 2:14a5d6ad92d5 35 * \{
mluis 2:14a5d6ad92d5 36 *
mluis 2:14a5d6ad92d5 37 * \example classA/LoRaMote/main.c
mluis 2:14a5d6ad92d5 38 * LoRaWAN class A application example for the LoRaMote.
mluis 2:14a5d6ad92d5 39 *
mluis 2:14a5d6ad92d5 40 * \example classB/LoRaMote/main.c
mluis 2:14a5d6ad92d5 41 * LoRaWAN class B application example for the LoRaMote.
mluis 2:14a5d6ad92d5 42 *
mluis 2:14a5d6ad92d5 43 * \example classC/LoRaMote/main.c
mluis 2:14a5d6ad92d5 44 * LoRaWAN class C application example for the LoRaMote.
mluis 2:14a5d6ad92d5 45 */
mluis 0:91d1a7783bb9 46 #ifndef __LORAMAC_H__
mluis 0:91d1a7783bb9 47 #define __LORAMAC_H__
mluis 0:91d1a7783bb9 48
mluis 0:91d1a7783bb9 49 // Includes board dependent definitions such as channels frequencies
mluis 7:c16969e0f70f 50 #include "LoRaMac-definitions.h"
mluis 0:91d1a7783bb9 51
mluis 0:91d1a7783bb9 52 /*!
mluis 8:2d237e069df2 53 * System overall timing error in milliseconds.
mluis 8:2d237e069df2 54 * [-DEFAULT_SYSTEM_MAX_RX_ERROR : +DEFAULT_SYSTEM_MAX_RX_ERROR]
mluis 0:91d1a7783bb9 55 */
mluis 8:2d237e069df2 56 #define DEFAULT_SYSTEM_MAX_RX_ERROR 10
mluis 0:91d1a7783bb9 57
mluis 0:91d1a7783bb9 58 /*!
mluis 8:2d237e069df2 59 * Minimum required number of symbols to detect an Rx frame
mluis 0:91d1a7783bb9 60 */
mluis 8:2d237e069df2 61 #define DEFAULT_MIN_RX_SYMBOLS 6
mluis 8:2d237e069df2 62
mluis 8:2d237e069df2 63 /*!
mluis 8:2d237e069df2 64 * Beacon interval in ms
mluis 8:2d237e069df2 65 */
mluis 8:2d237e069df2 66 #define BEACON_INTERVAL 128000
mluis 2:14a5d6ad92d5 67
mluis 2:14a5d6ad92d5 68 /*!
mluis 8:2d237e069df2 69 * Class A&B receive delay 1 in ms
mluis 2:14a5d6ad92d5 70 */
mluis 8:2d237e069df2 71 #define RECEIVE_DELAY1 1000
mluis 8:2d237e069df2 72
mluis 8:2d237e069df2 73 /*!
mluis 8:2d237e069df2 74 * Class A&B receive delay 2 in ms
mluis 8:2d237e069df2 75 */
mluis 8:2d237e069df2 76 #define RECEIVE_DELAY2 2000
mluis 0:91d1a7783bb9 77
mluis 0:91d1a7783bb9 78 /*!
mluis 8:2d237e069df2 79 * Join accept receive delay 1 in ms
mluis 0:91d1a7783bb9 80 */
mluis 8:2d237e069df2 81 #define JOIN_ACCEPT_DELAY1 5000
mluis 2:14a5d6ad92d5 82
mluis 2:14a5d6ad92d5 83 /*!
mluis 8:2d237e069df2 84 * Join accept receive delay 2 in ms
mluis 2:14a5d6ad92d5 85 */
mluis 8:2d237e069df2 86 #define JOIN_ACCEPT_DELAY2 6000
mluis 0:91d1a7783bb9 87
mluis 0:91d1a7783bb9 88 /*!
mluis 8:2d237e069df2 89 * Class A&B maximum receive window delay in ms
mluis 0:91d1a7783bb9 90 */
mluis 8:2d237e069df2 91 #define MAX_RX_WINDOW 3000
mluis 0:91d1a7783bb9 92
mluis 0:91d1a7783bb9 93 /*!
mluis 0:91d1a7783bb9 94 * Maximum allowed gap for the FCNT field
mluis 0:91d1a7783bb9 95 */
mluis 0:91d1a7783bb9 96 #define MAX_FCNT_GAP 16384
mluis 0:91d1a7783bb9 97
mluis 0:91d1a7783bb9 98 /*!
mluis 0:91d1a7783bb9 99 * ADR acknowledgement counter limit
mluis 0:91d1a7783bb9 100 */
mluis 0:91d1a7783bb9 101 #define ADR_ACK_LIMIT 64
mluis 0:91d1a7783bb9 102
mluis 0:91d1a7783bb9 103 /*!
mluis 0:91d1a7783bb9 104 * Number of ADR acknowledgement requests before returning to default datarate
mluis 0:91d1a7783bb9 105 */
mluis 0:91d1a7783bb9 106 #define ADR_ACK_DELAY 32
mluis 0:91d1a7783bb9 107
mluis 0:91d1a7783bb9 108 /*!
mluis 0:91d1a7783bb9 109 * Number of seconds after the start of the second reception window without
mluis 0:91d1a7783bb9 110 * receiving an acknowledge.
mluis 2:14a5d6ad92d5 111 * AckTimeout = \ref ACK_TIMEOUT + Random( -\ref ACK_TIMEOUT_RND, \ref ACK_TIMEOUT_RND )
mluis 0:91d1a7783bb9 112 */
mluis 8:2d237e069df2 113 #define ACK_TIMEOUT 2000
mluis 0:91d1a7783bb9 114
mluis 0:91d1a7783bb9 115 /*!
mluis 0:91d1a7783bb9 116 * Random number of seconds after the start of the second reception window without
mluis 0:91d1a7783bb9 117 * receiving an acknowledge
mluis 2:14a5d6ad92d5 118 * AckTimeout = \ref ACK_TIMEOUT + Random( -\ref ACK_TIMEOUT_RND, \ref ACK_TIMEOUT_RND )
mluis 0:91d1a7783bb9 119 */
mluis 8:2d237e069df2 120 #define ACK_TIMEOUT_RND 1000
mluis 0:91d1a7783bb9 121
mluis 0:91d1a7783bb9 122 /*!
mluis 8:2d237e069df2 123 * Check the Mac layer state every MAC_STATE_CHECK_TIMEOUT in ms
mluis 0:91d1a7783bb9 124 */
mluis 8:2d237e069df2 125 #define MAC_STATE_CHECK_TIMEOUT 1000
mluis 0:91d1a7783bb9 126
mluis 0:91d1a7783bb9 127 /*!
mluis 0:91d1a7783bb9 128 * Maximum number of times the MAC layer tries to get an acknowledge.
mluis 0:91d1a7783bb9 129 */
mluis 0:91d1a7783bb9 130 #define MAX_ACK_RETRIES 8
mluis 0:91d1a7783bb9 131
mluis 0:91d1a7783bb9 132 /*!
mluis 2:14a5d6ad92d5 133 * RSSI free threshold [dBm]
mluis 0:91d1a7783bb9 134 */
mluis 2:14a5d6ad92d5 135 #define RSSI_FREE_TH ( int8_t )( -90 )
mluis 0:91d1a7783bb9 136
mluis 2:14a5d6ad92d5 137 /*!
mluis 2:14a5d6ad92d5 138 * Frame direction definition for up-link communications
mluis 0:91d1a7783bb9 139 */
mluis 0:91d1a7783bb9 140 #define UP_LINK 0
mluis 2:14a5d6ad92d5 141
mluis 2:14a5d6ad92d5 142 /*!
mluis 2:14a5d6ad92d5 143 * Frame direction definition for down-link communications
mluis 2:14a5d6ad92d5 144 */
mluis 0:91d1a7783bb9 145 #define DOWN_LINK 1
mluis 0:91d1a7783bb9 146
mluis 0:91d1a7783bb9 147 /*!
mluis 0:91d1a7783bb9 148 * Sets the length of the LoRaMAC footer field.
mluis 0:91d1a7783bb9 149 * Mainly indicates the MIC field length
mluis 0:91d1a7783bb9 150 */
mluis 0:91d1a7783bb9 151 #define LORAMAC_MFR_LEN 4
mluis 0:91d1a7783bb9 152
mluis 0:91d1a7783bb9 153 /*!
mluis 0:91d1a7783bb9 154 * LoRaWAN devices classes definition
mluis 0:91d1a7783bb9 155 */
mluis 2:14a5d6ad92d5 156 typedef enum eDeviceClass
mluis 0:91d1a7783bb9 157 {
mluis 2:14a5d6ad92d5 158 /*!
mluis 2:14a5d6ad92d5 159 * LoRaWAN device class A
mluis 2:14a5d6ad92d5 160 *
mluis 7:c16969e0f70f 161 * LoRaWAN Specification V1.0.1, chapter 3ff
mluis 2:14a5d6ad92d5 162 */
mluis 0:91d1a7783bb9 163 CLASS_A,
mluis 2:14a5d6ad92d5 164 /*!
mluis 2:14a5d6ad92d5 165 * LoRaWAN device class B
mluis 2:14a5d6ad92d5 166 *
mluis 7:c16969e0f70f 167 * LoRaWAN Specification V1.0.1, chapter 8ff
mluis 2:14a5d6ad92d5 168 */
mluis 0:91d1a7783bb9 169 CLASS_B,
mluis 2:14a5d6ad92d5 170 /*!
mluis 2:14a5d6ad92d5 171 * LoRaWAN device class C
mluis 2:14a5d6ad92d5 172 *
mluis 7:c16969e0f70f 173 * LoRaWAN Specification V1.0.1, chapter 17ff
mluis 2:14a5d6ad92d5 174 */
mluis 0:91d1a7783bb9 175 CLASS_C,
mluis 0:91d1a7783bb9 176 }DeviceClass_t;
mluis 0:91d1a7783bb9 177
mluis 0:91d1a7783bb9 178 /*!
mluis 0:91d1a7783bb9 179 * LoRaMAC channels parameters definition
mluis 0:91d1a7783bb9 180 */
mluis 2:14a5d6ad92d5 181 typedef union uDrRange
mluis 0:91d1a7783bb9 182 {
mluis 2:14a5d6ad92d5 183 /*!
mluis 2:14a5d6ad92d5 184 * Byte-access to the bits
mluis 2:14a5d6ad92d5 185 */
mluis 0:91d1a7783bb9 186 int8_t Value;
mluis 2:14a5d6ad92d5 187 /*!
mluis 2:14a5d6ad92d5 188 * Structure to store the minimum and the maximum datarate
mluis 2:14a5d6ad92d5 189 */
mluis 2:14a5d6ad92d5 190 struct sFields
mluis 0:91d1a7783bb9 191 {
mluis 2:14a5d6ad92d5 192 /*!
mluis 2:14a5d6ad92d5 193 * Minimum data rate
mluis 2:14a5d6ad92d5 194 *
mluis 2:14a5d6ad92d5 195 * EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
mluis 2:14a5d6ad92d5 196 *
mluis 2:14a5d6ad92d5 197 * US915 - [DR_0, DR_1, DR_2, DR_3, DR_4]
mluis 2:14a5d6ad92d5 198 */
mluis 0:91d1a7783bb9 199 int8_t Min : 4;
mluis 2:14a5d6ad92d5 200 /*!
mluis 2:14a5d6ad92d5 201 * Maximum data rate
mluis 2:14a5d6ad92d5 202 *
mluis 2:14a5d6ad92d5 203 * EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
mluis 2:14a5d6ad92d5 204 *
mluis 2:14a5d6ad92d5 205 * US915 - [DR_0, DR_1, DR_2, DR_3, DR_4]
mluis 2:14a5d6ad92d5 206 */
mluis 0:91d1a7783bb9 207 int8_t Max : 4;
mluis 0:91d1a7783bb9 208 }Fields;
mluis 0:91d1a7783bb9 209 }DrRange_t;
mluis 0:91d1a7783bb9 210
mluis 2:14a5d6ad92d5 211 /*!
mluis 2:14a5d6ad92d5 212 * LoRaMAC band parameters definition
mluis 2:14a5d6ad92d5 213 */
mluis 2:14a5d6ad92d5 214 typedef struct sBand
mluis 0:91d1a7783bb9 215 {
mluis 2:14a5d6ad92d5 216 /*!
mluis 2:14a5d6ad92d5 217 * Duty cycle
mluis 2:14a5d6ad92d5 218 */
mluis 0:91d1a7783bb9 219 uint16_t DCycle;
mluis 2:14a5d6ad92d5 220 /*!
mluis 2:14a5d6ad92d5 221 * Maximum Tx power
mluis 2:14a5d6ad92d5 222 */
mluis 0:91d1a7783bb9 223 int8_t TxMaxPower;
mluis 2:14a5d6ad92d5 224 /*!
mluis 2:14a5d6ad92d5 225 * Time stamp of the last Tx frame
mluis 2:14a5d6ad92d5 226 */
mluis 2:14a5d6ad92d5 227 TimerTime_t LastTxDoneTime;
mluis 2:14a5d6ad92d5 228 /*!
mluis 2:14a5d6ad92d5 229 * Holds the time where the device is off
mluis 2:14a5d6ad92d5 230 */
mluis 2:14a5d6ad92d5 231 TimerTime_t TimeOff;
mluis 0:91d1a7783bb9 232 }Band_t;
mluis 0:91d1a7783bb9 233
mluis 2:14a5d6ad92d5 234 /*!
mluis 2:14a5d6ad92d5 235 * LoRaMAC channel definition
mluis 2:14a5d6ad92d5 236 */
mluis 2:14a5d6ad92d5 237 typedef struct sChannelParams
mluis 0:91d1a7783bb9 238 {
mluis 2:14a5d6ad92d5 239 /*!
mluis 2:14a5d6ad92d5 240 * Frequency in Hz
mluis 2:14a5d6ad92d5 241 */
mluis 2:14a5d6ad92d5 242 uint32_t Frequency;
mluis 2:14a5d6ad92d5 243 /*!
mluis 2:14a5d6ad92d5 244 * Data rate definition
mluis 2:14a5d6ad92d5 245 */
mluis 2:14a5d6ad92d5 246 DrRange_t DrRange;
mluis 2:14a5d6ad92d5 247 /*!
mluis 2:14a5d6ad92d5 248 * Band index
mluis 2:14a5d6ad92d5 249 */
mluis 2:14a5d6ad92d5 250 uint8_t Band;
mluis 0:91d1a7783bb9 251 }ChannelParams_t;
mluis 0:91d1a7783bb9 252
mluis 2:14a5d6ad92d5 253 /*!
mluis 2:14a5d6ad92d5 254 * LoRaMAC receive window 2 channel parameters
mluis 2:14a5d6ad92d5 255 */
mluis 2:14a5d6ad92d5 256 typedef struct sRx2ChannelParams
mluis 0:91d1a7783bb9 257 {
mluis 2:14a5d6ad92d5 258 /*!
mluis 2:14a5d6ad92d5 259 * Frequency in Hz
mluis 2:14a5d6ad92d5 260 */
mluis 2:14a5d6ad92d5 261 uint32_t Frequency;
mluis 2:14a5d6ad92d5 262 /*!
mluis 2:14a5d6ad92d5 263 * Data rate
mluis 2:14a5d6ad92d5 264 *
mluis 2:14a5d6ad92d5 265 * EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
mluis 2:14a5d6ad92d5 266 *
mluis 2:14a5d6ad92d5 267 * US915 - [DR_8, DR_9, DR_10, DR_11, DR_12, DR_13]
mluis 2:14a5d6ad92d5 268 */
mluis 2:14a5d6ad92d5 269 uint8_t Datarate;
mluis 0:91d1a7783bb9 270 }Rx2ChannelParams_t;
mluis 0:91d1a7783bb9 271
mluis 2:14a5d6ad92d5 272 /*!
mluis 7:c16969e0f70f 273 * Global MAC layer parameters
mluis 7:c16969e0f70f 274 */
mluis 7:c16969e0f70f 275 typedef struct sLoRaMacParams
mluis 7:c16969e0f70f 276 {
mluis 7:c16969e0f70f 277 /*!
mluis 7:c16969e0f70f 278 * Channels TX power
mluis 7:c16969e0f70f 279 */
mluis 7:c16969e0f70f 280 int8_t ChannelsTxPower;
mluis 7:c16969e0f70f 281 /*!
mluis 7:c16969e0f70f 282 * Channels data rate
mluis 7:c16969e0f70f 283 */
mluis 7:c16969e0f70f 284 int8_t ChannelsDatarate;
mluis 7:c16969e0f70f 285 /*!
mluis 7:c16969e0f70f 286 * LoRaMac maximum time a reception window stays open
mluis 7:c16969e0f70f 287 */
mluis 7:c16969e0f70f 288 uint32_t MaxRxWindow;
mluis 7:c16969e0f70f 289 /*!
mluis 7:c16969e0f70f 290 * Receive delay 1
mluis 7:c16969e0f70f 291 */
mluis 7:c16969e0f70f 292 uint32_t ReceiveDelay1;
mluis 7:c16969e0f70f 293 /*!
mluis 7:c16969e0f70f 294 * Receive delay 2
mluis 7:c16969e0f70f 295 */
mluis 7:c16969e0f70f 296 uint32_t ReceiveDelay2;
mluis 7:c16969e0f70f 297 /*!
mluis 7:c16969e0f70f 298 * Join accept delay 1
mluis 7:c16969e0f70f 299 */
mluis 7:c16969e0f70f 300 uint32_t JoinAcceptDelay1;
mluis 7:c16969e0f70f 301 /*!
mluis 7:c16969e0f70f 302 * Join accept delay 1
mluis 7:c16969e0f70f 303 */
mluis 7:c16969e0f70f 304 uint32_t JoinAcceptDelay2;
mluis 7:c16969e0f70f 305 /*!
mluis 7:c16969e0f70f 306 * Number of uplink messages repetitions [1:15] (unconfirmed messages only)
mluis 7:c16969e0f70f 307 */
mluis 7:c16969e0f70f 308 uint8_t ChannelsNbRep;
mluis 7:c16969e0f70f 309 /*!
mluis 7:c16969e0f70f 310 * Datarate offset between uplink and downlink on first window
mluis 7:c16969e0f70f 311 */
mluis 7:c16969e0f70f 312 uint8_t Rx1DrOffset;
mluis 7:c16969e0f70f 313 /*!
mluis 7:c16969e0f70f 314 * LoRaMAC 2nd reception window settings
mluis 7:c16969e0f70f 315 */
mluis 7:c16969e0f70f 316 Rx2ChannelParams_t Rx2Channel;
mluis 7:c16969e0f70f 317 /*!
mluis 7:c16969e0f70f 318 * Mask indicating which channels are enabled
mluis 7:c16969e0f70f 319 */
mluis 7:c16969e0f70f 320 uint16_t ChannelsMask[6];
mluis 7:c16969e0f70f 321 }LoRaMacParams_t;
mluis 7:c16969e0f70f 322
mluis 7:c16969e0f70f 323 /*!
mluis 2:14a5d6ad92d5 324 * LoRaMAC multicast channel parameter
mluis 2:14a5d6ad92d5 325 */
mluis 2:14a5d6ad92d5 326 typedef struct sMulticastParams
mluis 0:91d1a7783bb9 327 {
mluis 2:14a5d6ad92d5 328 /*!
mluis 2:14a5d6ad92d5 329 * Address
mluis 2:14a5d6ad92d5 330 */
mluis 0:91d1a7783bb9 331 uint32_t Address;
mluis 2:14a5d6ad92d5 332 /*!
mluis 2:14a5d6ad92d5 333 * Network session key
mluis 2:14a5d6ad92d5 334 */
mluis 0:91d1a7783bb9 335 uint8_t NwkSKey[16];
mluis 2:14a5d6ad92d5 336 /*!
mluis 2:14a5d6ad92d5 337 * Application session key
mluis 2:14a5d6ad92d5 338 */
mluis 0:91d1a7783bb9 339 uint8_t AppSKey[16];
mluis 2:14a5d6ad92d5 340 /*!
mluis 2:14a5d6ad92d5 341 * Downlink counter
mluis 2:14a5d6ad92d5 342 */
mluis 0:91d1a7783bb9 343 uint32_t DownLinkCounter;
mluis 2:14a5d6ad92d5 344 /*!
mluis 2:14a5d6ad92d5 345 * Reference pointer to the next multicast channel parameters in the list
mluis 2:14a5d6ad92d5 346 */
mluis 2:14a5d6ad92d5 347 struct sMulticastParams *Next;
mluis 0:91d1a7783bb9 348 }MulticastParams_t;
mluis 0:91d1a7783bb9 349
mluis 0:91d1a7783bb9 350 /*!
mluis 0:91d1a7783bb9 351 * LoRaMAC frame types
mluis 2:14a5d6ad92d5 352 *
mluis 7:c16969e0f70f 353 * LoRaWAN Specification V1.0.1, chapter 4.2.1, table 1
mluis 0:91d1a7783bb9 354 */
mluis 2:14a5d6ad92d5 355 typedef enum eLoRaMacFrameType
mluis 0:91d1a7783bb9 356 {
mluis 2:14a5d6ad92d5 357 /*!
mluis 2:14a5d6ad92d5 358 * LoRaMAC join request frame
mluis 2:14a5d6ad92d5 359 */
mluis 0:91d1a7783bb9 360 FRAME_TYPE_JOIN_REQ = 0x00,
mluis 2:14a5d6ad92d5 361 /*!
mluis 2:14a5d6ad92d5 362 * LoRaMAC join accept frame
mluis 2:14a5d6ad92d5 363 */
mluis 0:91d1a7783bb9 364 FRAME_TYPE_JOIN_ACCEPT = 0x01,
mluis 2:14a5d6ad92d5 365 /*!
mluis 2:14a5d6ad92d5 366 * LoRaMAC unconfirmed up-link frame
mluis 2:14a5d6ad92d5 367 */
mluis 0:91d1a7783bb9 368 FRAME_TYPE_DATA_UNCONFIRMED_UP = 0x02,
mluis 2:14a5d6ad92d5 369 /*!
mluis 2:14a5d6ad92d5 370 * LoRaMAC unconfirmed down-link frame
mluis 2:14a5d6ad92d5 371 */
mluis 0:91d1a7783bb9 372 FRAME_TYPE_DATA_UNCONFIRMED_DOWN = 0x03,
mluis 2:14a5d6ad92d5 373 /*!
mluis 2:14a5d6ad92d5 374 * LoRaMAC confirmed up-link frame
mluis 2:14a5d6ad92d5 375 */
mluis 0:91d1a7783bb9 376 FRAME_TYPE_DATA_CONFIRMED_UP = 0x04,
mluis 2:14a5d6ad92d5 377 /*!
mluis 2:14a5d6ad92d5 378 * LoRaMAC confirmed down-link frame
mluis 2:14a5d6ad92d5 379 */
mluis 0:91d1a7783bb9 380 FRAME_TYPE_DATA_CONFIRMED_DOWN = 0x05,
mluis 2:14a5d6ad92d5 381 /*!
mluis 2:14a5d6ad92d5 382 * LoRaMAC RFU frame
mluis 2:14a5d6ad92d5 383 */
mluis 0:91d1a7783bb9 384 FRAME_TYPE_RFU = 0x06,
mluis 2:14a5d6ad92d5 385 /*!
mluis 2:14a5d6ad92d5 386 * LoRaMAC proprietary frame
mluis 2:14a5d6ad92d5 387 */
mluis 0:91d1a7783bb9 388 FRAME_TYPE_PROPRIETARY = 0x07,
mluis 0:91d1a7783bb9 389 }LoRaMacFrameType_t;
mluis 0:91d1a7783bb9 390
mluis 0:91d1a7783bb9 391 /*!
mluis 0:91d1a7783bb9 392 * LoRaMAC mote MAC commands
mluis 2:14a5d6ad92d5 393 *
mluis 7:c16969e0f70f 394 * LoRaWAN Specification V1.0.1, chapter 5, table 4
mluis 0:91d1a7783bb9 395 */
mluis 2:14a5d6ad92d5 396 typedef enum eLoRaMacMoteCmd
mluis 0:91d1a7783bb9 397 {
mluis 2:14a5d6ad92d5 398 /*!
mluis 2:14a5d6ad92d5 399 * LinkCheckReq
mluis 2:14a5d6ad92d5 400 */
mluis 0:91d1a7783bb9 401 MOTE_MAC_LINK_CHECK_REQ = 0x02,
mluis 2:14a5d6ad92d5 402 /*!
mluis 2:14a5d6ad92d5 403 * LinkADRAns
mluis 2:14a5d6ad92d5 404 */
mluis 0:91d1a7783bb9 405 MOTE_MAC_LINK_ADR_ANS = 0x03,
mluis 2:14a5d6ad92d5 406 /*!
mluis 2:14a5d6ad92d5 407 * DutyCycleAns
mluis 2:14a5d6ad92d5 408 */
mluis 0:91d1a7783bb9 409 MOTE_MAC_DUTY_CYCLE_ANS = 0x04,
mluis 2:14a5d6ad92d5 410 /*!
mluis 2:14a5d6ad92d5 411 * RXParamSetupAns
mluis 2:14a5d6ad92d5 412 */
mluis 0:91d1a7783bb9 413 MOTE_MAC_RX_PARAM_SETUP_ANS = 0x05,
mluis 2:14a5d6ad92d5 414 /*!
mluis 2:14a5d6ad92d5 415 * DevStatusAns
mluis 2:14a5d6ad92d5 416 */
mluis 0:91d1a7783bb9 417 MOTE_MAC_DEV_STATUS_ANS = 0x06,
mluis 2:14a5d6ad92d5 418 /*!
mluis 2:14a5d6ad92d5 419 * NewChannelAns
mluis 2:14a5d6ad92d5 420 */
mluis 0:91d1a7783bb9 421 MOTE_MAC_NEW_CHANNEL_ANS = 0x07,
mluis 2:14a5d6ad92d5 422 /*!
mluis 2:14a5d6ad92d5 423 * RXTimingSetupAns
mluis 2:14a5d6ad92d5 424 */
mluis 0:91d1a7783bb9 425 MOTE_MAC_RX_TIMING_SETUP_ANS = 0x08,
mluis 0:91d1a7783bb9 426 }LoRaMacMoteCmd_t;
mluis 0:91d1a7783bb9 427
mluis 0:91d1a7783bb9 428 /*!
mluis 0:91d1a7783bb9 429 * LoRaMAC server MAC commands
mluis 2:14a5d6ad92d5 430 *
mluis 7:c16969e0f70f 431 * LoRaWAN Specification V1.0.1 chapter 5, table 4
mluis 0:91d1a7783bb9 432 */
mluis 2:14a5d6ad92d5 433 typedef enum eLoRaMacSrvCmd
mluis 0:91d1a7783bb9 434 {
mluis 2:14a5d6ad92d5 435 /*!
mluis 2:14a5d6ad92d5 436 * LinkCheckAns
mluis 2:14a5d6ad92d5 437 */
mluis 0:91d1a7783bb9 438 SRV_MAC_LINK_CHECK_ANS = 0x02,
mluis 2:14a5d6ad92d5 439 /*!
mluis 2:14a5d6ad92d5 440 * LinkADRReq
mluis 2:14a5d6ad92d5 441 */
mluis 0:91d1a7783bb9 442 SRV_MAC_LINK_ADR_REQ = 0x03,
mluis 2:14a5d6ad92d5 443 /*!
mluis 2:14a5d6ad92d5 444 * DutyCycleReq
mluis 2:14a5d6ad92d5 445 */
mluis 0:91d1a7783bb9 446 SRV_MAC_DUTY_CYCLE_REQ = 0x04,
mluis 2:14a5d6ad92d5 447 /*!
mluis 2:14a5d6ad92d5 448 * RXParamSetupReq
mluis 2:14a5d6ad92d5 449 */
mluis 0:91d1a7783bb9 450 SRV_MAC_RX_PARAM_SETUP_REQ = 0x05,
mluis 2:14a5d6ad92d5 451 /*!
mluis 2:14a5d6ad92d5 452 * DevStatusReq
mluis 2:14a5d6ad92d5 453 */
mluis 0:91d1a7783bb9 454 SRV_MAC_DEV_STATUS_REQ = 0x06,
mluis 2:14a5d6ad92d5 455 /*!
mluis 2:14a5d6ad92d5 456 * NewChannelReq
mluis 2:14a5d6ad92d5 457 */
mluis 0:91d1a7783bb9 458 SRV_MAC_NEW_CHANNEL_REQ = 0x07,
mluis 2:14a5d6ad92d5 459 /*!
mluis 2:14a5d6ad92d5 460 * RXTimingSetupReq
mluis 2:14a5d6ad92d5 461 */
mluis 0:91d1a7783bb9 462 SRV_MAC_RX_TIMING_SETUP_REQ = 0x08,
mluis 0:91d1a7783bb9 463 }LoRaMacSrvCmd_t;
mluis 0:91d1a7783bb9 464
mluis 0:91d1a7783bb9 465 /*!
mluis 0:91d1a7783bb9 466 * LoRaMAC Battery level indicator
mluis 0:91d1a7783bb9 467 */
mluis 2:14a5d6ad92d5 468 typedef enum eLoRaMacBatteryLevel
mluis 0:91d1a7783bb9 469 {
mluis 2:14a5d6ad92d5 470 /*!
mluis 2:14a5d6ad92d5 471 * External power source
mluis 2:14a5d6ad92d5 472 */
mluis 0:91d1a7783bb9 473 BAT_LEVEL_EXT_SRC = 0x00,
mluis 2:14a5d6ad92d5 474 /*!
mluis 2:14a5d6ad92d5 475 * Battery level empty
mluis 2:14a5d6ad92d5 476 */
mluis 0:91d1a7783bb9 477 BAT_LEVEL_EMPTY = 0x01,
mluis 2:14a5d6ad92d5 478 /*!
mluis 2:14a5d6ad92d5 479 * Battery level full
mluis 2:14a5d6ad92d5 480 */
mluis 0:91d1a7783bb9 481 BAT_LEVEL_FULL = 0xFE,
mluis 2:14a5d6ad92d5 482 /*!
mluis 2:14a5d6ad92d5 483 * Battery level - no measurement available
mluis 2:14a5d6ad92d5 484 */
mluis 0:91d1a7783bb9 485 BAT_LEVEL_NO_MEASURE = 0xFF,
mluis 0:91d1a7783bb9 486 }LoRaMacBatteryLevel_t;
mluis 0:91d1a7783bb9 487
mluis 0:91d1a7783bb9 488 /*!
mluis 2:14a5d6ad92d5 489 * LoRaMAC header field definition (MHDR field)
mluis 2:14a5d6ad92d5 490 *
mluis 7:c16969e0f70f 491 * LoRaWAN Specification V1.0.1, chapter 4.2
mluis 0:91d1a7783bb9 492 */
mluis 2:14a5d6ad92d5 493 typedef union uLoRaMacHeader
mluis 0:91d1a7783bb9 494 {
mluis 2:14a5d6ad92d5 495 /*!
mluis 2:14a5d6ad92d5 496 * Byte-access to the bits
mluis 2:14a5d6ad92d5 497 */
mluis 0:91d1a7783bb9 498 uint8_t Value;
mluis 2:14a5d6ad92d5 499 /*!
mluis 2:14a5d6ad92d5 500 * Structure containing single access to header bits
mluis 2:14a5d6ad92d5 501 */
mluis 2:14a5d6ad92d5 502 struct sHdrBits
mluis 0:91d1a7783bb9 503 {
mluis 2:14a5d6ad92d5 504 /*!
mluis 2:14a5d6ad92d5 505 * Major version
mluis 2:14a5d6ad92d5 506 */
mluis 0:91d1a7783bb9 507 uint8_t Major : 2;
mluis 2:14a5d6ad92d5 508 /*!
mluis 2:14a5d6ad92d5 509 * RFU
mluis 2:14a5d6ad92d5 510 */
mluis 0:91d1a7783bb9 511 uint8_t RFU : 3;
mluis 2:14a5d6ad92d5 512 /*!
mluis 2:14a5d6ad92d5 513 * Message type
mluis 2:14a5d6ad92d5 514 */
mluis 0:91d1a7783bb9 515 uint8_t MType : 3;
mluis 0:91d1a7783bb9 516 }Bits;
mluis 0:91d1a7783bb9 517 }LoRaMacHeader_t;
mluis 0:91d1a7783bb9 518
mluis 0:91d1a7783bb9 519 /*!
mluis 2:14a5d6ad92d5 520 * LoRaMAC frame control field definition (FCtrl)
mluis 2:14a5d6ad92d5 521 *
mluis 7:c16969e0f70f 522 * LoRaWAN Specification V1.0.1, chapter 4.3.1
mluis 0:91d1a7783bb9 523 */
mluis 2:14a5d6ad92d5 524 typedef union uLoRaMacFrameCtrl
mluis 0:91d1a7783bb9 525 {
mluis 2:14a5d6ad92d5 526 /*!
mluis 2:14a5d6ad92d5 527 * Byte-access to the bits
mluis 2:14a5d6ad92d5 528 */
mluis 0:91d1a7783bb9 529 uint8_t Value;
mluis 4:37c12dbc8dc7 530 /*!
mluis 4:37c12dbc8dc7 531 * Structure containing single access to bits
mluis 4:37c12dbc8dc7 532 */
mluis 2:14a5d6ad92d5 533 struct sCtrlBits
mluis 0:91d1a7783bb9 534 {
mluis 2:14a5d6ad92d5 535 /*!
mluis 2:14a5d6ad92d5 536 * Frame options length
mluis 2:14a5d6ad92d5 537 */
mluis 0:91d1a7783bb9 538 uint8_t FOptsLen : 4;
mluis 2:14a5d6ad92d5 539 /*!
mluis 2:14a5d6ad92d5 540 * Frame pending bit
mluis 2:14a5d6ad92d5 541 */
mluis 0:91d1a7783bb9 542 uint8_t FPending : 1;
mluis 2:14a5d6ad92d5 543 /*!
mluis 2:14a5d6ad92d5 544 * Message acknowledge bit
mluis 2:14a5d6ad92d5 545 */
mluis 0:91d1a7783bb9 546 uint8_t Ack : 1;
mluis 2:14a5d6ad92d5 547 /*!
mluis 2:14a5d6ad92d5 548 * ADR acknowledgment request bit
mluis 2:14a5d6ad92d5 549 */
mluis 0:91d1a7783bb9 550 uint8_t AdrAckReq : 1;
mluis 2:14a5d6ad92d5 551 /*!
mluis 2:14a5d6ad92d5 552 * ADR control in frame header
mluis 2:14a5d6ad92d5 553 */
mluis 0:91d1a7783bb9 554 uint8_t Adr : 1;
mluis 0:91d1a7783bb9 555 }Bits;
mluis 0:91d1a7783bb9 556 }LoRaMacFrameCtrl_t;
mluis 0:91d1a7783bb9 557
mluis 0:91d1a7783bb9 558 /*!
mluis 2:14a5d6ad92d5 559 * Enumeration containing the status of the operation of a MAC service
mluis 0:91d1a7783bb9 560 */
mluis 2:14a5d6ad92d5 561 typedef enum eLoRaMacEventInfoStatus
mluis 0:91d1a7783bb9 562 {
mluis 2:14a5d6ad92d5 563 /*!
mluis 2:14a5d6ad92d5 564 * Service performed successfully
mluis 2:14a5d6ad92d5 565 */
mluis 0:91d1a7783bb9 566 LORAMAC_EVENT_INFO_STATUS_OK = 0,
mluis 2:14a5d6ad92d5 567 /*!
mluis 8:2d237e069df2 568 * An error occurred during the execution of the service
mluis 2:14a5d6ad92d5 569 */
mluis 0:91d1a7783bb9 570 LORAMAC_EVENT_INFO_STATUS_ERROR,
mluis 2:14a5d6ad92d5 571 /*!
mluis 8:2d237e069df2 572 * A Tx timeout occurred
mluis 2:14a5d6ad92d5 573 */
mluis 0:91d1a7783bb9 574 LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT,
mluis 2:14a5d6ad92d5 575 /*!
mluis 8:2d237e069df2 576 * An Rx timeout occurred on receive window 2
mluis 2:14a5d6ad92d5 577 */
mluis 0:91d1a7783bb9 578 LORAMAC_EVENT_INFO_STATUS_RX2_TIMEOUT,
mluis 2:14a5d6ad92d5 579 /*!
mluis 8:2d237e069df2 580 * An Rx error occurred on receive window 1
mluis 8:2d237e069df2 581 */
mluis 8:2d237e069df2 582 LORAMAC_EVENT_INFO_STATUS_RX1_ERROR,
mluis 8:2d237e069df2 583 /*!
mluis 8:2d237e069df2 584 * An Rx error occurred on receive window 2
mluis 2:14a5d6ad92d5 585 */
mluis 0:91d1a7783bb9 586 LORAMAC_EVENT_INFO_STATUS_RX2_ERROR,
mluis 2:14a5d6ad92d5 587 /*!
mluis 8:2d237e069df2 588 * An error occurred in the join procedure
mluis 2:14a5d6ad92d5 589 */
mluis 0:91d1a7783bb9 590 LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL,
mluis 2:14a5d6ad92d5 591 /*!
mluis 2:14a5d6ad92d5 592 * A frame with an invalid downlink counter was received. The
mluis 2:14a5d6ad92d5 593 * downlink counter of the frame was equal to the local copy
mluis 2:14a5d6ad92d5 594 * of the downlink counter of the node.
mluis 2:14a5d6ad92d5 595 */
mluis 2:14a5d6ad92d5 596 LORAMAC_EVENT_INFO_STATUS_DOWNLINK_REPEATED,
mluis 2:14a5d6ad92d5 597 /*!
mluis 8:2d237e069df2 598 * The MAC could not retransmit a frame since the MAC decreased the datarate. The
mluis 8:2d237e069df2 599 * payload size is not applicable for the datarate.
mluis 8:2d237e069df2 600 */
mluis 8:2d237e069df2 601 LORAMAC_EVENT_INFO_STATUS_TX_DR_PAYLOAD_SIZE_ERROR,
mluis 8:2d237e069df2 602 /*!
mluis 4:37c12dbc8dc7 603 * The node has lost MAX_FCNT_GAP or more frames.
mluis 4:37c12dbc8dc7 604 */
mluis 4:37c12dbc8dc7 605 LORAMAC_EVENT_INFO_STATUS_DOWNLINK_TOO_MANY_FRAMES_LOSS,
mluis 4:37c12dbc8dc7 606 /*!
mluis 8:2d237e069df2 607 * An address error occurred
mluis 2:14a5d6ad92d5 608 */
mluis 0:91d1a7783bb9 609 LORAMAC_EVENT_INFO_STATUS_ADDRESS_FAIL,
mluis 2:14a5d6ad92d5 610 /*!
mluis 2:14a5d6ad92d5 611 * message integrity check failure
mluis 2:14a5d6ad92d5 612 */
mluis 0:91d1a7783bb9 613 LORAMAC_EVENT_INFO_STATUS_MIC_FAIL,
mluis 0:91d1a7783bb9 614 }LoRaMacEventInfoStatus_t;
mluis 0:91d1a7783bb9 615
mluis 0:91d1a7783bb9 616 /*!
mluis 2:14a5d6ad92d5 617 * LoRaMac tx/rx operation state
mluis 2:14a5d6ad92d5 618 */
mluis 2:14a5d6ad92d5 619 typedef union eLoRaMacFlags_t
mluis 2:14a5d6ad92d5 620 {
mluis 2:14a5d6ad92d5 621 /*!
mluis 2:14a5d6ad92d5 622 * Byte-access to the bits
mluis 2:14a5d6ad92d5 623 */
mluis 2:14a5d6ad92d5 624 uint8_t Value;
mluis 4:37c12dbc8dc7 625 /*!
mluis 4:37c12dbc8dc7 626 * Structure containing single access to bits
mluis 4:37c12dbc8dc7 627 */
mluis 2:14a5d6ad92d5 628 struct sMacFlagBits
mluis 2:14a5d6ad92d5 629 {
mluis 2:14a5d6ad92d5 630 /*!
mluis 2:14a5d6ad92d5 631 * MCPS-Req pending
mluis 2:14a5d6ad92d5 632 */
mluis 2:14a5d6ad92d5 633 uint8_t McpsReq : 1;
mluis 2:14a5d6ad92d5 634 /*!
mluis 2:14a5d6ad92d5 635 * MCPS-Ind pending
mluis 2:14a5d6ad92d5 636 */
mluis 2:14a5d6ad92d5 637 uint8_t McpsInd : 1;
mluis 2:14a5d6ad92d5 638 /*!
mluis 2:14a5d6ad92d5 639 * MLME-Req pending
mluis 2:14a5d6ad92d5 640 */
mluis 2:14a5d6ad92d5 641 uint8_t MlmeReq : 1;
mluis 2:14a5d6ad92d5 642 /*!
mluis 2:14a5d6ad92d5 643 * MAC cycle done
mluis 2:14a5d6ad92d5 644 */
mluis 2:14a5d6ad92d5 645 uint8_t MacDone : 1;
mluis 2:14a5d6ad92d5 646 }Bits;
mluis 2:14a5d6ad92d5 647 }LoRaMacFlags_t;
mluis 2:14a5d6ad92d5 648
mluis 2:14a5d6ad92d5 649 /*!
mluis 2:14a5d6ad92d5 650 *
mluis 2:14a5d6ad92d5 651 * \brief LoRaMAC data services
mluis 2:14a5d6ad92d5 652 *
mluis 2:14a5d6ad92d5 653 * \details The following table list the primitives which are supported by the
mluis 2:14a5d6ad92d5 654 * specific MAC data service:
mluis 2:14a5d6ad92d5 655 *
mluis 2:14a5d6ad92d5 656 * Name | Request | Indication | Response | Confirm
mluis 2:14a5d6ad92d5 657 * --------------------- | :-----: | :--------: | :------: | :-----:
mluis 2:14a5d6ad92d5 658 * \ref MCPS_UNCONFIRMED | YES | YES | NO | YES
mluis 2:14a5d6ad92d5 659 * \ref MCPS_CONFIRMED | YES | YES | NO | YES
mluis 2:14a5d6ad92d5 660 * \ref MCPS_MULTICAST | NO | YES | NO | NO
mluis 2:14a5d6ad92d5 661 * \ref MCPS_PROPRIETARY | YES | YES | NO | YES
mluis 2:14a5d6ad92d5 662 *
mluis 2:14a5d6ad92d5 663 * The following table provides links to the function implementations of the
mluis 2:14a5d6ad92d5 664 * related MCPS primitives:
mluis 2:14a5d6ad92d5 665 *
mluis 2:14a5d6ad92d5 666 * Primitive | Function
mluis 2:14a5d6ad92d5 667 * ---------------- | :---------------------:
mluis 2:14a5d6ad92d5 668 * MCPS-Request | \ref LoRaMacMlmeRequest
mluis 2:14a5d6ad92d5 669 * MCPS-Confirm | MacMcpsConfirm in \ref LoRaMacPrimitives_t
mluis 2:14a5d6ad92d5 670 * MCPS-Indication | MacMcpsIndication in \ref LoRaMacPrimitives_t
mluis 2:14a5d6ad92d5 671 */
mluis 2:14a5d6ad92d5 672 typedef enum eMcps
mluis 2:14a5d6ad92d5 673 {
mluis 2:14a5d6ad92d5 674 /*!
mluis 2:14a5d6ad92d5 675 * Unconfirmed LoRaMAC frame
mluis 2:14a5d6ad92d5 676 */
mluis 2:14a5d6ad92d5 677 MCPS_UNCONFIRMED,
mluis 2:14a5d6ad92d5 678 /*!
mluis 2:14a5d6ad92d5 679 * Confirmed LoRaMAC frame
mluis 2:14a5d6ad92d5 680 */
mluis 2:14a5d6ad92d5 681 MCPS_CONFIRMED,
mluis 2:14a5d6ad92d5 682 /*!
mluis 2:14a5d6ad92d5 683 * Multicast LoRaMAC frame
mluis 2:14a5d6ad92d5 684 */
mluis 2:14a5d6ad92d5 685 MCPS_MULTICAST,
mluis 2:14a5d6ad92d5 686 /*!
mluis 2:14a5d6ad92d5 687 * Proprietary frame
mluis 2:14a5d6ad92d5 688 */
mluis 2:14a5d6ad92d5 689 MCPS_PROPRIETARY,
mluis 2:14a5d6ad92d5 690 }Mcps_t;
mluis 2:14a5d6ad92d5 691
mluis 2:14a5d6ad92d5 692 /*!
mluis 2:14a5d6ad92d5 693 * LoRaMAC MCPS-Request for an unconfirmed frame
mluis 2:14a5d6ad92d5 694 */
mluis 2:14a5d6ad92d5 695 typedef struct sMcpsReqUnconfirmed
mluis 2:14a5d6ad92d5 696 {
mluis 2:14a5d6ad92d5 697 /*!
mluis 2:14a5d6ad92d5 698 * Frame port field. Must be set if the payload is not empty. Use the
mluis 2:14a5d6ad92d5 699 * application specific frame port values: [1...223]
mluis 2:14a5d6ad92d5 700 *
mluis 7:c16969e0f70f 701 * LoRaWAN Specification V1.0.1, chapter 4.3.2
mluis 2:14a5d6ad92d5 702 */
mluis 2:14a5d6ad92d5 703 uint8_t fPort;
mluis 2:14a5d6ad92d5 704 /*!
mluis 2:14a5d6ad92d5 705 * Pointer to the buffer of the frame payload
mluis 2:14a5d6ad92d5 706 */
mluis 2:14a5d6ad92d5 707 void *fBuffer;
mluis 2:14a5d6ad92d5 708 /*!
mluis 2:14a5d6ad92d5 709 * Size of the frame payload
mluis 2:14a5d6ad92d5 710 */
mluis 2:14a5d6ad92d5 711 uint16_t fBufferSize;
mluis 2:14a5d6ad92d5 712 /*!
mluis 2:14a5d6ad92d5 713 * Uplink datarate, if ADR is off
mluis 2:14a5d6ad92d5 714 */
mluis 2:14a5d6ad92d5 715 int8_t Datarate;
mluis 2:14a5d6ad92d5 716 }McpsReqUnconfirmed_t;
mluis 2:14a5d6ad92d5 717
mluis 2:14a5d6ad92d5 718 /*!
mluis 2:14a5d6ad92d5 719 * LoRaMAC MCPS-Request for a confirmed frame
mluis 2:14a5d6ad92d5 720 */
mluis 2:14a5d6ad92d5 721 typedef struct sMcpsReqConfirmed
mluis 2:14a5d6ad92d5 722 {
mluis 2:14a5d6ad92d5 723 /*!
mluis 2:14a5d6ad92d5 724 * Frame port field. Must be set if the payload is not empty. Use the
mluis 2:14a5d6ad92d5 725 * application specific frame port values: [1...223]
mluis 2:14a5d6ad92d5 726 *
mluis 7:c16969e0f70f 727 * LoRaWAN Specification V1.0.1, chapter 4.3.2
mluis 2:14a5d6ad92d5 728 */
mluis 2:14a5d6ad92d5 729 uint8_t fPort;
mluis 2:14a5d6ad92d5 730 /*!
mluis 2:14a5d6ad92d5 731 * Pointer to the buffer of the frame payload
mluis 2:14a5d6ad92d5 732 */
mluis 2:14a5d6ad92d5 733 void *fBuffer;
mluis 2:14a5d6ad92d5 734 /*!
mluis 2:14a5d6ad92d5 735 * Size of the frame payload
mluis 2:14a5d6ad92d5 736 */
mluis 2:14a5d6ad92d5 737 uint16_t fBufferSize;
mluis 2:14a5d6ad92d5 738 /*!
mluis 2:14a5d6ad92d5 739 * Uplink datarate, if ADR is off
mluis 2:14a5d6ad92d5 740 */
mluis 2:14a5d6ad92d5 741 int8_t Datarate;
mluis 2:14a5d6ad92d5 742 /*!
mluis 3:b9d87593a8ae 743 * Number of trials to transmit the frame, if the LoRaMAC layer did not
mluis 3:b9d87593a8ae 744 * receive an acknowledgment. The MAC performs a datarate adaptation,
mluis 7:c16969e0f70f 745 * according to the LoRaWAN Specification V1.0.1, chapter 19.4, according
mluis 3:b9d87593a8ae 746 * to the following table:
mluis 3:b9d87593a8ae 747 *
mluis 3:b9d87593a8ae 748 * Transmission nb | Data Rate
mluis 3:b9d87593a8ae 749 * ----------------|-----------
mluis 3:b9d87593a8ae 750 * 1 (first) | DR
mluis 3:b9d87593a8ae 751 * 2 | DR
mluis 3:b9d87593a8ae 752 * 3 | max(DR-1,0)
mluis 3:b9d87593a8ae 753 * 4 | max(DR-1,0)
mluis 3:b9d87593a8ae 754 * 5 | max(DR-2,0)
mluis 3:b9d87593a8ae 755 * 6 | max(DR-2,0)
mluis 3:b9d87593a8ae 756 * 7 | max(DR-3,0)
mluis 3:b9d87593a8ae 757 * 8 | max(DR-3,0)
mluis 3:b9d87593a8ae 758 *
mluis 3:b9d87593a8ae 759 * Note, that if NbTrials is set to 1 or 2, the MAC will not decrease
mluis 3:b9d87593a8ae 760 * the datarate, in case the LoRaMAC layer did not receive an acknowledgment
mluis 2:14a5d6ad92d5 761 */
mluis 3:b9d87593a8ae 762 uint8_t NbTrials;
mluis 2:14a5d6ad92d5 763 }McpsReqConfirmed_t;
mluis 2:14a5d6ad92d5 764
mluis 2:14a5d6ad92d5 765 /*!
mluis 2:14a5d6ad92d5 766 * LoRaMAC MCPS-Request for a proprietary frame
mluis 2:14a5d6ad92d5 767 */
mluis 2:14a5d6ad92d5 768 typedef struct sMcpsReqProprietary
mluis 2:14a5d6ad92d5 769 {
mluis 2:14a5d6ad92d5 770 /*!
mluis 2:14a5d6ad92d5 771 * Pointer to the buffer of the frame payload
mluis 2:14a5d6ad92d5 772 */
mluis 2:14a5d6ad92d5 773 void *fBuffer;
mluis 2:14a5d6ad92d5 774 /*!
mluis 2:14a5d6ad92d5 775 * Size of the frame payload
mluis 2:14a5d6ad92d5 776 */
mluis 2:14a5d6ad92d5 777 uint16_t fBufferSize;
mluis 2:14a5d6ad92d5 778 /*!
mluis 2:14a5d6ad92d5 779 * Uplink datarate, if ADR is off
mluis 2:14a5d6ad92d5 780 */
mluis 2:14a5d6ad92d5 781 int8_t Datarate;
mluis 2:14a5d6ad92d5 782 }McpsReqProprietary_t;
mluis 2:14a5d6ad92d5 783
mluis 2:14a5d6ad92d5 784 /*!
mluis 2:14a5d6ad92d5 785 * LoRaMAC MCPS-Request structure
mluis 2:14a5d6ad92d5 786 */
mluis 2:14a5d6ad92d5 787 typedef struct sMcpsReq
mluis 2:14a5d6ad92d5 788 {
mluis 2:14a5d6ad92d5 789 /*!
mluis 2:14a5d6ad92d5 790 * MCPS-Request type
mluis 2:14a5d6ad92d5 791 */
mluis 2:14a5d6ad92d5 792 Mcps_t Type;
mluis 2:14a5d6ad92d5 793
mluis 2:14a5d6ad92d5 794 /*!
mluis 2:14a5d6ad92d5 795 * MCPS-Request parameters
mluis 2:14a5d6ad92d5 796 */
mluis 2:14a5d6ad92d5 797 union uMcpsParam
mluis 2:14a5d6ad92d5 798 {
mluis 2:14a5d6ad92d5 799 /*!
mluis 2:14a5d6ad92d5 800 * MCPS-Request parameters for an unconfirmed frame
mluis 2:14a5d6ad92d5 801 */
mluis 2:14a5d6ad92d5 802 McpsReqUnconfirmed_t Unconfirmed;
mluis 2:14a5d6ad92d5 803 /*!
mluis 2:14a5d6ad92d5 804 * MCPS-Request parameters for a confirmed frame
mluis 2:14a5d6ad92d5 805 */
mluis 2:14a5d6ad92d5 806 McpsReqConfirmed_t Confirmed;
mluis 2:14a5d6ad92d5 807 /*!
mluis 2:14a5d6ad92d5 808 * MCPS-Request parameters for a proprietary frame
mluis 2:14a5d6ad92d5 809 */
mluis 2:14a5d6ad92d5 810 McpsReqProprietary_t Proprietary;
mluis 2:14a5d6ad92d5 811 }Req;
mluis 2:14a5d6ad92d5 812 }McpsReq_t;
mluis 2:14a5d6ad92d5 813
mluis 2:14a5d6ad92d5 814 /*!
mluis 2:14a5d6ad92d5 815 * LoRaMAC MCPS-Confirm
mluis 0:91d1a7783bb9 816 */
mluis 2:14a5d6ad92d5 817 typedef struct sMcpsConfirm
mluis 2:14a5d6ad92d5 818 {
mluis 2:14a5d6ad92d5 819 /*!
mluis 2:14a5d6ad92d5 820 * Holds the previously performed MCPS-Request
mluis 2:14a5d6ad92d5 821 */
mluis 2:14a5d6ad92d5 822 Mcps_t McpsRequest;
mluis 2:14a5d6ad92d5 823 /*!
mluis 2:14a5d6ad92d5 824 * Status of the operation
mluis 2:14a5d6ad92d5 825 */
mluis 2:14a5d6ad92d5 826 LoRaMacEventInfoStatus_t Status;
mluis 2:14a5d6ad92d5 827 /*!
mluis 2:14a5d6ad92d5 828 * Uplink datarate
mluis 2:14a5d6ad92d5 829 */
mluis 2:14a5d6ad92d5 830 uint8_t Datarate;
mluis 2:14a5d6ad92d5 831 /*!
mluis 2:14a5d6ad92d5 832 * Transmission power
mluis 2:14a5d6ad92d5 833 */
mluis 2:14a5d6ad92d5 834 int8_t TxPower;
mluis 2:14a5d6ad92d5 835 /*!
mluis 2:14a5d6ad92d5 836 * Set if an acknowledgement was received
mluis 2:14a5d6ad92d5 837 */
mluis 2:14a5d6ad92d5 838 bool AckReceived;
mluis 2:14a5d6ad92d5 839 /*!
mluis 2:14a5d6ad92d5 840 * Provides the number of retransmissions
mluis 2:14a5d6ad92d5 841 */
mluis 2:14a5d6ad92d5 842 uint8_t NbRetries;
mluis 2:14a5d6ad92d5 843 /*!
mluis 2:14a5d6ad92d5 844 * The transmission time on air of the frame
mluis 2:14a5d6ad92d5 845 */
mluis 2:14a5d6ad92d5 846 TimerTime_t TxTimeOnAir;
mluis 2:14a5d6ad92d5 847 /*!
mluis 2:14a5d6ad92d5 848 * The uplink counter value related to the frame
mluis 2:14a5d6ad92d5 849 */
mluis 2:14a5d6ad92d5 850 uint32_t UpLinkCounter;
mluis 8:2d237e069df2 851 /*!
mluis 8:2d237e069df2 852 * The uplink frequency related to the frame
mluis 8:2d237e069df2 853 */
mluis 8:2d237e069df2 854 uint32_t UpLinkFrequency;
mluis 2:14a5d6ad92d5 855 }McpsConfirm_t;
mluis 2:14a5d6ad92d5 856
mluis 2:14a5d6ad92d5 857 /*!
mluis 2:14a5d6ad92d5 858 * LoRaMAC MCPS-Indication primitive
mluis 2:14a5d6ad92d5 859 */
mluis 2:14a5d6ad92d5 860 typedef struct sMcpsIndication
mluis 0:91d1a7783bb9 861 {
mluis 2:14a5d6ad92d5 862 /*!
mluis 2:14a5d6ad92d5 863 * MCPS-Indication type
mluis 2:14a5d6ad92d5 864 */
mluis 2:14a5d6ad92d5 865 Mcps_t McpsIndication;
mluis 2:14a5d6ad92d5 866 /*!
mluis 2:14a5d6ad92d5 867 * Status of the operation
mluis 2:14a5d6ad92d5 868 */
mluis 2:14a5d6ad92d5 869 LoRaMacEventInfoStatus_t Status;
mluis 2:14a5d6ad92d5 870 /*!
mluis 2:14a5d6ad92d5 871 * Multicast
mluis 2:14a5d6ad92d5 872 */
mluis 2:14a5d6ad92d5 873 uint8_t Multicast;
mluis 2:14a5d6ad92d5 874 /*!
mluis 2:14a5d6ad92d5 875 * Application port
mluis 2:14a5d6ad92d5 876 */
mluis 2:14a5d6ad92d5 877 uint8_t Port;
mluis 2:14a5d6ad92d5 878 /*!
mluis 2:14a5d6ad92d5 879 * Downlink datarate
mluis 2:14a5d6ad92d5 880 */
mluis 2:14a5d6ad92d5 881 uint8_t RxDatarate;
mluis 2:14a5d6ad92d5 882 /*!
mluis 2:14a5d6ad92d5 883 * Frame pending status
mluis 2:14a5d6ad92d5 884 */
mluis 2:14a5d6ad92d5 885 uint8_t FramePending;
mluis 2:14a5d6ad92d5 886 /*!
mluis 2:14a5d6ad92d5 887 * Pointer to the received data stream
mluis 2:14a5d6ad92d5 888 */
mluis 2:14a5d6ad92d5 889 uint8_t *Buffer;
mluis 2:14a5d6ad92d5 890 /*!
mluis 2:14a5d6ad92d5 891 * Size of the received data stream
mluis 2:14a5d6ad92d5 892 */
mluis 2:14a5d6ad92d5 893 uint8_t BufferSize;
mluis 2:14a5d6ad92d5 894 /*!
mluis 2:14a5d6ad92d5 895 * Indicates, if data is available
mluis 2:14a5d6ad92d5 896 */
mluis 2:14a5d6ad92d5 897 bool RxData;
mluis 2:14a5d6ad92d5 898 /*!
mluis 2:14a5d6ad92d5 899 * Rssi of the received packet
mluis 2:14a5d6ad92d5 900 */
mluis 2:14a5d6ad92d5 901 int16_t Rssi;
mluis 2:14a5d6ad92d5 902 /*!
mluis 2:14a5d6ad92d5 903 * Snr of the received packet
mluis 2:14a5d6ad92d5 904 */
mluis 2:14a5d6ad92d5 905 uint8_t Snr;
mluis 2:14a5d6ad92d5 906 /*!
mluis 2:14a5d6ad92d5 907 * Receive window
mluis 2:14a5d6ad92d5 908 *
mluis 2:14a5d6ad92d5 909 * [0: Rx window 1, 1: Rx window 2]
mluis 2:14a5d6ad92d5 910 */
mluis 2:14a5d6ad92d5 911 uint8_t RxSlot;
mluis 2:14a5d6ad92d5 912 /*!
mluis 2:14a5d6ad92d5 913 * Set if an acknowledgement was received
mluis 2:14a5d6ad92d5 914 */
mluis 2:14a5d6ad92d5 915 bool AckReceived;
mluis 2:14a5d6ad92d5 916 /*!
mluis 2:14a5d6ad92d5 917 * The downlink counter value for the received frame
mluis 2:14a5d6ad92d5 918 */
mluis 2:14a5d6ad92d5 919 uint32_t DownLinkCounter;
mluis 2:14a5d6ad92d5 920 }McpsIndication_t;
mluis 2:14a5d6ad92d5 921
mluis 2:14a5d6ad92d5 922 /*!
mluis 2:14a5d6ad92d5 923 * \brief LoRaMAC management services
mluis 2:14a5d6ad92d5 924 *
mluis 2:14a5d6ad92d5 925 * \details The following table list the primitives which are supported by the
mluis 2:14a5d6ad92d5 926 * specific MAC management service:
mluis 2:14a5d6ad92d5 927 *
mluis 2:14a5d6ad92d5 928 * Name | Request | Indication | Response | Confirm
mluis 2:14a5d6ad92d5 929 * --------------------- | :-----: | :--------: | :------: | :-----:
mluis 2:14a5d6ad92d5 930 * \ref MLME_JOIN | YES | NO | NO | YES
mluis 2:14a5d6ad92d5 931 * \ref MLME_LINK_CHECK | YES | NO | NO | YES
mluis 8:2d237e069df2 932 * \ref MLME_TXCW | YES | NO | NO | YES
mluis 2:14a5d6ad92d5 933 *
mluis 2:14a5d6ad92d5 934 * The following table provides links to the function implementations of the
mluis 2:14a5d6ad92d5 935 * related MLME primitives.
mluis 2:14a5d6ad92d5 936 *
mluis 2:14a5d6ad92d5 937 * Primitive | Function
mluis 2:14a5d6ad92d5 938 * ---------------- | :---------------------:
mluis 2:14a5d6ad92d5 939 * MLME-Request | \ref LoRaMacMlmeRequest
mluis 2:14a5d6ad92d5 940 * MLME-Confirm | MacMlmeConfirm in \ref LoRaMacPrimitives_t
mluis 2:14a5d6ad92d5 941 */
mluis 2:14a5d6ad92d5 942 typedef enum eMlme
mluis 2:14a5d6ad92d5 943 {
mluis 2:14a5d6ad92d5 944 /*!
mluis 2:14a5d6ad92d5 945 * Initiates the Over-the-Air activation
mluis 2:14a5d6ad92d5 946 *
mluis 7:c16969e0f70f 947 * LoRaWAN Specification V1.0.1, chapter 6.2
mluis 2:14a5d6ad92d5 948 */
mluis 2:14a5d6ad92d5 949 MLME_JOIN,
mluis 2:14a5d6ad92d5 950 /*!
mluis 2:14a5d6ad92d5 951 * LinkCheckReq - Connectivity validation
mluis 2:14a5d6ad92d5 952 *
mluis 7:c16969e0f70f 953 * LoRaWAN Specification V1.0.1, chapter 5, table 4
mluis 2:14a5d6ad92d5 954 */
mluis 2:14a5d6ad92d5 955 MLME_LINK_CHECK,
mluis 8:2d237e069df2 956 /*!
mluis 8:2d237e069df2 957 * Sets Tx continuous wave mode
mluis 8:2d237e069df2 958 *
mluis 8:2d237e069df2 959 * LoRaWAN end-device certification
mluis 8:2d237e069df2 960 */
mluis 8:2d237e069df2 961 MLME_TXCW,
mluis 2:14a5d6ad92d5 962 }Mlme_t;
mluis 2:14a5d6ad92d5 963
mluis 2:14a5d6ad92d5 964 /*!
mluis 2:14a5d6ad92d5 965 * LoRaMAC MLME-Request for the join service
mluis 2:14a5d6ad92d5 966 */
mluis 2:14a5d6ad92d5 967 typedef struct sMlmeReqJoin
mluis 2:14a5d6ad92d5 968 {
mluis 2:14a5d6ad92d5 969 /*!
mluis 2:14a5d6ad92d5 970 * Globally unique end-device identifier
mluis 2:14a5d6ad92d5 971 *
mluis 7:c16969e0f70f 972 * LoRaWAN Specification V1.0.1, chapter 6.2.1
mluis 2:14a5d6ad92d5 973 */
mluis 2:14a5d6ad92d5 974 uint8_t *DevEui;
mluis 2:14a5d6ad92d5 975 /*!
mluis 2:14a5d6ad92d5 976 * Application identifier
mluis 2:14a5d6ad92d5 977 *
mluis 7:c16969e0f70f 978 * LoRaWAN Specification V1.0.1, chapter 6.1.2
mluis 2:14a5d6ad92d5 979 */
mluis 2:14a5d6ad92d5 980 uint8_t *AppEui;
mluis 2:14a5d6ad92d5 981 /*!
mluis 2:14a5d6ad92d5 982 * AES-128 application key
mluis 2:14a5d6ad92d5 983 *
mluis 7:c16969e0f70f 984 * LoRaWAN Specification V1.0.1, chapter 6.2.2
mluis 2:14a5d6ad92d5 985 */
mluis 2:14a5d6ad92d5 986 uint8_t *AppKey;
mluis 8:2d237e069df2 987 /*!
mluis 8:2d237e069df2 988 * Number of trials for the join request.
mluis 8:2d237e069df2 989 */
mluis 8:2d237e069df2 990 uint8_t NbTrials;
mluis 2:14a5d6ad92d5 991 }MlmeReqJoin_t;
mluis 2:14a5d6ad92d5 992
mluis 2:14a5d6ad92d5 993 /*!
mluis 8:2d237e069df2 994 * LoRaMAC MLME-Request for Tx continuous wave mode
mluis 8:2d237e069df2 995 */
mluis 8:2d237e069df2 996 typedef struct sMlmeReqTxCw
mluis 8:2d237e069df2 997 {
mluis 8:2d237e069df2 998 /*!
mluis 8:2d237e069df2 999 * Time in seconds while the radio is kept in continuous wave mode
mluis 8:2d237e069df2 1000 */
mluis 8:2d237e069df2 1001 uint16_t Timeout;
mluis 8:2d237e069df2 1002 }MlmeReqTxCw_t;
mluis 8:2d237e069df2 1003
mluis 8:2d237e069df2 1004 /*!
mluis 4:37c12dbc8dc7 1005 * LoRaMAC MLME-Request structure
mluis 2:14a5d6ad92d5 1006 */
mluis 2:14a5d6ad92d5 1007 typedef struct sMlmeReq
mluis 2:14a5d6ad92d5 1008 {
mluis 2:14a5d6ad92d5 1009 /*!
mluis 2:14a5d6ad92d5 1010 * MLME-Request type
mluis 2:14a5d6ad92d5 1011 */
mluis 2:14a5d6ad92d5 1012 Mlme_t Type;
mluis 2:14a5d6ad92d5 1013
mluis 2:14a5d6ad92d5 1014 /*!
mluis 2:14a5d6ad92d5 1015 * MLME-Request parameters
mluis 2:14a5d6ad92d5 1016 */
mluis 2:14a5d6ad92d5 1017 union uMlmeParam
mluis 2:14a5d6ad92d5 1018 {
mluis 2:14a5d6ad92d5 1019 /*!
mluis 2:14a5d6ad92d5 1020 * MLME-Request parameters for a join request
mluis 2:14a5d6ad92d5 1021 */
mluis 2:14a5d6ad92d5 1022 MlmeReqJoin_t Join;
mluis 8:2d237e069df2 1023 /*!
mluis 8:2d237e069df2 1024 * MLME-Request parameters for Tx continuous mode request
mluis 8:2d237e069df2 1025 */
mluis 8:2d237e069df2 1026 MlmeReqTxCw_t TxCw;
mluis 2:14a5d6ad92d5 1027 }Req;
mluis 2:14a5d6ad92d5 1028 }MlmeReq_t;
mluis 2:14a5d6ad92d5 1029
mluis 2:14a5d6ad92d5 1030 /*!
mluis 2:14a5d6ad92d5 1031 * LoRaMAC MLME-Confirm primitive
mluis 2:14a5d6ad92d5 1032 */
mluis 2:14a5d6ad92d5 1033 typedef struct sMlmeConfirm
mluis 2:14a5d6ad92d5 1034 {
mluis 2:14a5d6ad92d5 1035 /*!
mluis 2:14a5d6ad92d5 1036 * Holds the previously performed MLME-Request
mluis 2:14a5d6ad92d5 1037 */
mluis 2:14a5d6ad92d5 1038 Mlme_t MlmeRequest;
mluis 2:14a5d6ad92d5 1039 /*!
mluis 2:14a5d6ad92d5 1040 * Status of the operation
mluis 2:14a5d6ad92d5 1041 */
mluis 0:91d1a7783bb9 1042 LoRaMacEventInfoStatus_t Status;
mluis 2:14a5d6ad92d5 1043 /*!
mluis 2:14a5d6ad92d5 1044 * The transmission time on air of the frame
mluis 2:14a5d6ad92d5 1045 */
mluis 2:14a5d6ad92d5 1046 TimerTime_t TxTimeOnAir;
mluis 2:14a5d6ad92d5 1047 /*!
mluis 2:14a5d6ad92d5 1048 * Demodulation margin. Contains the link margin [dB] of the last
mluis 2:14a5d6ad92d5 1049 * successfully received LinkCheckReq
mluis 2:14a5d6ad92d5 1050 */
mluis 0:91d1a7783bb9 1051 uint8_t DemodMargin;
mluis 2:14a5d6ad92d5 1052 /*!
mluis 2:14a5d6ad92d5 1053 * Number of gateways which received the last LinkCheckReq
mluis 2:14a5d6ad92d5 1054 */
mluis 0:91d1a7783bb9 1055 uint8_t NbGateways;
mluis 8:2d237e069df2 1056 /*!
mluis 8:2d237e069df2 1057 * Provides the number of retransmissions
mluis 8:2d237e069df2 1058 */
mluis 8:2d237e069df2 1059 uint8_t NbRetries;
mluis 2:14a5d6ad92d5 1060 }MlmeConfirm_t;
mluis 2:14a5d6ad92d5 1061
mluis 2:14a5d6ad92d5 1062 /*!
mluis 2:14a5d6ad92d5 1063 * LoRa Mac Information Base (MIB)
mluis 2:14a5d6ad92d5 1064 *
mluis 2:14a5d6ad92d5 1065 * The following table lists the MIB parameters and the related attributes:
mluis 2:14a5d6ad92d5 1066 *
mluis 2:14a5d6ad92d5 1067 * Attribute | Get | Set
mluis 2:14a5d6ad92d5 1068 * --------------------------------- | :-: | :-:
mluis 2:14a5d6ad92d5 1069 * \ref MIB_DEVICE_CLASS | YES | YES
mluis 2:14a5d6ad92d5 1070 * \ref MIB_NETWORK_JOINED | YES | YES
mluis 2:14a5d6ad92d5 1071 * \ref MIB_ADR | YES | YES
mluis 2:14a5d6ad92d5 1072 * \ref MIB_NET_ID | YES | YES
mluis 2:14a5d6ad92d5 1073 * \ref MIB_DEV_ADDR | YES | YES
mluis 2:14a5d6ad92d5 1074 * \ref MIB_NWK_SKEY | YES | YES
mluis 2:14a5d6ad92d5 1075 * \ref MIB_APP_SKEY | YES | YES
mluis 2:14a5d6ad92d5 1076 * \ref MIB_PUBLIC_NETWORK | YES | YES
mluis 3:b9d87593a8ae 1077 * \ref MIB_REPEATER_SUPPORT | YES | YES
mluis 2:14a5d6ad92d5 1078 * \ref MIB_CHANNELS | YES | NO
mluis 2:14a5d6ad92d5 1079 * \ref MIB_RX2_CHANNEL | YES | YES
mluis 2:14a5d6ad92d5 1080 * \ref MIB_CHANNELS_MASK | YES | YES
mluis 8:2d237e069df2 1081 * \ref MIB_CHANNELS_DEFAULT_MASK | YES | YES
mluis 2:14a5d6ad92d5 1082 * \ref MIB_CHANNELS_NB_REP | YES | YES
mluis 2:14a5d6ad92d5 1083 * \ref MIB_MAX_RX_WINDOW_DURATION | YES | YES
mluis 2:14a5d6ad92d5 1084 * \ref MIB_RECEIVE_DELAY_1 | YES | YES
mluis 2:14a5d6ad92d5 1085 * \ref MIB_RECEIVE_DELAY_2 | YES | YES
mluis 2:14a5d6ad92d5 1086 * \ref MIB_JOIN_ACCEPT_DELAY_1 | YES | YES
mluis 2:14a5d6ad92d5 1087 * \ref MIB_JOIN_ACCEPT_DELAY_2 | YES | YES
mluis 2:14a5d6ad92d5 1088 * \ref MIB_CHANNELS_DATARATE | YES | YES
mluis 4:37c12dbc8dc7 1089 * \ref MIB_CHANNELS_DEFAULT_DATARATE| YES | YES
mluis 2:14a5d6ad92d5 1090 * \ref MIB_CHANNELS_TX_POWER | YES | YES
mluis 8:2d237e069df2 1091 * \ref MIB_CHANNELS_DEFAULT_TX_POWER| YES | YES
mluis 4:37c12dbc8dc7 1092 * \ref MIB_UPLINK_COUNTER | YES | YES
mluis 4:37c12dbc8dc7 1093 * \ref MIB_DOWNLINK_COUNTER | YES | YES
mluis 2:14a5d6ad92d5 1094 * \ref MIB_MULTICAST_CHANNEL | YES | NO
mluis 2:14a5d6ad92d5 1095 *
mluis 2:14a5d6ad92d5 1096 * The following table provides links to the function implementations of the
mluis 2:14a5d6ad92d5 1097 * related MIB primitives:
mluis 2:14a5d6ad92d5 1098 *
mluis 2:14a5d6ad92d5 1099 * Primitive | Function
mluis 2:14a5d6ad92d5 1100 * ---------------- | :---------------------:
mluis 2:14a5d6ad92d5 1101 * MIB-Set | \ref LoRaMacMibSetRequestConfirm
mluis 2:14a5d6ad92d5 1102 * MIB-Get | \ref LoRaMacMibGetRequestConfirm
mluis 2:14a5d6ad92d5 1103 */
mluis 2:14a5d6ad92d5 1104 typedef enum eMib
mluis 2:14a5d6ad92d5 1105 {
mluis 2:14a5d6ad92d5 1106 /*!
mluis 2:14a5d6ad92d5 1107 * LoRaWAN device class
mluis 2:14a5d6ad92d5 1108 *
mluis 7:c16969e0f70f 1109 * LoRaWAN Specification V1.0.1
mluis 2:14a5d6ad92d5 1110 */
mluis 2:14a5d6ad92d5 1111 MIB_DEVICE_CLASS,
mluis 2:14a5d6ad92d5 1112 /*!
mluis 2:14a5d6ad92d5 1113 * LoRaWAN Network joined attribute
mluis 2:14a5d6ad92d5 1114 *
mluis 7:c16969e0f70f 1115 * LoRaWAN Specification V1.0.1
mluis 2:14a5d6ad92d5 1116 */
mluis 2:14a5d6ad92d5 1117 MIB_NETWORK_JOINED,
mluis 2:14a5d6ad92d5 1118 /*!
mluis 2:14a5d6ad92d5 1119 * Adaptive data rate
mluis 2:14a5d6ad92d5 1120 *
mluis 7:c16969e0f70f 1121 * LoRaWAN Specification V1.0.1, chapter 4.3.1.1
mluis 2:14a5d6ad92d5 1122 *
mluis 2:14a5d6ad92d5 1123 * [true: ADR enabled, false: ADR disabled]
mluis 2:14a5d6ad92d5 1124 */
mluis 2:14a5d6ad92d5 1125 MIB_ADR,
mluis 2:14a5d6ad92d5 1126 /*!
mluis 2:14a5d6ad92d5 1127 * Network identifier
mluis 2:14a5d6ad92d5 1128 *
mluis 7:c16969e0f70f 1129 * LoRaWAN Specification V1.0.1, chapter 6.1.1
mluis 2:14a5d6ad92d5 1130 */
mluis 2:14a5d6ad92d5 1131 MIB_NET_ID,
mluis 2:14a5d6ad92d5 1132 /*!
mluis 2:14a5d6ad92d5 1133 * End-device address
mluis 2:14a5d6ad92d5 1134 *
mluis 7:c16969e0f70f 1135 * LoRaWAN Specification V1.0.1, chapter 6.1.1
mluis 2:14a5d6ad92d5 1136 */
mluis 2:14a5d6ad92d5 1137 MIB_DEV_ADDR,
mluis 2:14a5d6ad92d5 1138 /*!
mluis 2:14a5d6ad92d5 1139 * Network session key
mluis 2:14a5d6ad92d5 1140 *
mluis 7:c16969e0f70f 1141 * LoRaWAN Specification V1.0.1, chapter 6.1.3
mluis 2:14a5d6ad92d5 1142 */
mluis 2:14a5d6ad92d5 1143 MIB_NWK_SKEY,
mluis 2:14a5d6ad92d5 1144 /*!
mluis 2:14a5d6ad92d5 1145 * Application session key
mluis 2:14a5d6ad92d5 1146 *
mluis 7:c16969e0f70f 1147 * LoRaWAN Specification V1.0.1, chapter 6.1.4
mluis 2:14a5d6ad92d5 1148 */
mluis 2:14a5d6ad92d5 1149 MIB_APP_SKEY,
mluis 2:14a5d6ad92d5 1150 /*!
mluis 2:14a5d6ad92d5 1151 * Set the network type to public or private
mluis 2:14a5d6ad92d5 1152 *
mluis 7:c16969e0f70f 1153 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1154 *
mluis 2:14a5d6ad92d5 1155 * [true: public network, false: private network]
mluis 2:14a5d6ad92d5 1156 */
mluis 2:14a5d6ad92d5 1157 MIB_PUBLIC_NETWORK,
mluis 2:14a5d6ad92d5 1158 /*!
mluis 2:14a5d6ad92d5 1159 * Support the operation with repeaters
mluis 2:14a5d6ad92d5 1160 *
mluis 7:c16969e0f70f 1161 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1162 *
mluis 2:14a5d6ad92d5 1163 * [true: repeater support enabled, false: repeater support disabled]
mluis 2:14a5d6ad92d5 1164 */
mluis 2:14a5d6ad92d5 1165 MIB_REPEATER_SUPPORT,
mluis 2:14a5d6ad92d5 1166 /*!
mluis 2:14a5d6ad92d5 1167 * Communication channels. A get request will return a
mluis 2:14a5d6ad92d5 1168 * pointer which references the first entry of the channel list. The
mluis 2:14a5d6ad92d5 1169 * list is of size LORA_MAX_NB_CHANNELS
mluis 2:14a5d6ad92d5 1170 *
mluis 7:c16969e0f70f 1171 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1172 */
mluis 2:14a5d6ad92d5 1173 MIB_CHANNELS,
mluis 2:14a5d6ad92d5 1174 /*!
mluis 2:14a5d6ad92d5 1175 * Set receive window 2 channel
mluis 2:14a5d6ad92d5 1176 *
mluis 7:c16969e0f70f 1177 * LoRaWAN Specification V1.0.1, chapter 3.3.2
mluis 2:14a5d6ad92d5 1178 */
mluis 2:14a5d6ad92d5 1179 MIB_RX2_CHANNEL,
mluis 2:14a5d6ad92d5 1180 /*!
mluis 8:2d237e069df2 1181 * Set receive window 2 channel
mluis 8:2d237e069df2 1182 *
mluis 8:2d237e069df2 1183 * LoRaWAN Specification V1.0.1, chapter 3.3.2
mluis 8:2d237e069df2 1184 */
mluis 8:2d237e069df2 1185 MIB_RX2_DEFAULT_CHANNEL,
mluis 8:2d237e069df2 1186 /*!
mluis 2:14a5d6ad92d5 1187 * LoRaWAN channels mask
mluis 2:14a5d6ad92d5 1188 *
mluis 7:c16969e0f70f 1189 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1190 */
mluis 2:14a5d6ad92d5 1191 MIB_CHANNELS_MASK,
mluis 2:14a5d6ad92d5 1192 /*!
mluis 8:2d237e069df2 1193 * LoRaWAN default channels mask
mluis 8:2d237e069df2 1194 *
mluis 8:2d237e069df2 1195 * LoRaWAN Specification V1.0.1, chapter 7
mluis 8:2d237e069df2 1196 */
mluis 8:2d237e069df2 1197 MIB_CHANNELS_DEFAULT_MASK,
mluis 8:2d237e069df2 1198 /*!
mluis 2:14a5d6ad92d5 1199 * Set the number of repetitions on a channel
mluis 2:14a5d6ad92d5 1200 *
mluis 7:c16969e0f70f 1201 * LoRaWAN Specification V1.0.1, chapter 5.2
mluis 2:14a5d6ad92d5 1202 */
mluis 2:14a5d6ad92d5 1203 MIB_CHANNELS_NB_REP,
mluis 2:14a5d6ad92d5 1204 /*!
mluis 8:2d237e069df2 1205 * Maximum receive window duration in [ms]
mluis 2:14a5d6ad92d5 1206 *
mluis 7:c16969e0f70f 1207 * LoRaWAN Specification V1.0.1, chapter 3.3.3
mluis 2:14a5d6ad92d5 1208 */
mluis 2:14a5d6ad92d5 1209 MIB_MAX_RX_WINDOW_DURATION,
mluis 2:14a5d6ad92d5 1210 /*!
mluis 8:2d237e069df2 1211 * Receive delay 1 in [ms]
mluis 2:14a5d6ad92d5 1212 *
mluis 7:c16969e0f70f 1213 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1214 */
mluis 2:14a5d6ad92d5 1215 MIB_RECEIVE_DELAY_1,
mluis 2:14a5d6ad92d5 1216 /*!
mluis 8:2d237e069df2 1217 * Receive delay 2 in [ms]
mluis 2:14a5d6ad92d5 1218 *
mluis 7:c16969e0f70f 1219 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1220 */
mluis 2:14a5d6ad92d5 1221 MIB_RECEIVE_DELAY_2,
mluis 2:14a5d6ad92d5 1222 /*!
mluis 8:2d237e069df2 1223 * Join accept delay 1 in [ms]
mluis 2:14a5d6ad92d5 1224 *
mluis 7:c16969e0f70f 1225 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1226 */
mluis 2:14a5d6ad92d5 1227 MIB_JOIN_ACCEPT_DELAY_1,
mluis 2:14a5d6ad92d5 1228 /*!
mluis 8:2d237e069df2 1229 * Join accept delay 2 in [ms]
mluis 2:14a5d6ad92d5 1230 *
mluis 7:c16969e0f70f 1231 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1232 */
mluis 2:14a5d6ad92d5 1233 MIB_JOIN_ACCEPT_DELAY_2,
mluis 2:14a5d6ad92d5 1234 /*!
mluis 4:37c12dbc8dc7 1235 * Default Data rate of a channel
mluis 4:37c12dbc8dc7 1236 *
mluis 7:c16969e0f70f 1237 * LoRaWAN Specification V1.0.1, chapter 7
mluis 4:37c12dbc8dc7 1238 *
mluis 4:37c12dbc8dc7 1239 * EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
mluis 4:37c12dbc8dc7 1240 *
mluis 4:37c12dbc8dc7 1241 * US915 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_8, DR_9, DR_10, DR_11, DR_12, DR_13]
mluis 4:37c12dbc8dc7 1242 */
mluis 4:37c12dbc8dc7 1243 MIB_CHANNELS_DEFAULT_DATARATE,
mluis 4:37c12dbc8dc7 1244 /*!
mluis 2:14a5d6ad92d5 1245 * Data rate of a channel
mluis 2:14a5d6ad92d5 1246 *
mluis 7:c16969e0f70f 1247 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1248 *
mluis 2:14a5d6ad92d5 1249 * EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
mluis 2:14a5d6ad92d5 1250 *
mluis 2:14a5d6ad92d5 1251 * US915 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_8, DR_9, DR_10, DR_11, DR_12, DR_13]
mluis 2:14a5d6ad92d5 1252 */
mluis 2:14a5d6ad92d5 1253 MIB_CHANNELS_DATARATE,
mluis 2:14a5d6ad92d5 1254 /*!
mluis 2:14a5d6ad92d5 1255 * Transmission power of a channel
mluis 2:14a5d6ad92d5 1256 *
mluis 7:c16969e0f70f 1257 * LoRaWAN Specification V1.0.1, chapter 7
mluis 2:14a5d6ad92d5 1258 *
mluis 2:14a5d6ad92d5 1259 * EU868 - [TX_POWER_20_DBM, TX_POWER_14_DBM, TX_POWER_11_DBM,
mluis 2:14a5d6ad92d5 1260 * TX_POWER_08_DBM, TX_POWER_05_DBM, TX_POWER_02_DBM]
mluis 2:14a5d6ad92d5 1261 *
mluis 2:14a5d6ad92d5 1262 * US915 - [TX_POWER_30_DBM, TX_POWER_28_DBM, TX_POWER_26_DBM,
mluis 2:14a5d6ad92d5 1263 * TX_POWER_24_DBM, TX_POWER_22_DBM, TX_POWER_20_DBM,
mluis 2:14a5d6ad92d5 1264 * TX_POWER_18_DBM, TX_POWER_14_DBM, TX_POWER_12_DBM,
mluis 2:14a5d6ad92d5 1265 * TX_POWER_10_DBM]
mluis 2:14a5d6ad92d5 1266 */
mluis 2:14a5d6ad92d5 1267 MIB_CHANNELS_TX_POWER,
mluis 2:14a5d6ad92d5 1268 /*!
mluis 8:2d237e069df2 1269 * Transmission power of a channel
mluis 8:2d237e069df2 1270 *
mluis 8:2d237e069df2 1271 * LoRaWAN Specification V1.0.1, chapter 7
mluis 8:2d237e069df2 1272 *
mluis 8:2d237e069df2 1273 * EU868 - [TX_POWER_20_DBM, TX_POWER_14_DBM, TX_POWER_11_DBM,
mluis 8:2d237e069df2 1274 * TX_POWER_08_DBM, TX_POWER_05_DBM, TX_POWER_02_DBM]
mluis 8:2d237e069df2 1275 *
mluis 8:2d237e069df2 1276 * US915 - [TX_POWER_30_DBM, TX_POWER_28_DBM, TX_POWER_26_DBM,
mluis 8:2d237e069df2 1277 * TX_POWER_24_DBM, TX_POWER_22_DBM, TX_POWER_20_DBM,
mluis 8:2d237e069df2 1278 * TX_POWER_18_DBM, TX_POWER_14_DBM, TX_POWER_12_DBM,
mluis 8:2d237e069df2 1279 * TX_POWER_10_DBM]
mluis 8:2d237e069df2 1280 */
mluis 8:2d237e069df2 1281 MIB_CHANNELS_DEFAULT_TX_POWER,
mluis 8:2d237e069df2 1282 /*!
mluis 2:14a5d6ad92d5 1283 * LoRaWAN Up-link counter
mluis 2:14a5d6ad92d5 1284 *
mluis 7:c16969e0f70f 1285 * LoRaWAN Specification V1.0.1, chapter 4.3.1.5
mluis 2:14a5d6ad92d5 1286 */
mluis 2:14a5d6ad92d5 1287 MIB_UPLINK_COUNTER,
mluis 2:14a5d6ad92d5 1288 /*!
mluis 2:14a5d6ad92d5 1289 * LoRaWAN Down-link counter
mluis 2:14a5d6ad92d5 1290 *
mluis 7:c16969e0f70f 1291 * LoRaWAN Specification V1.0.1, chapter 4.3.1.5
mluis 2:14a5d6ad92d5 1292 */
mluis 2:14a5d6ad92d5 1293 MIB_DOWNLINK_COUNTER,
mluis 2:14a5d6ad92d5 1294 /*!
mluis 2:14a5d6ad92d5 1295 * Multicast channels. A get request will return a pointer to the first
mluis 2:14a5d6ad92d5 1296 * entry of the multicast channel linked list. If the pointer is equal to
mluis 2:14a5d6ad92d5 1297 * NULL, the list is empty.
mluis 2:14a5d6ad92d5 1298 */
mluis 2:14a5d6ad92d5 1299 MIB_MULTICAST_CHANNEL,
mluis 2:14a5d6ad92d5 1300 }Mib_t;
mluis 2:14a5d6ad92d5 1301
mluis 2:14a5d6ad92d5 1302 /*!
mluis 2:14a5d6ad92d5 1303 * LoRaMAC MIB parameters
mluis 2:14a5d6ad92d5 1304 */
mluis 2:14a5d6ad92d5 1305 typedef union uMibParam
mluis 2:14a5d6ad92d5 1306 {
mluis 2:14a5d6ad92d5 1307 /*!
mluis 2:14a5d6ad92d5 1308 * LoRaWAN device class
mluis 2:14a5d6ad92d5 1309 *
mluis 2:14a5d6ad92d5 1310 * Related MIB type: \ref MIB_DEVICE_CLASS
mluis 2:14a5d6ad92d5 1311 */
mluis 2:14a5d6ad92d5 1312 DeviceClass_t Class;
mluis 2:14a5d6ad92d5 1313 /*!
mluis 2:14a5d6ad92d5 1314 * LoRaWAN network joined attribute
mluis 2:14a5d6ad92d5 1315 *
mluis 2:14a5d6ad92d5 1316 * Related MIB type: \ref MIB_NETWORK_JOINED
mluis 2:14a5d6ad92d5 1317 */
mluis 2:14a5d6ad92d5 1318 bool IsNetworkJoined;
mluis 2:14a5d6ad92d5 1319 /*!
mluis 2:14a5d6ad92d5 1320 * Activation state of ADR
mluis 2:14a5d6ad92d5 1321 *
mluis 2:14a5d6ad92d5 1322 * Related MIB type: \ref MIB_ADR
mluis 2:14a5d6ad92d5 1323 */
mluis 2:14a5d6ad92d5 1324 bool AdrEnable;
mluis 2:14a5d6ad92d5 1325 /*!
mluis 2:14a5d6ad92d5 1326 * Network identifier
mluis 2:14a5d6ad92d5 1327 *
mluis 2:14a5d6ad92d5 1328 * Related MIB type: \ref MIB_NET_ID
mluis 2:14a5d6ad92d5 1329 */
mluis 2:14a5d6ad92d5 1330 uint32_t NetID;
mluis 2:14a5d6ad92d5 1331 /*!
mluis 2:14a5d6ad92d5 1332 * End-device address
mluis 2:14a5d6ad92d5 1333 *
mluis 2:14a5d6ad92d5 1334 * Related MIB type: \ref MIB_DEV_ADDR
mluis 2:14a5d6ad92d5 1335 */
mluis 2:14a5d6ad92d5 1336 uint32_t DevAddr;
mluis 2:14a5d6ad92d5 1337 /*!
mluis 2:14a5d6ad92d5 1338 * Network session key
mluis 2:14a5d6ad92d5 1339 *
mluis 2:14a5d6ad92d5 1340 * Related MIB type: \ref MIB_NWK_SKEY
mluis 2:14a5d6ad92d5 1341 */
mluis 2:14a5d6ad92d5 1342 uint8_t *NwkSKey;
mluis 2:14a5d6ad92d5 1343 /*!
mluis 2:14a5d6ad92d5 1344 * Application session key
mluis 2:14a5d6ad92d5 1345 *
mluis 2:14a5d6ad92d5 1346 * Related MIB type: \ref MIB_APP_SKEY
mluis 2:14a5d6ad92d5 1347 */
mluis 2:14a5d6ad92d5 1348 uint8_t *AppSKey;
mluis 2:14a5d6ad92d5 1349 /*!
mluis 2:14a5d6ad92d5 1350 * Enable or disable a public network
mluis 2:14a5d6ad92d5 1351 *
mluis 2:14a5d6ad92d5 1352 * Related MIB type: \ref MIB_PUBLIC_NETWORK
mluis 2:14a5d6ad92d5 1353 */
mluis 2:14a5d6ad92d5 1354 bool EnablePublicNetwork;
mluis 2:14a5d6ad92d5 1355 /*!
mluis 2:14a5d6ad92d5 1356 * Enable or disable repeater support
mluis 2:14a5d6ad92d5 1357 *
mluis 2:14a5d6ad92d5 1358 * Related MIB type: \ref MIB_REPEATER_SUPPORT
mluis 2:14a5d6ad92d5 1359 */
mluis 2:14a5d6ad92d5 1360 bool EnableRepeaterSupport;
mluis 2:14a5d6ad92d5 1361 /*!
mluis 2:14a5d6ad92d5 1362 * LoRaWAN Channel
mluis 2:14a5d6ad92d5 1363 *
mluis 2:14a5d6ad92d5 1364 * Related MIB type: \ref MIB_CHANNELS
mluis 2:14a5d6ad92d5 1365 */
mluis 2:14a5d6ad92d5 1366 ChannelParams_t* ChannelList;
mluis 2:14a5d6ad92d5 1367 /*!
mluis 2:14a5d6ad92d5 1368 * Channel for the receive window 2
mluis 2:14a5d6ad92d5 1369 *
mluis 2:14a5d6ad92d5 1370 * Related MIB type: \ref MIB_RX2_CHANNEL
mluis 2:14a5d6ad92d5 1371 */
mluis 2:14a5d6ad92d5 1372 Rx2ChannelParams_t Rx2Channel;
mluis 8:2d237e069df2 1373 /*!
mluis 8:2d237e069df2 1374 * Channel for the receive window 2
mluis 8:2d237e069df2 1375 *
mluis 8:2d237e069df2 1376 * Related MIB type: \ref MIB_RX2_DEFAULT_CHANNEL
mluis 8:2d237e069df2 1377 */
mluis 8:2d237e069df2 1378 Rx2ChannelParams_t Rx2DefaultChannel;
mluis 2:14a5d6ad92d5 1379 /*!
mluis 2:14a5d6ad92d5 1380 * Channel mask
mluis 2:14a5d6ad92d5 1381 *
mluis 2:14a5d6ad92d5 1382 * Related MIB type: \ref MIB_CHANNELS_MASK
mluis 2:14a5d6ad92d5 1383 */
mluis 2:14a5d6ad92d5 1384 uint16_t* ChannelsMask;
mluis 2:14a5d6ad92d5 1385 /*!
mluis 8:2d237e069df2 1386 * Default channel mask
mluis 8:2d237e069df2 1387 *
mluis 8:2d237e069df2 1388 * Related MIB type: \ref MIB_CHANNELS_DEFAULT_MASK
mluis 8:2d237e069df2 1389 */
mluis 8:2d237e069df2 1390 uint16_t* ChannelsDefaultMask;
mluis 8:2d237e069df2 1391 /*!
mluis 2:14a5d6ad92d5 1392 * Number of frame repetitions
mluis 2:14a5d6ad92d5 1393 *
mluis 2:14a5d6ad92d5 1394 * Related MIB type: \ref MIB_CHANNELS_NB_REP
mluis 2:14a5d6ad92d5 1395 */
mluis 2:14a5d6ad92d5 1396 uint8_t ChannelNbRep;
mluis 2:14a5d6ad92d5 1397 /*!
mluis 2:14a5d6ad92d5 1398 * Maximum receive window duration
mluis 2:14a5d6ad92d5 1399 *
mluis 2:14a5d6ad92d5 1400 * Related MIB type: \ref MIB_MAX_RX_WINDOW_DURATION
mluis 2:14a5d6ad92d5 1401 */
mluis 2:14a5d6ad92d5 1402 uint32_t MaxRxWindow;
mluis 2:14a5d6ad92d5 1403 /*!
mluis 2:14a5d6ad92d5 1404 * Receive delay 1
mluis 2:14a5d6ad92d5 1405 *
mluis 2:14a5d6ad92d5 1406 * Related MIB type: \ref MIB_RECEIVE_DELAY_1
mluis 2:14a5d6ad92d5 1407 */
mluis 2:14a5d6ad92d5 1408 uint32_t ReceiveDelay1;
mluis 2:14a5d6ad92d5 1409 /*!
mluis 2:14a5d6ad92d5 1410 * Receive delay 2
mluis 2:14a5d6ad92d5 1411 *
mluis 2:14a5d6ad92d5 1412 * Related MIB type: \ref MIB_RECEIVE_DELAY_2
mluis 2:14a5d6ad92d5 1413 */
mluis 2:14a5d6ad92d5 1414 uint32_t ReceiveDelay2;
mluis 2:14a5d6ad92d5 1415 /*!
mluis 2:14a5d6ad92d5 1416 * Join accept delay 1
mluis 2:14a5d6ad92d5 1417 *
mluis 2:14a5d6ad92d5 1418 * Related MIB type: \ref MIB_JOIN_ACCEPT_DELAY_1
mluis 2:14a5d6ad92d5 1419 */
mluis 2:14a5d6ad92d5 1420 uint32_t JoinAcceptDelay1;
mluis 2:14a5d6ad92d5 1421 /*!
mluis 2:14a5d6ad92d5 1422 * Join accept delay 2
mluis 2:14a5d6ad92d5 1423 *
mluis 2:14a5d6ad92d5 1424 * Related MIB type: \ref MIB_JOIN_ACCEPT_DELAY_2
mluis 2:14a5d6ad92d5 1425 */
mluis 2:14a5d6ad92d5 1426 uint32_t JoinAcceptDelay2;
mluis 2:14a5d6ad92d5 1427 /*!
mluis 2:14a5d6ad92d5 1428 * Channels data rate
mluis 2:14a5d6ad92d5 1429 *
mluis 4:37c12dbc8dc7 1430 * Related MIB type: \ref MIB_CHANNELS_DEFAULT_DATARATE
mluis 4:37c12dbc8dc7 1431 */
mluis 4:37c12dbc8dc7 1432 int8_t ChannelsDefaultDatarate;
mluis 4:37c12dbc8dc7 1433 /*!
mluis 4:37c12dbc8dc7 1434 * Channels data rate
mluis 4:37c12dbc8dc7 1435 *
mluis 2:14a5d6ad92d5 1436 * Related MIB type: \ref MIB_CHANNELS_DATARATE
mluis 2:14a5d6ad92d5 1437 */
mluis 2:14a5d6ad92d5 1438 int8_t ChannelsDatarate;
mluis 2:14a5d6ad92d5 1439 /*!
mluis 2:14a5d6ad92d5 1440 * Channels TX power
mluis 2:14a5d6ad92d5 1441 *
mluis 8:2d237e069df2 1442 * Related MIB type: \ref MIB_CHANNELS_DEFAULT_TX_POWER
mluis 8:2d237e069df2 1443 */
mluis 8:2d237e069df2 1444 int8_t ChannelsDefaultTxPower;
mluis 8:2d237e069df2 1445 /*!
mluis 8:2d237e069df2 1446 * Channels TX power
mluis 8:2d237e069df2 1447 *
mluis 2:14a5d6ad92d5 1448 * Related MIB type: \ref MIB_CHANNELS_TX_POWER
mluis 2:14a5d6ad92d5 1449 */
mluis 2:14a5d6ad92d5 1450 int8_t ChannelsTxPower;
mluis 2:14a5d6ad92d5 1451 /*!
mluis 2:14a5d6ad92d5 1452 * LoRaWAN Up-link counter
mluis 2:14a5d6ad92d5 1453 *
mluis 2:14a5d6ad92d5 1454 * Related MIB type: \ref MIB_UPLINK_COUNTER
mluis 2:14a5d6ad92d5 1455 */
mluis 2:14a5d6ad92d5 1456 uint32_t UpLinkCounter;
mluis 2:14a5d6ad92d5 1457 /*!
mluis 2:14a5d6ad92d5 1458 * LoRaWAN Down-link counter
mluis 2:14a5d6ad92d5 1459 *
mluis 2:14a5d6ad92d5 1460 * Related MIB type: \ref MIB_DOWNLINK_COUNTER
mluis 2:14a5d6ad92d5 1461 */
mluis 2:14a5d6ad92d5 1462 uint32_t DownLinkCounter;
mluis 2:14a5d6ad92d5 1463 /*!
mluis 2:14a5d6ad92d5 1464 * Multicast channel
mluis 2:14a5d6ad92d5 1465 *
mluis 2:14a5d6ad92d5 1466 * Related MIB type: \ref MIB_MULTICAST_CHANNEL
mluis 2:14a5d6ad92d5 1467 */
mluis 2:14a5d6ad92d5 1468 MulticastParams_t* MulticastList;
mluis 2:14a5d6ad92d5 1469 }MibParam_t;
mluis 2:14a5d6ad92d5 1470
mluis 2:14a5d6ad92d5 1471 /*!
mluis 2:14a5d6ad92d5 1472 * LoRaMAC MIB-RequestConfirm structure
mluis 2:14a5d6ad92d5 1473 */
mluis 2:14a5d6ad92d5 1474 typedef struct eMibRequestConfirm
mluis 2:14a5d6ad92d5 1475 {
mluis 2:14a5d6ad92d5 1476 /*!
mluis 2:14a5d6ad92d5 1477 * MIB-Request type
mluis 2:14a5d6ad92d5 1478 */
mluis 2:14a5d6ad92d5 1479 Mib_t Type;
mluis 2:14a5d6ad92d5 1480
mluis 2:14a5d6ad92d5 1481 /*!
mluis 2:14a5d6ad92d5 1482 * MLME-RequestConfirm parameters
mluis 2:14a5d6ad92d5 1483 */
mluis 2:14a5d6ad92d5 1484 MibParam_t Param;
mluis 2:14a5d6ad92d5 1485 }MibRequestConfirm_t;
mluis 2:14a5d6ad92d5 1486
mluis 2:14a5d6ad92d5 1487 /*!
mluis 2:14a5d6ad92d5 1488 * LoRaMAC tx information
mluis 2:14a5d6ad92d5 1489 */
mluis 2:14a5d6ad92d5 1490 typedef struct sLoRaMacTxInfo
mluis 2:14a5d6ad92d5 1491 {
mluis 2:14a5d6ad92d5 1492 /*!
mluis 2:14a5d6ad92d5 1493 * Defines the size of the applicative payload which can be processed
mluis 2:14a5d6ad92d5 1494 */
mluis 2:14a5d6ad92d5 1495 uint8_t MaxPossiblePayload;
mluis 2:14a5d6ad92d5 1496 /*!
mluis 2:14a5d6ad92d5 1497 * The current payload size, dependent on the current datarate
mluis 2:14a5d6ad92d5 1498 */
mluis 2:14a5d6ad92d5 1499 uint8_t CurrentPayloadSize;
mluis 2:14a5d6ad92d5 1500 }LoRaMacTxInfo_t;
mluis 2:14a5d6ad92d5 1501
mluis 2:14a5d6ad92d5 1502 /*!
mluis 2:14a5d6ad92d5 1503 * LoRaMAC Status
mluis 2:14a5d6ad92d5 1504 */
mluis 2:14a5d6ad92d5 1505 typedef enum eLoRaMacStatus
mluis 2:14a5d6ad92d5 1506 {
mluis 2:14a5d6ad92d5 1507 /*!
mluis 2:14a5d6ad92d5 1508 * Service started successfully
mluis 2:14a5d6ad92d5 1509 */
mluis 2:14a5d6ad92d5 1510 LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1511 /*!
mluis 2:14a5d6ad92d5 1512 * Service not started - LoRaMAC is busy
mluis 2:14a5d6ad92d5 1513 */
mluis 2:14a5d6ad92d5 1514 LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1515 /*!
mluis 2:14a5d6ad92d5 1516 * Service unknown
mluis 2:14a5d6ad92d5 1517 */
mluis 2:14a5d6ad92d5 1518 LORAMAC_STATUS_SERVICE_UNKNOWN,
mluis 2:14a5d6ad92d5 1519 /*!
mluis 2:14a5d6ad92d5 1520 * Service not started - invalid parameter
mluis 2:14a5d6ad92d5 1521 */
mluis 2:14a5d6ad92d5 1522 LORAMAC_STATUS_PARAMETER_INVALID,
mluis 2:14a5d6ad92d5 1523 /*!
mluis 3:b9d87593a8ae 1524 * Service not started - invalid frequency
mluis 3:b9d87593a8ae 1525 */
mluis 3:b9d87593a8ae 1526 LORAMAC_STATUS_FREQUENCY_INVALID,
mluis 3:b9d87593a8ae 1527 /*!
mluis 3:b9d87593a8ae 1528 * Service not started - invalid datarate
mluis 3:b9d87593a8ae 1529 */
mluis 3:b9d87593a8ae 1530 LORAMAC_STATUS_DATARATE_INVALID,
mluis 3:b9d87593a8ae 1531 /*!
mluis 3:b9d87593a8ae 1532 * Service not started - invalid frequency and datarate
mluis 3:b9d87593a8ae 1533 */
mluis 3:b9d87593a8ae 1534 LORAMAC_STATUS_FREQ_AND_DR_INVALID,
mluis 3:b9d87593a8ae 1535 /*!
mluis 2:14a5d6ad92d5 1536 * Service not started - the device is not in a LoRaWAN
mluis 2:14a5d6ad92d5 1537 */
mluis 2:14a5d6ad92d5 1538 LORAMAC_STATUS_NO_NETWORK_JOINED,
mluis 2:14a5d6ad92d5 1539 /*!
mluis 8:2d237e069df2 1540 * Service not started - payload lenght error
mluis 2:14a5d6ad92d5 1541 */
mluis 2:14a5d6ad92d5 1542 LORAMAC_STATUS_LENGTH_ERROR,
mluis 2:14a5d6ad92d5 1543 /*!
mluis 8:2d237e069df2 1544 * Service not started - payload lenght error
mluis 2:14a5d6ad92d5 1545 */
mluis 2:14a5d6ad92d5 1546 LORAMAC_STATUS_MAC_CMD_LENGTH_ERROR,
mluis 2:14a5d6ad92d5 1547 /*!
mluis 2:14a5d6ad92d5 1548 * Service not started - the device is switched off
mluis 2:14a5d6ad92d5 1549 */
mluis 2:14a5d6ad92d5 1550 LORAMAC_STATUS_DEVICE_OFF,
mluis 2:14a5d6ad92d5 1551 }LoRaMacStatus_t;
mluis 0:91d1a7783bb9 1552
mluis 0:91d1a7783bb9 1553 /*!
mluis 0:91d1a7783bb9 1554 * LoRaMAC events structure
mluis 0:91d1a7783bb9 1555 * Used to notify upper layers of MAC events
mluis 0:91d1a7783bb9 1556 */
mluis 2:14a5d6ad92d5 1557 typedef struct sLoRaMacPrimitives
mluis 0:91d1a7783bb9 1558 {
mluis 0:91d1a7783bb9 1559 /*!
mluis 2:14a5d6ad92d5 1560 * \brief MCPS-Confirm primitive
mluis 0:91d1a7783bb9 1561 *
mluis 2:14a5d6ad92d5 1562 * \param [OUT] MCPS-Confirm parameters
mluis 2:14a5d6ad92d5 1563 */
mluis 2:14a5d6ad92d5 1564 void ( *MacMcpsConfirm )( McpsConfirm_t *McpsConfirm );
mluis 2:14a5d6ad92d5 1565 /*!
mluis 2:14a5d6ad92d5 1566 * \brief MCPS-Indication primitive
mluis 2:14a5d6ad92d5 1567 *
mluis 2:14a5d6ad92d5 1568 * \param [OUT] MCPS-Indication parameters
mluis 0:91d1a7783bb9 1569 */
mluis 2:14a5d6ad92d5 1570 void ( *MacMcpsIndication )( McpsIndication_t *McpsIndication );
mluis 1:91e4e6c60d1e 1571 /*!
mluis 2:14a5d6ad92d5 1572 * \brief MLME-Confirm primitive
mluis 1:91e4e6c60d1e 1573 *
mluis 2:14a5d6ad92d5 1574 * \param [OUT] MLME-Confirm parameters
mluis 2:14a5d6ad92d5 1575 */
mluis 2:14a5d6ad92d5 1576 void ( *MacMlmeConfirm )( MlmeConfirm_t *MlmeConfirm );
mluis 2:14a5d6ad92d5 1577 }LoRaMacPrimitives_t;
mluis 2:14a5d6ad92d5 1578
mluis 2:14a5d6ad92d5 1579 typedef struct sLoRaMacCallback
mluis 2:14a5d6ad92d5 1580 {
mluis 2:14a5d6ad92d5 1581 /*!
mluis 2:14a5d6ad92d5 1582 * \brief Measures the battery level
mluis 2:14a5d6ad92d5 1583 *
mluis 2:14a5d6ad92d5 1584 * \retval Battery level [0: node is connected to an external
mluis 2:14a5d6ad92d5 1585 * power source, 1..254: battery level, where 1 is the minimum
mluis 2:14a5d6ad92d5 1586 * and 254 is the maximum value, 255: the node was not able
mluis 2:14a5d6ad92d5 1587 * to measure the battery level]
mluis 1:91e4e6c60d1e 1588 */
mluis 1:91e4e6c60d1e 1589 uint8_t ( *GetBatteryLevel )( void );
mluis 2:14a5d6ad92d5 1590 }LoRaMacCallback_t;
mluis 0:91d1a7783bb9 1591
mluis 0:91d1a7783bb9 1592 /*!
mluis 2:14a5d6ad92d5 1593 * \brief LoRaMAC layer initialization
mluis 0:91d1a7783bb9 1594 *
mluis 2:14a5d6ad92d5 1595 * \details In addition to the initialization of the LoRaMAC layer, this
mluis 2:14a5d6ad92d5 1596 * function initializes the callback primitives of the MCPS and
mluis 2:14a5d6ad92d5 1597 * MLME services. Every data field of \ref LoRaMacPrimitives_t must be
mluis 2:14a5d6ad92d5 1598 * set to a valid callback function.
mluis 2:14a5d6ad92d5 1599 *
mluis 2:14a5d6ad92d5 1600 * \param [IN] events - Pointer to a structure defining the LoRaMAC
mluis 2:14a5d6ad92d5 1601 * event functions. Refer to \ref LoRaMacPrimitives_t.
mluis 0:91d1a7783bb9 1602 *
mluis 2:14a5d6ad92d5 1603 * \param [IN] events - Pointer to a structure defining the LoRaMAC
mluis 2:14a5d6ad92d5 1604 * callback functions. Refer to \ref LoRaMacCallback_t.
mluis 2:14a5d6ad92d5 1605 *
mluis 2:14a5d6ad92d5 1606 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1607 * returns are:
mluis 2:14a5d6ad92d5 1608 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1609 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 0:91d1a7783bb9 1610 */
mluis 2:14a5d6ad92d5 1611 LoRaMacStatus_t LoRaMacInitialization( LoRaMacPrimitives_t *primitives, LoRaMacCallback_t *callbacks );
mluis 0:91d1a7783bb9 1612
mluis 0:91d1a7783bb9 1613 /*!
mluis 2:14a5d6ad92d5 1614 * \brief Queries the LoRaMAC if it is possible to send the next frame with
mluis 2:14a5d6ad92d5 1615 * a given payload size. The LoRaMAC takes scheduled MAC commands into
mluis 2:14a5d6ad92d5 1616 * account and reports, when the frame can be send or not.
mluis 2:14a5d6ad92d5 1617 *
mluis 2:14a5d6ad92d5 1618 * \param [IN] size - Size of applicative payload to be send next
mluis 0:91d1a7783bb9 1619 *
mluis 2:14a5d6ad92d5 1620 * \param [OUT] txInfo - The structure \ref LoRaMacTxInfo_t contains
mluis 2:14a5d6ad92d5 1621 * information about the actual maximum payload possible
mluis 2:14a5d6ad92d5 1622 * ( according to the configured datarate or the next
mluis 2:14a5d6ad92d5 1623 * datarate according to ADR ), and the maximum frame
mluis 2:14a5d6ad92d5 1624 * size, taking the scheduled MAC commands into account.
mluis 0:91d1a7783bb9 1625 *
mluis 2:14a5d6ad92d5 1626 * \retval LoRaMacStatus_t Status of the operation. When the parameters are
mluis 2:14a5d6ad92d5 1627 * not valid, the function returns \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 2:14a5d6ad92d5 1628 * In case of a length error caused by the applicative payload size, the
mluis 2:14a5d6ad92d5 1629 * function returns LORAMAC_STATUS_LENGTH_ERROR. In case of a length error
mluis 2:14a5d6ad92d5 1630 * due to additional MAC commands in the queue, the function returns
mluis 2:14a5d6ad92d5 1631 * LORAMAC_STATUS_MAC_CMD_LENGTH_ERROR. In case the query is valid, and
mluis 2:14a5d6ad92d5 1632 * the LoRaMAC is able to send the frame, the function returns LORAMAC_STATUS_OK. *
mluis 0:91d1a7783bb9 1633 */
mluis 2:14a5d6ad92d5 1634 LoRaMacStatus_t LoRaMacQueryTxPossible( uint8_t size, LoRaMacTxInfo_t* txInfo );
mluis 0:91d1a7783bb9 1635
mluis 0:91d1a7783bb9 1636 /*!
mluis 2:14a5d6ad92d5 1637 * \brief LoRaMAC channel add service
mluis 2:14a5d6ad92d5 1638 *
mluis 2:14a5d6ad92d5 1639 * \details Adds a new channel to the channel list and activates the id in
mluis 2:14a5d6ad92d5 1640 * the channel mask. For the US915 band, all channels are enabled
mluis 2:14a5d6ad92d5 1641 * by default. It is not possible to activate less than 6 125 kHz
mluis 2:14a5d6ad92d5 1642 * channels.
mluis 2:14a5d6ad92d5 1643 *
mluis 2:14a5d6ad92d5 1644 * \param [IN] id - Id of the channel. Possible values are:
mluis 0:91d1a7783bb9 1645 *
mluis 2:14a5d6ad92d5 1646 * 0-15 for EU868
mluis 2:14a5d6ad92d5 1647 * 0-72 for US915
mluis 2:14a5d6ad92d5 1648 *
mluis 2:14a5d6ad92d5 1649 * \param [IN] params - Channel parameters to set.
mluis 0:91d1a7783bb9 1650 *
mluis 2:14a5d6ad92d5 1651 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1652 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1653 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1654 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 0:91d1a7783bb9 1655 */
mluis 2:14a5d6ad92d5 1656 LoRaMacStatus_t LoRaMacChannelAdd( uint8_t id, ChannelParams_t params );
mluis 0:91d1a7783bb9 1657
mluis 0:91d1a7783bb9 1658 /*!
mluis 2:14a5d6ad92d5 1659 * \brief LoRaMAC channel remove service
mluis 2:14a5d6ad92d5 1660 *
mluis 2:14a5d6ad92d5 1661 * \details Deactivates the id in the channel mask.
mluis 2:14a5d6ad92d5 1662 *
mluis 2:14a5d6ad92d5 1663 * \param [IN] id - Id of the channel.
mluis 2:14a5d6ad92d5 1664 *
mluis 2:14a5d6ad92d5 1665 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1666 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1667 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1668 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 0:91d1a7783bb9 1669 */
mluis 2:14a5d6ad92d5 1670 LoRaMacStatus_t LoRaMacChannelRemove( uint8_t id );
mluis 0:91d1a7783bb9 1671
mluis 0:91d1a7783bb9 1672 /*!
mluis 2:14a5d6ad92d5 1673 * \brief LoRaMAC multicast channel link service
mluis 2:14a5d6ad92d5 1674 *
mluis 2:14a5d6ad92d5 1675 * \details Links a multicast channel into the linked list.
mluis 2:14a5d6ad92d5 1676 *
mluis 2:14a5d6ad92d5 1677 * \param [IN] channelParam - Multicast channel parameters to link.
mluis 0:91d1a7783bb9 1678 *
mluis 2:14a5d6ad92d5 1679 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1680 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1681 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1682 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 0:91d1a7783bb9 1683 */
mluis 2:14a5d6ad92d5 1684 LoRaMacStatus_t LoRaMacMulticastChannelLink( MulticastParams_t *channelParam );
mluis 2:14a5d6ad92d5 1685
mluis 2:14a5d6ad92d5 1686 /*!
mluis 2:14a5d6ad92d5 1687 * \brief LoRaMAC multicast channel unlink service
mluis 2:14a5d6ad92d5 1688 *
mluis 2:14a5d6ad92d5 1689 * \details Unlinks a multicast channel from the linked list.
mluis 2:14a5d6ad92d5 1690 *
mluis 2:14a5d6ad92d5 1691 * \param [IN] channelParam - Multicast channel parameters to unlink.
mluis 2:14a5d6ad92d5 1692 *
mluis 2:14a5d6ad92d5 1693 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1694 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1695 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1696 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 2:14a5d6ad92d5 1697 */
mluis 2:14a5d6ad92d5 1698 LoRaMacStatus_t LoRaMacMulticastChannelUnlink( MulticastParams_t *channelParam );
mluis 0:91d1a7783bb9 1699
mluis 0:91d1a7783bb9 1700 /*!
mluis 2:14a5d6ad92d5 1701 * \brief LoRaMAC MIB-Get
mluis 2:14a5d6ad92d5 1702 *
mluis 2:14a5d6ad92d5 1703 * \details The mac information base service to get attributes of the LoRaMac
mluis 2:14a5d6ad92d5 1704 * layer.
mluis 2:14a5d6ad92d5 1705 *
mluis 2:14a5d6ad92d5 1706 * The following code-snippet shows how to use the API to get the
mluis 2:14a5d6ad92d5 1707 * parameter AdrEnable, defined by the enumeration type
mluis 2:14a5d6ad92d5 1708 * \ref MIB_ADR.
mluis 2:14a5d6ad92d5 1709 * \code
mluis 2:14a5d6ad92d5 1710 * MibRequestConfirm_t mibReq;
mluis 2:14a5d6ad92d5 1711 * mibReq.Type = MIB_ADR;
mluis 0:91d1a7783bb9 1712 *
mluis 2:14a5d6ad92d5 1713 * if( LoRaMacMibGetRequestConfirm( &mibReq ) == LORAMAC_STATUS_OK )
mluis 2:14a5d6ad92d5 1714 * {
mluis 2:14a5d6ad92d5 1715 * // LoRaMAC updated the parameter mibParam.AdrEnable
mluis 2:14a5d6ad92d5 1716 * }
mluis 2:14a5d6ad92d5 1717 * \endcode
mluis 2:14a5d6ad92d5 1718 *
mluis 2:14a5d6ad92d5 1719 * \param [IN] mibRequest - MIB-GET-Request to perform. Refer to \ref MibRequestConfirm_t.
mluis 2:14a5d6ad92d5 1720 *
mluis 2:14a5d6ad92d5 1721 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1722 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1723 * \ref LORAMAC_STATUS_SERVICE_UNKNOWN,
mluis 2:14a5d6ad92d5 1724 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 0:91d1a7783bb9 1725 */
mluis 2:14a5d6ad92d5 1726 LoRaMacStatus_t LoRaMacMibGetRequestConfirm( MibRequestConfirm_t *mibGet );
mluis 0:91d1a7783bb9 1727
mluis 0:91d1a7783bb9 1728 /*!
mluis 2:14a5d6ad92d5 1729 * \brief LoRaMAC MIB-Set
mluis 2:14a5d6ad92d5 1730 *
mluis 2:14a5d6ad92d5 1731 * \details The mac information base service to set attributes of the LoRaMac
mluis 2:14a5d6ad92d5 1732 * layer.
mluis 2:14a5d6ad92d5 1733 *
mluis 2:14a5d6ad92d5 1734 * The following code-snippet shows how to use the API to set the
mluis 2:14a5d6ad92d5 1735 * parameter AdrEnable, defined by the enumeration type
mluis 2:14a5d6ad92d5 1736 * \ref MIB_ADR.
mluis 2:14a5d6ad92d5 1737 *
mluis 2:14a5d6ad92d5 1738 * \code
mluis 2:14a5d6ad92d5 1739 * MibRequestConfirm_t mibReq;
mluis 2:14a5d6ad92d5 1740 * mibReq.Type = MIB_ADR;
mluis 2:14a5d6ad92d5 1741 * mibReq.Param.AdrEnable = true;
mluis 0:91d1a7783bb9 1742 *
mluis 2:14a5d6ad92d5 1743 * if( LoRaMacMibGetRequestConfirm( &mibReq ) == LORAMAC_STATUS_OK )
mluis 2:14a5d6ad92d5 1744 * {
mluis 2:14a5d6ad92d5 1745 * // LoRaMAC updated the parameter
mluis 2:14a5d6ad92d5 1746 * }
mluis 2:14a5d6ad92d5 1747 * \endcode
mluis 2:14a5d6ad92d5 1748 *
mluis 2:14a5d6ad92d5 1749 * \param [IN] mibRequest - MIB-SET-Request to perform. Refer to \ref MibRequestConfirm_t.
mluis 2:14a5d6ad92d5 1750 *
mluis 2:14a5d6ad92d5 1751 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1752 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1753 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1754 * \ref LORAMAC_STATUS_SERVICE_UNKNOWN,
mluis 2:14a5d6ad92d5 1755 * \ref LORAMAC_STATUS_PARAMETER_INVALID.
mluis 0:91d1a7783bb9 1756 */
mluis 2:14a5d6ad92d5 1757 LoRaMacStatus_t LoRaMacMibSetRequestConfirm( MibRequestConfirm_t *mibSet );
mluis 0:91d1a7783bb9 1758
mluis 0:91d1a7783bb9 1759 /*!
mluis 2:14a5d6ad92d5 1760 * \brief LoRaMAC MLME-Request
mluis 2:14a5d6ad92d5 1761 *
mluis 2:14a5d6ad92d5 1762 * \details The Mac layer management entity handles management services. The
mluis 2:14a5d6ad92d5 1763 * following code-snippet shows how to use the API to perform a
mluis 2:14a5d6ad92d5 1764 * network join request.
mluis 2:14a5d6ad92d5 1765 *
mluis 2:14a5d6ad92d5 1766 * \code
mluis 2:14a5d6ad92d5 1767 * static uint8_t DevEui[] =
mluis 2:14a5d6ad92d5 1768 * {
mluis 2:14a5d6ad92d5 1769 * 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
mluis 2:14a5d6ad92d5 1770 * };
mluis 2:14a5d6ad92d5 1771 * static uint8_t AppEui[] =
mluis 2:14a5d6ad92d5 1772 * {
mluis 2:14a5d6ad92d5 1773 * 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
mluis 2:14a5d6ad92d5 1774 * };
mluis 2:14a5d6ad92d5 1775 * static uint8_t AppKey[] =
mluis 2:14a5d6ad92d5 1776 * {
mluis 2:14a5d6ad92d5 1777 * 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6,
mluis 2:14a5d6ad92d5 1778 * 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C
mluis 2:14a5d6ad92d5 1779 * };
mluis 0:91d1a7783bb9 1780 *
mluis 2:14a5d6ad92d5 1781 * MlmeReq_t mlmeReq;
mluis 2:14a5d6ad92d5 1782 * mlmeReq.Type = MLME_JOIN;
mluis 2:14a5d6ad92d5 1783 * mlmeReq.Req.Join.DevEui = DevEui;
mluis 2:14a5d6ad92d5 1784 * mlmeReq.Req.Join.AppEui = AppEui;
mluis 2:14a5d6ad92d5 1785 * mlmeReq.Req.Join.AppKey = AppKey;
mluis 2:14a5d6ad92d5 1786 *
mluis 2:14a5d6ad92d5 1787 * if( LoRaMacMlmeRequest( &mlmeReq ) == LORAMAC_STATUS_OK )
mluis 2:14a5d6ad92d5 1788 * {
mluis 2:14a5d6ad92d5 1789 * // Service started successfully. Waiting for the Mlme-Confirm event
mluis 2:14a5d6ad92d5 1790 * }
mluis 2:14a5d6ad92d5 1791 * \endcode
mluis 2:14a5d6ad92d5 1792 *
mluis 2:14a5d6ad92d5 1793 * \param [IN] mlmeRequest - MLME-Request to perform. Refer to \ref MlmeReq_t.
mluis 2:14a5d6ad92d5 1794 *
mluis 2:14a5d6ad92d5 1795 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1796 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1797 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1798 * \ref LORAMAC_STATUS_SERVICE_UNKNOWN,
mluis 2:14a5d6ad92d5 1799 * \ref LORAMAC_STATUS_PARAMETER_INVALID,
mluis 2:14a5d6ad92d5 1800 * \ref LORAMAC_STATUS_NO_NETWORK_JOINED,
mluis 2:14a5d6ad92d5 1801 * \ref LORAMAC_STATUS_LENGTH_ERROR,
mluis 2:14a5d6ad92d5 1802 * \ref LORAMAC_STATUS_DEVICE_OFF.
mluis 0:91d1a7783bb9 1803 */
mluis 2:14a5d6ad92d5 1804 LoRaMacStatus_t LoRaMacMlmeRequest( MlmeReq_t *mlmeRequest );
mluis 0:91d1a7783bb9 1805
mluis 0:91d1a7783bb9 1806 /*!
mluis 2:14a5d6ad92d5 1807 * \brief LoRaMAC MCPS-Request
mluis 2:14a5d6ad92d5 1808 *
mluis 2:14a5d6ad92d5 1809 * \details The Mac Common Part Sublayer handles data services. The following
mluis 2:14a5d6ad92d5 1810 * code-snippet shows how to use the API to send an unconfirmed
mluis 2:14a5d6ad92d5 1811 * LoRaMAC frame.
mluis 0:91d1a7783bb9 1812 *
mluis 2:14a5d6ad92d5 1813 * \code
mluis 2:14a5d6ad92d5 1814 * uint8_t myBuffer[] = { 1, 2, 3 };
mluis 2:14a5d6ad92d5 1815 *
mluis 2:14a5d6ad92d5 1816 * McpsReq_t mcpsReq;
mluis 2:14a5d6ad92d5 1817 * mcpsReq.Type = MCPS_UNCONFIRMED;
mluis 2:14a5d6ad92d5 1818 * mcpsReq.Req.Unconfirmed.fPort = 1;
mluis 2:14a5d6ad92d5 1819 * mcpsReq.Req.Unconfirmed.fBuffer = myBuffer;
mluis 2:14a5d6ad92d5 1820 * mcpsReq.Req.Unconfirmed.fBufferSize = sizeof( myBuffer );
mluis 0:91d1a7783bb9 1821 *
mluis 2:14a5d6ad92d5 1822 * if( LoRaMacMcpsRequest( &mcpsReq ) == LORAMAC_STATUS_OK )
mluis 2:14a5d6ad92d5 1823 * {
mluis 2:14a5d6ad92d5 1824 * // Service started successfully. Waiting for the MCPS-Confirm event
mluis 2:14a5d6ad92d5 1825 * }
mluis 2:14a5d6ad92d5 1826 * \endcode
mluis 2:14a5d6ad92d5 1827 *
mluis 2:14a5d6ad92d5 1828 * \param [IN] mcpsRequest - MCPS-Request to perform. Refer to \ref McpsReq_t.
mluis 2:14a5d6ad92d5 1829 *
mluis 2:14a5d6ad92d5 1830 * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
mluis 2:14a5d6ad92d5 1831 * \ref LORAMAC_STATUS_OK,
mluis 2:14a5d6ad92d5 1832 * \ref LORAMAC_STATUS_BUSY,
mluis 2:14a5d6ad92d5 1833 * \ref LORAMAC_STATUS_SERVICE_UNKNOWN,
mluis 2:14a5d6ad92d5 1834 * \ref LORAMAC_STATUS_PARAMETER_INVALID,
mluis 2:14a5d6ad92d5 1835 * \ref LORAMAC_STATUS_NO_NETWORK_JOINED,
mluis 2:14a5d6ad92d5 1836 * \ref LORAMAC_STATUS_LENGTH_ERROR,
mluis 2:14a5d6ad92d5 1837 * \ref LORAMAC_STATUS_DEVICE_OFF.
mluis 0:91d1a7783bb9 1838 */
mluis 2:14a5d6ad92d5 1839 LoRaMacStatus_t LoRaMacMcpsRequest( McpsReq_t *mcpsRequest );
mluis 0:91d1a7783bb9 1840
mluis 2:14a5d6ad92d5 1841 /*! \} defgroup LORAMAC */
mluis 0:91d1a7783bb9 1842
mluis 0:91d1a7783bb9 1843 #endif // __LORAMAC_H__