LoRaMAC¶
LoRaMAC definitions.
-
LORAMAC_DEV_EUI_DEFAULT
¶ Default device EUI.
1 2
{ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00 }
8 bytes key, required for join procedure
-
LORAMAC_APP_EUI_DEFAULT
¶ Default application EUI.
1 2
{ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00 }
8 bytes key, required for join procedure
-
LORAMAC_APP_KEY_DEFAULT
¶ Default application key.
1 2 3 4
{ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00 }
16 bytes key, required for join procedure
-
LORAMAC_APP_SKEY_DEFAULT
¶ Default application session key.
1 2 3 4
{ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00 }
16 bytes key, only required for ABP join procedure type
-
LORAMAC_NWK_SKEY_DEFAULT
¶ Default network session key.
1 2 3 4
{ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00 }
16 bytes key, only required for ABP join procedure type.
-
LORAMAC_DEV_ADDR_DEFAULT
¶ Default device address.
1
{ 0x00, 0x00, 0x00, 0x00 }
-
LORAMAC_DEFAULT_DEVICE_CLASS
¶ Default device class (A, B or C)
1
(LORAMAC_CLASS_A)
-
LORAMAC_DEFAULT_NETID
¶ Default NetID (only valid with ABP join procedure)
1
(1U)
-
LORAMAC_DEFAULT_PUBLIC_NETWORK
¶ Default network type (public or private)
1
(true)
-
LORAMAC_DEFAULT_DR
¶ Default datarate (only valid for EU)
1
(LORAMAC_DR_0)
-
LORAMAC_DEFAULT_TX_POWER
¶ Default MAC TX power (14dBm in EU)
1
(LORAMAC_TX_PWR_1)
-
LORAMAC_DEFAULT_TX_PORT
¶ Default MAC TX port (from 1 to 223)
1
(2U)
-
LORAMAC_DEFAULT_TX_MODE
¶ Default MAC TX mode (confirmable or unconfirmable)
1
(LORAMAC_TX_CNF)
-
LORAMAC_DEFAULT_ADR
¶ Default MAC TX power (14dBm in EU)
1
(false)
Default adaptive datarate state
-
LORAMAC_DEFAULT_RETX
¶ Default uplink retransmission.
1
(5U)
-
LORAMAC_DEFAULT_LINKCHK
¶ Default link check interval (in seconds)
1
(0U)
0 means the link check process is disabled
-
LORAMAC_DEFAULT_RX1_DELAY
¶ Default first RX window delay (in s)
1
(1U)
-
LORAMAC_DEFAULT_RX2_DELAY
¶ Default first RX window delay (in s)
1
(1U + LORAMAC_DEFAULT_RX1_DELAY)
-
LORAMAC_DEFAULT_AR
¶ Default automatic reply status.
1
(false)
-
LORAMAC_DEFAULT_RX2_DR
¶ Default second RX window datarate index.
1
(LORAMAC_DR_0)
-
LORAMAC_DEFAULT_RX2_FREQ
¶ Default second RX window frequency (in Hz)
1
(869525000UL)
-
LORAMAC_DEFAULT_JOIN_PROCEDURE
¶ Default LoRaMAC join procedure.
1
(LORAMAC_JOIN_OTAA)
-
LORAMAC_DEFAULT_JOIN_DELAY1
¶ Default LoRaMAC join accept delay 1 (in seconds)
1
(5U)
-
LORAMAC_DEFAULT_JOIN_DELAY2
¶ Default LoRaMAC join accept delay 2.
1
(6U)
-
LORAMAC_DEFAULT_MAX_FCNT_GAP
¶ Default max FCNT gap.
1
(16384U)
-
LORAMAC_DEFAULT_ADR_ACK_LIMIT
¶ Default adaptive datarate ACK limit (in s)
1
(64U)
-
LORAMAC_DEFAULT_ADR_ACK_DELAY
¶ Default adaptive datarate ACK delay (in s)
1
(32U)
-
LORAMAC_DEFAULT_ADR_TIMEOUT
¶ Default adaptive datarate timeout.
1
(3U)
-
LORAMAC_DEVEUI_LEN
¶ Device EUI length in bytes.
1
(8U)
-
LORAMAC_DEVADDR_LEN
¶ Device address length in bytes.
1
(4U)
-
LORAMAC_APPEUI_LEN
¶ Application EUI length in bytes.
1
(8U)
-
LORAMAC_APPKEY_LEN
¶ Application key length in bytes.
1
(16U)
-
LORAMAC_APPSKEY_LEN
¶ Application session key length in bytes.
1
(16U)
-
LORAMAC_NWKSKEY_LEN
¶ Network session key length in bytes.
1
(16U)
-
LORAMAC_PORT_MIN
¶ Minimum port value.
1
(1U)
-
LORAMAC_PORT_MAX
¶ Maximmu port value.
1
(223U)
-
enum
loramac_class_t
¶ - LORAMAC_CLASS_A
- Class A device.
- LORAMAC_CLASS_B
- Class B device.
- LORAMAC_CLASS_C
- Class C device.
-
enum
loramac_join_mode_t
¶ - LORAMAC_JOIN_OTAA
- Other-the-air activation.
- LORAMAC_JOIN_ABP
- Activation by personnalization.
-
enum
loramac_tx_mode_t
¶ - LORAMAC_TX_CNF
- Confirmable transmission mode.
- LORAMAC_TX_UNCNF
- Unconfirmable transmission mode.
-
enum
loramac_dr_idx_t
¶ - LORAMAC_DR_0
= 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
- LORAMAC_DR_0
-
enum
loramac_tx_pwr_idx_t
¶ - LORAMAC_TX_PWR_0
= 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
- LORAMAC_TX_PWR_0
-
struct
loramac_channel_t
¶ A LoRaMAC network channel.
-
uint32_t
freq
¶ Center frequency in Hz.
-
uint8_t
index
¶ Channel index in defined list.
-
uint8_t
bw
¶ Bandwidth index.
-
uint8_t
dr_min
¶ Minimum datarate index.
-
uint8_t
dr_max
¶ Maximum datarate index.
-
uint8_t
dcycle
¶ Duty cycle to use on this channel (1 to 100)
-
uint32_t