-
Alexandre Abadie authoredAlexandre Abadie authored
loramac.h 20.56 KiB
/*
* Copyright (C) 2017 Inria
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup net_loramac LoRaMAC
* @ingroup net
* @brief LoRaMAC definitions
*
* @{
*
* @file
* @brief LoRaMAC header definitions
*
* @author Alexandre Abadie <alexandre.abadie@inria.fr>
*/
#ifndef NET_LORAMAC_H
#define NET_LORAMAC_H
#include <stdint.h>
#include <stdlib.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @name LoRaMAC default parameters
* @{
*/
/**
* @brief Default device EUI
*
* 8 bytes key, required for join procedure
*/
#ifndef LORAMAC_DEV_EUI_DEFAULT
#define LORAMAC_DEV_EUI_DEFAULT { 0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00 }
#endif
/**
* @brief Default application EUI
*
* 8 bytes key, required for join procedure
*/
#ifndef LORAMAC_APP_EUI_DEFAULT
#define LORAMAC_APP_EUI_DEFAULT { 0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00 }
#endif
/**
* @brief Default application key
*
* 16 bytes key, required for join procedure
*/
#ifndef LORAMAC_APP_KEY_DEFAULT
#define LORAMAC_APP_KEY_DEFAULT { 0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00 }
#endif
/**
* @brief Default application session key
* * 16 bytes key, only required for ABP join procedure type
*/
#ifndef LORAMAC_APP_SKEY_DEFAULT
#define LORAMAC_APP_SKEY_DEFAULT { 0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00 }
#endif
/**
* @brief Default network session key
*
* 16 bytes key, only required for ABP join procedure type.
*/
#ifndef LORAMAC_NWK_SKEY_DEFAULT
#define LORAMAC_NWK_SKEY_DEFAULT { 0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, 0x00, 0x00 }
#endif
/**
* @brief Default device address
*/
#ifndef LORAMAC_DEV_ADDR_DEFAULT
#define LORAMAC_DEV_ADDR_DEFAULT { 0x00, 0x00, 0x00, 0x00 }
#endif
/** @} */
/**
* @name LoRaMAC default values
* @{
*/
/**
* @brief Default NetID (only valid with ABP join procedure)
*/
#ifndef LORAMAC_DEFAULT_NETID
#define LORAMAC_DEFAULT_NETID (1U)
#endif
/**
* @brief Default network type (public or private)
*/
#ifndef LORAMAC_DEFAULT_PUBLIC_NETWORK
#define LORAMAC_DEFAULT_PUBLIC_NETWORK (true)
#endif
/**
* @brief Default datarate (only valid for EU)
*/
#ifndef LORAMAC_DEFAULT_DR
#define LORAMAC_DEFAULT_DR (LORAMAC_DR_0)
#endif
/**
* @brief Default MAC TX power (14dBm in EU)
*/
#ifndef LORAMAC_DEFAULT_TX_POWER
#define LORAMAC_DEFAULT_TX_POWER (LORAMAC_TX_PWR_1)
#endif
/**
* @brief Default MAC TX port (from 1 to 223)
*/
#ifndef LORAMAC_DEFAULT_TX_PORT
#define LORAMAC_DEFAULT_TX_PORT (2U)
#endif
/**
* @brief Default MAC TX mode (confirmable or unconfirmable)
*/ #ifndef LORAMAC_DEFAULT_TX_MODE
#define LORAMAC_DEFAULT_TX_MODE (LORAMAC_TX_CNF)
#endif
/**
* @brief Default MAC TX power (14dBm in EU)
*/
#ifndef LORAMAC_DEFAULT_TX_POWER
#define LORAMAC_DEFAULT_TX_POWER (LORAMAC_TX_PWR_1)
#endif
/**
* @brief Default adaptive datarate state
*/
#ifndef LORAMAC_DEFAULT_ADR
#define LORAMAC_DEFAULT_ADR (false)
#endif
/**
* @brief Default uplink retransmission
*/
#ifndef LORAMAC_DEFAULT_RETX
#define LORAMAC_DEFAULT_RETX (5U)
#endif
/**
* @brief Default link check interval (in seconds)
*
* 0 means the link check process is disabled
*/
#ifndef LORAMAC_DEFAULT_LINKCHK
#define LORAMAC_DEFAULT_LINKCHK (0U)
#endif
/**
* @brief Default first RX window delay (in s)
*/
#ifndef LORAMAC_DEFAULT_RX1_DELAY
#define LORAMAC_DEFAULT_RX1_DELAY (1U)
#endif
/**
* @brief Default first RX window delay (in s)
*/
#define LORAMAC_DEFAULT_RX2_DELAY (1U + LORAMAC_DEFAULT_RX1_DELAY)
/**
* @brief Default automatic reply status
*/
#ifndef LORAMAC_DEFAULT_AR
#define LORAMAC_DEFAULT_AR (false)
#endif
/**
* @brief Default second RX window datarate index
*/
#ifndef LORAMAC_DEFAULT_RX2_DR
#define LORAMAC_DEFAULT_RX2_DR (LORAMAC_DR_0)
#endif
/**
* @brief Default second RX window frequency (in Hz)
*/
#ifndef LORAMAC_DEFAULT_RX2_FREQ
#define LORAMAC_DEFAULT_RX2_FREQ (869525000UL)
#endif
/**
* @brief Default LoRaMAC join procedure
*/#ifndef LORAMAC_DEFAULT_JOIN_PROCEDURE
#define LORAMAC_DEFAULT_JOIN_PROCEDURE (LORAMAC_JOIN_OTAA)
#endif
/**
* @brief Default LoRaMAC join accept delay 1 (in seconds)
*/
#ifndef LORAMAC_DEFAULT_JOIN_DELAY1
#define LORAMAC_DEFAULT_JOIN_DELAY1 (5U)
#endif
/**
* @brief Default LoRaMAC join accept delay 2
*/
#ifndef LORAMAC_DEFAULT_JOIN_DELAY2
#define LORAMAC_DEFAULT_JOIN_DELAY2 (6U)
#endif
/**
* @brief Default max FCNT gap
*/
#ifndef LORAMAC_DEFAULT_MAX_FCNT_GAP
#define LORAMAC_DEFAULT_MAX_FCNT_GAP (16384U)
#endif
/**
* @brief Default adaptive datarate ACK limit (in s)
*/
#ifndef LORAMAC_DEFAULT_ADR_ACK_LIMIT
#define LORAMAC_DEFAULT_ADR_ACK_LIMIT (64U)
#endif
/**
* @brief Default adaptive datarate ACK delay (in s)
*/
#ifndef LORAMAC_DEFAULT_ADR_ACK_DELAY
#define LORAMAC_DEFAULT_ADR_ACK_DELAY (32U)
#endif
/**
* @brief Default adaptive datarate timeout
*/
#ifndef LORAMAC_DEFAULT_ADR_TIMEOUT
#define LORAMAC_DEFAULT_ADR_TIMEOUT (3U)
#endif
/** @} */
/**
* @name LoRaMAC constants
* @{
*/
/**
* @brief Device EUI length in bytes
*/
#define LORAMAC_DEVEUI_LEN (8U)
/**
* @brief Device address length in bytes
*/
#define LORAMAC_DEVADDR_LEN (4U)
/**
* @brief Application EUI length in bytes
*/
#define LORAMAC_APPEUI_LEN (8U)
/**
* @brief Application key length in bytes
*/
#define LORAMAC_APPKEY_LEN (16U)
/**
* @brief Application session key length in bytes
*/
#define LORAMAC_APPSKEY_LEN (16U)
/**
* @brief Network session key length in bytes
*/
#define LORAMAC_NWKSKEY_LEN (16U)
/**
* @brief Minimum port value
*/
#define LORAMAC_PORT_MIN (1U)
/**
* @brief Maximmu port value
*/
#define LORAMAC_PORT_MAX (223U)
/** @} */
/**
* @name LoRaMAC parameters indexes
*/
/**
* @brief LoRaMAC network join procedure type
*/
enum {
LORAMAC_JOIN_OTAA, /**< Other-the-air activation */
LORAMAC_JOIN_ABP, /**< Activation by personnalization */
};
/**
* @brief LoRaMAC transmission mode
*/
enum {
LORAMAC_TX_CNF, /**< Confirmable transmission mode */
LORAMAC_TX_UNCNF, /**< Unconfirmable transmission mode */
};
/**
* @brief LoRaMAC datarate indexes
*
* Each index corresponds to a different modulation, spreading factor
* and bandwidth depending on the regions.
*/
enum {
/**
* - 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_0 = 0,
/**
* - 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_1,
/**
* - 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_2,
/**
* - 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_3,
/**
* - 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_4,
/**
* - 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_5,
/**
* - 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_6,
/**
* - 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_7,
/** * - 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_8,
/**
* - 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_9,
/**
* - 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_10,
/**
* - 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_11,
/**
* - 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_12,
/**
* - 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_13,
/**
* - 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_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,
};
/**
* @brief LoRaMAC transmission power indexes
*
* Each index corresponds to a different modulation, spreading factor
* and bandwidth depending on the regions.
*/
enum {
/**
* - 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_0 = 0,
/**
* - 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_1,
/**
* - 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_2,
/**
* - 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_3,
/**
* - 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_4,
/**
* - 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_5,
/**
* - 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_6,
/**
* - 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_7,
/**
* - 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_8,
/**
* - 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_9,
/**
* - 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_10,
/**
* - 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_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,
};
/** @} */
/**
* @brief A LoRaMAC network channel
*/ typedef struct {
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) */
} loramac_channel_t;
#ifdef __cplusplus
}
#endif
#endif /* NET_LORAMAC_H */
/** @} */