SX126x-Arduino  1.2.1
Macros
Commissioning.h File Reference

Go to the source code of this file.

Macros

#define REGION_US915
 Define your region here Required because each region has different regulations The LoRa Alliance offers documentation for the regional parameters Latest revision when this library was created https://lora-alliance.org/resource-hub/lorawanr-regional-parameters-v11rb Check https://lora-alliance.org/resource-hub for any updates. More...
 
#define LORAWAN_DUTYCYCLE_ON   true
 Enable or disable duty cycle control LoRaWAN ETSI duty cycle control enable/disable. Please note that ETSI mandates duty cycled transmissions. Use only for test purposes. More...
 
#define LORAWAN_DUTYCYCLE_OFF   false
 
#define LORAWAN_PUBLIC_NETWORK   true
 Indicates if the end-device is to be connected to a private or public network. More...
 
#define LORAWAN_PRIVAT_NETWORK   false
 
#define LORAWAN_ADR_ON   true
 Enable or disable LoRaWAN Adaptive Data Rate enabled (the end-device should be static here). More...
 
#define LORAWAN_ADR_OFF   false
 
#define STATIC_DEVICE_EUI   1
 Select if a hard coded device ID is used or an automatic generated one When set to 1 DevEui is LORAWAN_DEVICE_EUI When set to 0 DevEui is automatically generated by calling BoardGetUniqueId function. More...
 
#define LORAWAN_DEVICE_EUI
 Mote device IEEE EUI (big endian) More...
 
#define LORAWAN_APPLICATION_EUI
 Application IEEE EUI (big endian) More...
 
#define LORAWAN_APPLICATION_KEY
 AES encryption/decryption cipher application key. More...
 
#define LORAWAN_NETWORK_ID   (uint32_t)0
 Current network ID. More...
 
#define STATIC_DEVICE_ADDRESS   1
 Select if a hard coded device address is used or an automatic generated one When set to 1 DevAdd is LORAWAN_DEVICE_ADDRESS When set to 0 DevAdd is automatically generated using a pseudo random generator seeded with a value derived from BoardUniqueId value. More...
 
#define LORAWAN_DEVICE_ADDRESS   (uint32_t)0x00000000
 Device address on the network (big endian) More...
 
#define LORAWAN_NWKSKEY
 AES encryption/decryption cipher network session key. More...
 
#define LORAWAN_APPSKEY
 AES encryption/decryption cipher application session key. More...
 

Macro Definition Documentation

◆ REGION_US915

#define REGION_US915

Define your region here Required because each region has different regulations The LoRa Alliance offers documentation for the regional parameters Latest revision when this library was created https://lora-alliance.org/resource-hub/lorawanr-regional-parameters-v11rb Check https://lora-alliance.org/resource-hub for any updates.

Choose a matching region from below REGION_AS923 -> Asia 923 MHz REGION_AU915 -> Australia 915 MHz REGION_CN470 -> China 470 MHz REGION_CN779 -> China 779 MHz REGION_EU433 -> Europe 433 MHz REGION_EU868 -> Europe 868 MHz REGION_IN865 -> India 865 MHz REGION_KR920 -> Korea 920 MHz REGION_US915 -> US 915 MHz

◆ LORAWAN_DUTYCYCLE_ON

#define LORAWAN_DUTYCYCLE_ON   true

Enable or disable duty cycle control LoRaWAN ETSI duty cycle control enable/disable. Please note that ETSI mandates duty cycled transmissions. Use only for test purposes.

LoRaWAN duty cycle enabled

◆ LORAWAN_DUTYCYCLE_OFF

#define LORAWAN_DUTYCYCLE_OFF   false

LoRaWAN duty cycle disabled

Examples
LoRaWanPio\src\main.cpp.

◆ LORAWAN_PUBLIC_NETWORK

#define LORAWAN_PUBLIC_NETWORK   true

Indicates if the end-device is to be connected to a private or public network.

LoRaWAN public network

Examples
LoRaWanPio\src\main.cpp.

◆ LORAWAN_PRIVAT_NETWORK

#define LORAWAN_PRIVAT_NETWORK   false

LoRaWAN private network

◆ LORAWAN_ADR_ON

#define LORAWAN_ADR_ON   true

Enable or disable LoRaWAN Adaptive Data Rate enabled (the end-device should be static here).

LoRaWAN Adaptive Data Rate enabled (the end-device should be static here).

Examples
LoRaWanPio\src\main.cpp.

◆ LORAWAN_ADR_OFF

#define LORAWAN_ADR_OFF   false

LoRaWAN Adaptive Data Rate disabled.

◆ STATIC_DEVICE_EUI

#define STATIC_DEVICE_EUI   1

Select if a hard coded device ID is used or an automatic generated one When set to 1 DevEui is LORAWAN_DEVICE_EUI When set to 0 DevEui is automatically generated by calling BoardGetUniqueId function.

◆ LORAWAN_DEVICE_EUI

#define LORAWAN_DEVICE_EUI
Value:
{ \
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 \
}

Mote device IEEE EUI (big endian)

Remarks
see STATIC_DEVICE_EUI comments

◆ LORAWAN_APPLICATION_EUI

#define LORAWAN_APPLICATION_EUI
Value:
{ \
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 \
}

Application IEEE EUI (big endian)

◆ LORAWAN_APPLICATION_KEY

#define LORAWAN_APPLICATION_KEY
Value:
{ \
0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C \
}

AES encryption/decryption cipher application key.

◆ LORAWAN_NETWORK_ID

#define LORAWAN_NETWORK_ID   (uint32_t)0

Current network ID.

◆ STATIC_DEVICE_ADDRESS

#define STATIC_DEVICE_ADDRESS   1

Select if a hard coded device address is used or an automatic generated one When set to 1 DevAdd is LORAWAN_DEVICE_ADDRESS When set to 0 DevAdd is automatically generated using a pseudo random generator seeded with a value derived from BoardUniqueId value.

◆ LORAWAN_DEVICE_ADDRESS

#define LORAWAN_DEVICE_ADDRESS   (uint32_t)0x00000000

Device address on the network (big endian)

Remarks
In this application the value is automatically generated using a pseudo random generator seeded with a value derived from BoardUniqueId value if LORAWAN_DEVICE_ADDRESS is set to 0

◆ LORAWAN_NWKSKEY

#define LORAWAN_NWKSKEY
Value:
{ \
0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C \
}

AES encryption/decryption cipher network session key.

◆ LORAWAN_APPSKEY

#define LORAWAN_APPSKEY
Value:
{ \
0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C \
}

AES encryption/decryption cipher application session key.