Modules | Files | Data Structures | Macros | Functions
LoRaMAC
Networking

LoRaMAC definitions. More...

Detailed Description

LoRaMAC definitions.

Modules

 LoRaMAC compile configurations
 

Files

file  loramac.h
 LoRaMAC header definitions.
 

Data Structures

struct  loramac_channel_t
 A LoRaMAC network channel. More...
 

Macros

#define LORAMAC_DEFAULT_ADR_ACK_LIMIT   (64U)
 Default adaptive datarate ACK limit (in s) More...
 
#define LORAMAC_DEFAULT_ADR_ACK_DELAY   (32U)
 Default adaptive datarate ACK delay (in s) More...
 
#define LORAMAC_DEFAULT_ADR_TIMEOUT   (3U)
 Default adaptive datarate timeout. More...
 
#define LORAMAC_DEFAULT_RX2_DELAY   (1000U + CONFIG_LORAMAC_DEFAULT_RX1_DELAY)
 Default second RX window delay (in ms)
 

Functions

static uint32_t lora_time_on_air (size_t pkt_len, loramac_dr_idx_t dr, uint8_t cr)
 Compute the time on air of a LoRa packet. More...
 

LoRaMAC parameters indexes

enum  loramac_class_t { LORAMAC_CLASS_A , LORAMAC_CLASS_B , LORAMAC_CLASS_C }
 Device class. More...
 
enum  loramac_join_mode_t { LORAMAC_JOIN_OTAA , LORAMAC_JOIN_ABP }
 LoRaMAC network join procedure type. More...
 
enum  loramac_tx_mode_t { LORAMAC_TX_CNF , LORAMAC_TX_UNCNF }
 LoRaMAC transmission mode. More...
 
enum  loramac_dr_idx_t {
  LORAMAC_DR_0 = 0 , LORAMAC_DR_1 , LORAMAC_DR_2 , LORAMAC_DR_3 ,
  LORAMAC_DR_4 , LORAMAC_DR_5 , LORAMAC_DR_6 , LORAMAC_DR_7 ,
  LORAMAC_DR_8 , LORAMAC_DR_9 , LORAMAC_DR_10 , LORAMAC_DR_11 ,
  LORAMAC_DR_12 , LORAMAC_DR_13 , LORAMAC_DR_14 , LORAMAC_DR_15
}
 LoRaMAC datarate indexes. More...
 
enum  loramac_tx_pwr_idx_t {
  LORAMAC_TX_PWR_0 = 0 , LORAMAC_TX_PWR_1 , LORAMAC_TX_PWR_2 , LORAMAC_TX_PWR_3 ,
  LORAMAC_TX_PWR_4 , LORAMAC_TX_PWR_5 , LORAMAC_TX_PWR_6 , LORAMAC_TX_PWR_7 ,
  LORAMAC_TX_PWR_8 , LORAMAC_TX_PWR_9 , LORAMAC_TX_PWR_10 , LORAMAC_TX_PWR_11 ,
  LORAMAC_TX_PWR_12 , LORAMAC_TX_PWR_13 , LORAMAC_TX_PWR_14 , LORAMAC_TX_PWR_15
}
 LoRaMAC transmission power indexes. More...
 

LoRaMAC constants

#define LORAMAC_DEVEUI_LEN   (8U)
 Device EUI length in bytes.
 
#define LORAMAC_DEVADDR_LEN   (4U)
 Device address length in bytes.
 
#define LORAMAC_APPEUI_LEN   (8U)
 Application EUI length in bytes.
 
#define LORAMAC_JOINEUI_LEN   (8U)
 Join EUI length in bytes.
 
#define LORAMAC_APPKEY_LEN   (16U)
 Application key length in bytes.
 
#define LORAMAC_NWKKEY_LEN   (16U)
 Network key length in bytes.
 
#define LORAMAC_APPSKEY_LEN   (16U)
 Application session key length in bytes.
 
#define LORAMAC_NWKSKEY_LEN   (16U)
 Network session key length in bytes.
 
#define LORAMAC_FNWKSINTKEY_LEN   (16U)
 Forwarding Network session integrity key length in bytes.
 
#define LORAMAC_SNWKSINTKEY_LEN   (16U)
 Serving Network session integrity key length in bytes.
 
#define LORAMAC_NWKSENCKEY_LEN   (16U)
 Network session encryption key length in bytes.
 
