loramac.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef NET_LORAMAC_H
#define NET_LORAMAC_H
 
#include <stdint.h>
#include <stdlib.h>
 
#include "kernel_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef LORAMAC_DEV_EUI_DEFAULT
#define LORAMAC_DEV_EUI_DEFAULT        { 0x00, 0x00, 0x00, 0x00, \
                                         0x00, 0x00, 0x00, 0x00 }
#endif
 
#ifndef LORAMAC_APP_EUI_DEFAULT
#define LORAMAC_APP_EUI_DEFAULT        { 0x00, 0x00, 0x00, 0x00, \
                                         0x00, 0x00, 0x00, 0x00 }
#endif
 
#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
 
#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
 
#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
 
#ifndef LORAMAC_DEV_ADDR_DEFAULT
#define LORAMAC_DEV_ADDR_DEFAULT       { 0x00, 0x00, 0x00, 0x00 }
#endif
 
#if !IS_ACTIVE(CONFIG_LORAMAC_REGION_EU_868) \
    && !IS_ACTIVE(CONFIG_LORAMAC_REGION_IN_865)
#define CONFIG_LORAMAC_REGION_EU_868           1
#endif
 
#ifndef LORAMAC_DEFAULT_DEVICE_CLASS
#define LORAMAC_DEFAULT_DEVICE_CLASS           (LORAMAC_CLASS_A)
#endif
 
#ifndef LORAMAC_DEFAULT_NETID
#define LORAMAC_DEFAULT_NETID                  (1U)
#endif
 
#ifndef LORAMAC_DEFAULT_PUBLIC_NETWORK
#define LORAMAC_DEFAULT_PUBLIC_NETWORK         (true)
#endif
 
#ifndef LORAMAC_DEFAULT_DR
#define LORAMAC_DEFAULT_DR                     (LORAMAC_DR_0)
#endif
 
#ifndef LORAMAC_DEFAULT_TX_POWER
#define LORAMAC_DEFAULT_TX_POWER               (LORAMAC_TX_PWR_1)
#endif
 
#ifndef LORAMAC_DEFAULT_TX_PORT
#define LORAMAC_DEFAULT_TX_PORT                (2U)
#endif
 
 #ifndef LORAMAC_DEFAULT_TX_MODE
 #define LORAMAC_DEFAULT_TX_MODE               (LORAMAC_TX_CNF)
 #endif
 
#ifndef LORAMAC_DEFAULT_TX_POWER
#define LORAMAC_DEFAULT_TX_POWER               (LORAMAC_TX_PWR_1)
#endif
 
#ifndef LORAMAC_DEFAULT_ADR
#define LORAMAC_DEFAULT_ADR                    (false)
#endif
 
#ifndef LORAMAC_DEFAULT_RETX
#define LORAMAC_DEFAULT_RETX                   (5U)
#endif
 
#ifndef LORAMAC_DEFAULT_LINKCHK
#define LORAMAC_DEFAULT_LINKCHK                (0U)
#endif
 
#ifndef LORAMAC_DEFAULT_RX1_DELAY
#define LORAMAC_DEFAULT_RX1_DELAY              (1000U)
#endif
 
#define LORAMAC_DEFAULT_RX2_DELAY              (1000U + LORAMAC_DEFAULT_RX1_DELAY)
 
#ifndef LORAMAC_DEFAULT_AR
#define LORAMAC_DEFAULT_AR                     (false)
#endif
 
#ifndef LORAMAC_DEFAULT_RX2_DR
#if IS_ACTIVE(CONFIG_LORAMAC_REGION_EU_868)
#define LORAMAC_DEFAULT_RX2_DR                 (LORAMAC_DR_0)
#elif IS_ACTIVE(CONFIG_LORAMAC_REGION_IN_865)
#define LORAMAC_DEFAULT_RX2_DR                 (LORAMAC_DR_2)
#endif
#endif
 
#ifndef LORAMAC_DEFAULT_RX2_FREQ
#if IS_ACTIVE(CONFIG_LORAMAC_REGION_EU_868)
#define LORAMAC_DEFAULT_RX2_FREQ               (869525000UL)
#elif IS_ACTIVE(CONFIG_LORAMAC_REGION_IN_865)
#define LORAMAC_DEFAULT_RX2_FREQ               (866550000UL)
#endif
#endif
 
#ifndef LORAMAC_DEFAULT_JOIN_PROCEDURE
#define LORAMAC_DEFAULT_JOIN_PROCEDURE         (LORAMAC_JOIN_OTAA)
#endif
 
#ifndef LORAMAC_DEFAULT_JOIN_DELAY1
#define LORAMAC_DEFAULT_JOIN_DELAY1            (5U)
#endif
 
#ifndef LORAMAC_DEFAULT_JOIN_DELAY2
#define LORAMAC_DEFAULT_JOIN_DELAY2            (6U)
#endif
 
#ifndef LORAMAC_DEFAULT_MAX_FCNT_GAP
#define LORAMAC_DEFAULT_MAX_FCNT_GAP           (16384U)
#endif
 
#ifndef LORAMAC_DEFAULT_ADR_ACK_LIMIT
#define LORAMAC_DEFAULT_ADR_ACK_LIMIT          (64U)
#endif
 
#ifndef LORAMAC_DEFAULT_ADR_ACK_DELAY
#define LORAMAC_DEFAULT_ADR_ACK_DELAY          (32U)
#endif
 
#ifndef LORAMAC_DEFAULT_ADR_TIMEOUT
#define LORAMAC_DEFAULT_ADR_TIMEOUT            (3U)
#endif
 
#ifndef LORAMAC_DEFAULT_SYSTEM_MAX_RX_ERROR
#define LORAMAC_DEFAULT_SYSTEM_MAX_RX_ERROR    (50)
#endif
 
#ifndef LORAMAC_DEFAULT_MIN_RX_SYMBOLS
#define LORAMAC_DEFAULT_MIN_RX_SYMBOLS         (12)
#endif
 
#define LORAMAC_DEVEUI_LEN             (8U)
 
#define LORAMAC_DEVADDR_LEN            (4U)
 
#define LORAMAC_APPEUI_LEN             (8U)
 
#define LORAMAC_APPKEY_LEN             (16U)
 
#define LORAMAC_APPSKEY_LEN            (16U)
 
#define LORAMAC_NWKSKEY_LEN            (16U)
 
#define LORAMAC_PORT_MIN               (1U)
 
#define LORAMAC_PORT_MAX               (223U)
 
#define LORAMAC_APP_NONCE_LEN          (3U)
 
#define LORAMAC_NETWORK_ID_LEN         (3U)
 
typedef enum {
    LORAMAC_CLASS_A,                   
    LORAMAC_CLASS_B,                   
    LORAMAC_CLASS_C,                   
} loramac_class_t;
 
typedef enum {
    LORAMAC_JOIN_OTAA,                 
    LORAMAC_JOIN_ABP,                  
} loramac_join_mode_t;
 
typedef enum {
    LORAMAC_TX_CNF,                    
    LORAMAC_TX_UNCNF,                  
} loramac_tx_mode_t;
 
typedef enum {
    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_dr_idx_t;
 
typedef enum {
    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_tx_pwr_idx_t;
 typedef struct {
    uint32_t freq;                     
    uint8_t index;                     
    uint8_t bw;                        
    uint8_t dr_min;                    
    uint8_t dr_max;                    
    uint8_t dcycle;                    
} loramac_channel_t;
 
#ifdef __cplusplus
}
#endif
 
#endif /* NET_LORAMAC_H */