lorawan_conf.h File Reference

Header for LoRaWAN middleware instances. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	LORAMAC_SPECIFICATION_VERSION   0x01000400
	LoRaWAN version definition.
#define	LORAWAN_DATA_DISTRIB_MGT   0
	Enable the additional LoRaWAN packages.
#define	LORAWAN_PACKAGES_VERSION   1
	LoRaWAN packages version.
#define	REGION_EU868
#define	REGION_US915
#define	REGION_AS923_DEFAULT_CHANNEL_PLAN   CHANNEL_PLAN_GROUP_AS923_1
	Default channel plan for region AS923.
#define	HYBRID_ENABLED   0
	Limits the number usable channels by default for AU915, CN470 and US915 regions.
#define	KEY_EXTRACTABLE   1
	Define the read access of the keys in memory.
#define	CONTEXT_MANAGEMENT_ENABLED   1
	Enables/Disables the context storage management storage.
#define	LORAMAC_CLASSB_ENABLED   0
	Enables/Disables the LoRaWAN Class B (Periodic ping downlink slots + Beacon for synchronization).
#define	DISABLE_LORAWAN_RX_WINDOW   0
	Disable the ClassA receive windows after Tx (after the Join Accept if OTAA mode defined).
#define	CRITICAL_SECTION_BEGIN()
#define	CRITICAL_SECTION_END()

Detailed Description

Header for LoRaWAN middleware instances.

Author

MCD Application Team

Attention

Copyright (c) 2026 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file lorawan_conf.h.

Macro Definition Documentation

CONTEXT_MANAGEMENT_ENABLED

#define CONTEXT_MANAGEMENT_ENABLED   1

Enables/Disables the context storage management storage.

Note

Must be enabled for LoRaWAN 1.0.4 or later.

Definition at line 131 of file lorawan_conf.h.

CRITICAL_SECTION_BEGIN

#define CRITICAL_SECTION_BEGIN

(

)

Value:

UTILS_ENTER_CRITICAL_SECTION( )

Definition at line 183 of file lorawan_conf.h.

CRITICAL_SECTION_END

#define CRITICAL_SECTION_END

(

)

Value:

UTILS_EXIT_CRITICAL_SECTION( )

Definition at line 186 of file lorawan_conf.h.

DISABLE_LORAWAN_RX_WINDOW

#define DISABLE_LORAWAN_RX_WINDOW   0

Disable the ClassA receive windows after Tx (after the Join Accept if OTAA mode defined).

Note

Behavior to reduce power consumption but not compliant with LoRa Alliance recommendations. All device parameters (Spreading Factor, channels selection, Tx Power, ...) should be fixed and the adaptive datarate should be disabled.

Warning

This limitation may have consequences for the proper functioning of the device, if the LoRaMac ever generates MAC commands that require a response.

Definition at line 170 of file lorawan_conf.h.

HYBRID_ENABLED

#define HYBRID_ENABLED   0

Limits the number usable channels by default for AU915, CN470 and US915 regions.

Note

the default channel mask with this option activates the first 8 channels. \ this default mask can be modified in the RegionXXXXXInitDefaults function associated with the active region.

Definition at line 119 of file lorawan_conf.h.

KEY_EXTRACTABLE

#define KEY_EXTRACTABLE   1

Define the read access of the keys in memory.

Note

this value should be disabled after the development process

Definition at line 125 of file lorawan_conf.h.

LORAMAC_CLASSB_ENABLED

#define LORAMAC_CLASSB_ENABLED   0

Enables/Disables the LoRaWAN Class B (Periodic ping downlink slots + Beacon for synchronization).

Definition at line 137 of file lorawan_conf.h.

LORAMAC_SPECIFICATION_VERSION

#define LORAMAC_SPECIFICATION_VERSION   0x01000400

LoRaWAN version definition.

Note

0x01000400: Link Layer TS001-1.0.4 + Regional Parameters RP002-1.0.1

Definition at line 58 of file lorawan_conf.h.

LORAWAN_DATA_DISTRIB_MGT

#define LORAWAN_DATA_DISTRIB_MGT   0

Enable the additional LoRaWAN packages.

Note

LoRaWAN Packages available when enabled:

• Application Layer Clock Synchronization (Package ID: 1, Default Port: 202)
• Remote Multicast Setup (Package ID: 2, Default Port: 200)
• Fragmented Data Block Transport (Package ID: 3, Default Port: 201)
• Firmware Management Protocol (Package ID: 4, Default Port: 203) The Certification Protocol is also defined as a mandatory package (Package ID: 0, Default Port: 224)

Definition at line 69 of file lorawan_conf.h.

LORAWAN_PACKAGES_VERSION

#define LORAWAN_PACKAGES_VERSION   1

LoRaWAN packages version.

Note

When LORAWAN_DATA_DISTRIB_MGT is enabled, 2 possibles values:

• 1: v1.0.0 packages including:
  • Application Layer Clock Synchronization v1.0.0
  • Remote Multicast Setup v1.0.0
  • Fragmented Data Block Transport v1.0.0
• 2: v2.0.0 packages including:
  • Application Layer Clock Synchronization v2.0.0
  • Remote Multicast Setup v2.0.0
  • Fragmented Data Block Transport v2.0.0
  • Firmware Management Protocol v1.0.0

Definition at line 84 of file lorawan_conf.h.

REGION_AS923_DEFAULT_CHANNEL_PLAN

#define REGION_AS923_DEFAULT_CHANNEL_PLAN   CHANNEL_PLAN_GROUP_AS923_1

Default channel plan for region AS923.

Note

Possible selections:

• CHANNEL_PLAN_GROUP_AS923_1 (Default configuration. Freq offset = 0.0 MHz / Freq range = 915-928MHz)
• CHANNEL_PLAN_GROUP_AS923_2 (Freq offset = -1.80 MHz / Freq range = 915-928MHz)
• CHANNEL_PLAN_GROUP_AS923_3 (Freq offset = -6.60 MHz / Freq range = 915-928MHz)
• CHANNEL_PLAN_GROUP_AS923_4 (Freq offset = -5.90 MHz / Freq range = 917-920MHz)
• CHANNEL_PLAN_GROUP_AS923_1_JP (Freq offset = 0.0 MHz / Freq range = 920.6-923.4MHz)
• CHANNEL_PLAN_GROUP_AS923_1_JP_CH24_CH38_LBT (RP02-1.0.3)
• CHANNEL_PLAN_GROUP_AS923_1_JP_CH24_CH38_DC (RP02-1.0.3)
• CHANNEL_PLAN_GROUP_AS923_1_JP_CH33_CH61_LBT_DC (RP02-1.0.3)

Definition at line 112 of file lorawan_conf.h.

REGION_EU868

#define REGION_EU868

Definition at line 94 of file lorawan_conf.h.

REGION_US915

#define REGION_US915

Definition at line 97 of file lorawan_conf.h.