#define LORAMAC_JSINTKEY_LEN   (16U)
 Join session integrity key length in bytes. More...
 
#define LORAMAC_JSINTKEY_LEN   (16U)
 Join session integrity key length in bytes. More...
 
#define LORAMAC_JSENCKEY_LEN   (16U)
 Join session encryption key length in bytes.
 
#define LORAMAC_PORT_MIN   (1U)
 Minimum port value.
 
#define LORAMAC_PORT_MAX   (223U)
 Maximum port value.
 
#define LORAMAC_APP_NONCE_LEN   (3U)
 Application Nonce length in bytes.
 
#define LORAMAC_JOIN_NONCE_LEN   (3U)
 Join nonce length in bytes.
 
#define LORAMAC_NETWORK_ID_LEN   (3U)
 Network ID length in bytes.
 
#define LORAMAC_CHANNELS_MASK_LEN   (1U)
 Channel mask length. More...
 

Macro Definition Documentation

◆ LORAMAC_CHANNELS_MASK_LEN

#define LORAMAC_CHANNELS_MASK_LEN   (1U)

Channel mask length. 

     Must match CHANNELS_MASK_SIZE in src/mac/region/RegionXXYYY.c

Definition at line 649 of file loramac.h.

◆ LORAMAC_DEFAULT_ADR_ACK_DELAY

#define LORAMAC_DEFAULT_ADR_ACK_DELAY   (32U)

Default adaptive datarate ACK delay (in s)

Note
This feature is not yet supported.

Definition at line 525 of file loramac.h.

◆ LORAMAC_DEFAULT_ADR_ACK_LIMIT

#define LORAMAC_DEFAULT_ADR_ACK_LIMIT   (64U)

Default adaptive datarate ACK limit (in s)

Note
This feature is not yet supported.

Definition at line 516 of file loramac.h.

◆ LORAMAC_DEFAULT_ADR_TIMEOUT

#define LORAMAC_DEFAULT_ADR_TIMEOUT   (3U)

Default adaptive datarate timeout.

Note
This feature is not yet supported.

Definition at line 534 of file loramac.h.

◆ LORAMAC_JSINTKEY_LEN [1/2]

#define LORAMAC_JSINTKEY_LEN   (16U)

Join session integrity key length in bytes.

Network session encryption key length in bytes.

Definition at line 614 of file loramac.h.

◆ LORAMAC_JSINTKEY_LEN [2/2]

#define LORAMAC_JSINTKEY_LEN   (16U)

Join session integrity key length in bytes.

Network session encryption key length in bytes.

Definition at line 614 of file loramac.h.

Enumeration Type Documentation

◆ loramac_class_t

enum loramac_class_t

Device class.

Enumerator
LORAMAC_CLASS_A 

Class A device.

LORAMAC_CLASS_B 

Class B device.

LORAMAC_CLASS_C 

Class C device.

Definition at line 662 of file loramac.h.

◆ loramac_dr_idx_t

enum loramac_dr_idx_t

LoRaMAC datarate indexes. 

     Each index corresponds to a different modulation, spreading factor
     and bandwidth depending on the regions.
Enumerator
LORAMAC_DR_0 
  • ISM EU863-870: LoRa modulation, SF12, BW125 (250bit/s)
  • ISM US902-928: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM CN779-787: LoRa modulation, SF12, BW125 (250bit/s)
  • ISM EU433: LoRa modulation, SF12, BW125 (250bit/s)
  • ISM AU915-928: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM CN470-510: LoRa modulation, SF12, BW125 (250bit/s)
  • ISM AS923: LoRa modulation, SF12, BW125 (250bit/s)
  • ISM KR920-923: LoRa modulation, SF12, BW125 (250bit/s)

Default value used.

LORAMAC_DR_1 
  • ISM EU863-870: LoRa modulation, SF11, BW125 (440bit/s)
  • ISM US902-928: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM CN779-787: LoRa modulation, SF11, BW125 (440bit/s)
  • ISM EU433: LoRa modulation, SF11, BW125 (440bit/s)
  • ISM AU915-928: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM CN470-510: LoRa modulation, SF11, BW125 (440bit/s)
  • ISM AS923: LoRa modulation, SF11, BW125 (440bit/s)
  • ISM KR920-923: LoRa modulation, SF11, BW125 (440bit/s)
LORAMAC_DR_2 
  • ISM EU863-870: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM US902-928: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM CN779-787: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM EU433: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM AU915-928: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM CN470-510: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM AS923: LoRa modulation, SF10, BW125 (980bit/s)
  • ISM KR920-923: LoRa modulation, SF10, BW125 (980bit/s)
LORAMAC_DR_3 
  • ISM EU863-870: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM US902-928: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM CN779-787: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM EU433: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM AU915-928: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM CN470-510: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM AS923: LoRa modulation, SF9, BW125 (1760bit/s)
  • ISM KR920-923: LoRa modulation, SF9, BW125 (1760bit/s)
LORAMAC_DR_4 
  • ISM EU863-870: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM US902-928: LoRa modulation, SF8, BW500 (12500bit/s)
  • ISM CN779-787: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM EU433: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM AU915-928: LoRa modulation, SF8, BW500 (12500bit/s)
  • ISM CN470-510: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM AS923: LoRa modulation, SF8, BW125 (3125bit/s)
  • ISM KR920-923: LoRa modulation, SF8, BW125 (3125bit/s)
LORAMAC_DR_5 
  • ISM EU863-870: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM US902-928: reserved for future use
  • ISM CN779-787: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM EU433: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM AU915-928: reserved for future use
  • ISM CN470-510: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM AS923: LoRa modulation, SF7, BW125 (5470bit/s)
  • ISM KR920-923: LoRa modulation, SF7, BW125 (5470bit/s)
LORAMAC_DR_6 
  • ISM EU863-870: LoRa modulation, SF7, BW250 (11000bit/s)
  • ISM US902-928: reserved for future use
  • ISM CN779-787: LoRa modulation, SF7, BW250 (11000bit/s)
  • ISM EU433 : LoRa modulation, SF7, BW250 (11000bit/s)
  • ISM AU915-928: reserved for future use
  • ISM CN470-510: reserved for future use
  • ISM AS923: LoRa modulation, SF7, BW250 (11000bit/s)
  • ISM KR920-923: reserved for future use
LORAMAC_DR_7 
  • ISM EU863-870: FSK modulation (50000bit/s)
  • ISM US902-928: reserved for future use
  • ISM CN779-787: FSK modulation (50000bit/s)
  • ISM EU433: FSK modulation (50000bit/s)
  • ISM AU915-928: reserved for future use
  • ISM CN470-510: reserved for future use
  • ISM AS923: FSK modulation (50000bit/s)
  • ISM KR920-923: reserved for future use
LORAMAC_DR_8 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: LoRa modulation, SF12, BW500 (980bit/s)
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: LoRa modulation, SF12, BW500 (980bit/s)
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_9 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: LoRa modulation, SF11, BW500 (1760bit/s)
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: LoRa modulation, SF11, BW500 (1760bit/s)
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_10 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: LoRa modulation, SF10, BW500 (3900bit/s)
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: LoRa modulation, SF10, BW500 (3900bit/s)
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_11 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: LoRa modulation, SF9, BW500 (7000bit/s)
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: LoRa modulation, SF9, BW500 (7000bit/s)
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_12 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: LoRa modulation, SF8, BW500 (12500bit/s)
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: LoRa modulation, SF8, BW500 (12500bit/s)
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_13 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: LoRa modulation, SF7, BW500 (21900bit/s)
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: LoRa modulation, SF7, BW500 (21900bit/s)
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_14 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: reserved for future use
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: reserved for future use
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use
LORAMAC_DR_15 
  • ISM EU863-870: reserved for future use
  • ISM US902-928: reserved for future use
  • ISM CN779-787: reserved for future use
  • ISM EU433: reserved for future use
  • ISM AU915-928: reserved for future use
  • ISM CN470-510: reserved for future use
  • ISM AS923: reserved for future use
  • ISM KR920-923: reserved for future use

Definition at line 690 of file loramac.h.

◆ loramac_join_mode_t

enum loramac_join_mode_t

LoRaMAC network join procedure type.

Enumerator
LORAMAC_JOIN_OTAA 

Other-the-air activation.

LORAMAC_JOIN_ABP 

Activation by personnalization.

Definition at line 671 of file loramac.h.

◆ loramac_tx_mode_t

enum loramac_tx_mode_t

LoRaMAC transmission mode.

Enumerator
LORAMAC_TX_CNF 

Confirmable transmission mode.

LORAMAC_TX_UNCNF 

Unconfirmable transmission mode.

Definition at line 679 of file loramac.h.

◆ loramac_tx_pwr_idx_t

enum loramac_tx_pwr_idx_t

LoRaMAC transmission power indexes. 

     Each index corresponds to a different modulation, spreading factor
     and bandwidth depending on the regions.
Enumerator
LORAMAC_TX_PWR_0 
  • EU863-870: 20dBm (if supported)
  • US902-928: 30dBm (if supported)
  • CN779-787: 10dBm
  • EU433: 10dBm
  • AU915-928: 30dBm
  • CN470-510: 17dBm
  • ISM AS923: 14dBm
  • ISM KR920-923: 20dBm
LORAMAC_TX_PWR_1 
  • EU863-870: 14dBm
  • US902-928: 28dBm
  • CN779-787: 7dBm
  • EU433: 7dBm
  • AU915-928: 28dBm
  • CN470-510: 16dBm
  • ISM AS923: 12dBm
  • ISM KR920-923: 14dBm

Default value used

LORAMAC_TX_PWR_2 
  • EU863-870: 11dBm
  • US902-928: 26dBm
  • CN779-787: 4dBm
  • EU433: 4dBm
  • AU915-928: 26dBm
  • CN470-510: 14dBm
  • ISM AS923: 10dBm
  • ISM KR920-923: 10dBm
LORAMAC_TX_PWR_3 
  • EU863-870: 8dBm
  • US902-928: 24dBm
  • CN779-787: 1dBm
  • EU433: 1dBm
  • AU915-928: 24dBm
  • CN470-510: 12dBm
  • ISM AS923: 8dBm
  • ISM KR920-923: 8dBm
LORAMAC_TX_PWR_4 
  • EU863-870: 5dBm
  • US902-928: 22dBm
  • CN779-787: -2dBm
  • EU433: -2dBm
  • AU915-928: 22dBm
  • CN470-510: 10dBm
  • ISM AS923: 6dBm
  • ISM KR920-923: 5dBm
LORAMAC_TX_PWR_5 
  • EU863-870: 2dBm
  • US902-928: 20dBm
  • CN779-787: -5dBm
  • EU433: -5dBm
  • AU915-928: 20dBm
  • CN470-510: 7dBm
  • ISM AS923: 4dBm
  • ISM KR920-923: 2dBm
LORAMAC_TX_PWR_6 
  • EU863-870: Reserved for future use
  • US902-928: 18dBm
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: 18dBm
  • CN470-510: 5dBm
  • ISM AS923: Reserved for future use
  • ISM KR920-923: 0dBm
LORAMAC_TX_PWR_7 
  • EU863-870: Reserved for future use
  • US902-928: 16dBm
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: 16dBm
  • CN470-510: 2dBm
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_8 
  • EU863-870: Reserved for future use
  • US902-928: 14dBm
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: 14dBm
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_9 
  • EU863-870: Reserved for future use
  • US902-928: 12dBm
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: 12dBm
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_10 
  • EU863-870: Reserved for future use
  • US902-928: 10dBm
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: 10dBm
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_11 
  • EU863-870: Reserved for future use
  • US902-928: Reserved for future use
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: Reserved for future use
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_12 
  • EU863-870: Reserved for future use
  • US902-928: Reserved for future use
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: Reserved for future use
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_13 
  • EU863-870: Reserved for future use
  • US902-928: Reserved for future use
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: Reserved for future use
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_14 
  • EU863-870: Reserved for future use
  • US902-928: Reserved for future use
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: Reserved for future use
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use
LORAMAC_TX_PWR_15 
  • EU863-870: Reserved for future use
  • US902-928: Reserved for future use
  • CN779-787: Reserved for future use
  • EU433: Reserved for future use
  • AU915-928: Reserved for future use
  • CN470-510: Reserved for future use
  • ISM AS923: Reserved for future use
  • ISM KR920-923: Reserved for future use

Definition at line 877 of file loramac.h.

Function Documentation

◆ lora_time_on_air()

static uint32_t lora_time_on_air ( size_t  pkt_len,
loramac_dr_idx_t  dr,
uint8_t  cr 
)
inlinestatic

Compute the time on air of a LoRa packet.

This function uses a precomputed table to calculate time on air without using floating point arithmetic

Parameters
[in]pkt_lenLength of a packet in bytes
[in]drDatarate used to send the packet
[in]crCoding rate used to send the packet
Returns
time on air in us

Definition at line 1081 of file loramac.h.