documentation/html/_wi_m_o_d___s_a_p___radio_link___pro_link___i_ds_8h_source.html

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------


/*

 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V1.3

 * FOR FIRMWARE: LoRaWAN PROLINK

 *

 * SEE FILE: ProLink_LoRaWAN_EndNode_Modem_HCI_Spec_v1_3.pdf for detailed information

 */


#ifndef ARDUINO_SAP_WIMOD_SAP_RADIOLINK_PROLINK_IDS_H_

#define ARDUINO_SAP_WIMOD_SAP_RADIOLINK_PROLINK_IDS_H_


#include "utils/WMDefs.h"


#include "WiMOD_SAP_LORAWAN_IDs_EU868.h"  /* Europe       */

//#include "WiMOD_SAP_LORAWAN_IDs_IN865.h"  /* India        */

#include "WiMOD_SAP_LORAWAN_IDs_US915.h"  /* US           */

#include "WIMOD_SAP_LORAWAN_IDs_AU915.h"  /* Australia    */

#include "WiMOD_SAP_LORAWAN_IDs_AS923.h"  /* Asia/Pacific */

//#include "WiMOD_SAP_LORAWAN_IDs_RU868.h"  /* Russia       */


//------------------------------------------------------------------------------

//

// Service Access Point Identifier

//

//------------------------------------------------------------------------------


#define PROLINK_RADIOLINK_SAP_ID                      0x03


// Status Codes

#define PROLINK_RADIOLINK_STATUS_OK                       0x00 //Operation successful

#define PROLINK_RADIOLINK_STATUS_ERROR                    0x01 //Operation failed

#define PROLINK_RADIOLINK_STATUS_CMD_NOT_SUPPORTED        0x02 //Command is not supported

#define PROLINK_RADIOLINK_STATUS_WRONG_PARAMETER          0x03 //HCI message contains wrong parameter

#define PROLINK_RADIOLINK_STATUS_WRONG_RADIO_MODE         0x04 //Stack is running in a wrong mode

#define PROLINK_RADIOLINK_STATUS_BUFFER_FULL              0x07 //Message queue is full, command rejected

#define PROLINK_RADIOLINK_STATUS_LENGTH_ERROR             0x08 //HCI message length is invalid or radio payload size is too large


// Message IDs

#define PROLINK_RADIOLINK_MSG_SEND_U_DATA_REQ            0x01

#define PROLINK_RADIOLINK_MSG_SEND_U_DATA_RSP            0x02


#define PROLINK_RADIOLINK_MSG_U_DATA_RX_IND              0x04

#define PROLINK_RADIOLINK_MSG_U_DATA_TX_IND              0x06


#define PROLINK_RADIOLINK_MSG_SET_RADIO_CFG_REQ          0x17

#define PROLINK_RADIOLINK_MSG_SET_RADIO_CFG_RSP          0x18


#define PROLINK_RADIOLINK_MSG_GET_RADIO_CFG_REQ          0x19

#define PROLINK_RADIOLINK_MSG_GET_RADIO_CFG_RSP          0x1A


#define PROLINK_RADIOLINK_MSG_RESET_RADIO_CFG_REQ        0x1B

#define PROLINK_RADIOLINK_MSG_RESET_RADIO_CFG_RSP        0x1C


#define PROLINK_RADIOLINK_MSG_SET_AES_KEY_REQ            0x21

#define PROLINK_RADIOLINK_MSG_SET_AES_KEY_RSP            0x22


#define PROLINK_RADIOLINK_MSG_GET_AES_KEY_REQ            0x23

#define PROLINK_RADIOLINK_MSG_GET_AES_KEY_RSP            0x24


typedef enum TRadioCfg_RadioModeProLink

{

    ProLinkRadioMode_Standard = 0,

    ProLinkRadioMode_Reserved,

} TRadioCfg_RadioModeProLink;


typedef enum TRadioCfg_ModulationProLink

{

    ProLinkModulation_LoRa = 0,

    ProLinkModulation_FSK,

} TRadioCfg_ModulationProLink;


typedef enum TRadioCfg_LoRaBandwidthProLink

{

    ProLinkLoRaBandwith_125kHz = 0,

    ProLinkLoRaBandwith_250kHz,

    ProLinkLoRaBandwith_500kHz

} TRadioCfg_LoRaBandwidthProLink;


typedef enum TRadioCfg_LoRaSpreadingFactorProLink

{

    ProLinkLoRa0_SF7 = 0,

    ProLinkLoRa1_SF7,

    ProLinkLoRa2_SF7,

    ProLinkLoRa3_SF7,

    ProLinkLoRa4_SF7,

    ProLinkLoRa5_SF7,

    ProLinkLoRa6_SF7,

    ProLinkLoRa7_SF7,

    ProLinkLoRa8_SF8,

    ProLinkLoRa9_SF9,

    ProLinkLoRa10_SF10,

    ProLinkLoRa11_SF11,

    ProLinkLoRa12_SF12,

} TRadioCfg_LoRaSpreadingFactorProLink;


typedef enum TRadioCfg_ErrorCodingProLink

{

    ProLinkErrorCoding0_4_5 = 0,

    ProLinkErrorCoding1_4_5,

    ProLinkErrorCoding2_4_6,

    ProLinkErrorCoding3_4_7,

    ProLinkErrorCoding4_4_8,

} TRadioCfg_ErrorCodingProLink;


typedef enum TRadioCfg_TxPowerLevelProLink

{

    ProLinkTxPowerLevel0_5_dBm = 0,

    ProLinkTxPowerLevel1_5_dBm = 1,

    ProLinkTxPowerLevel2_5_dBm = 2,

    ProLinkTxPowerLevel3_5_dBm = 3,

    ProLinkTxPowerLevel4_5_dBm = 4,

    ProLinkTxPowerLevel5_5_dBm = 5,

    ProLinkTxPowerLevel6_6_dBm,

    ProLinkTxPowerLevel7_7_dBm,

    ProLinkTxPowerLevel8_8_dBm,

    ProLinkTxPowerLevel9_9_dBm,

    ProLinkTxPowerLevel10_10_dBm,

    ProLinkTxPowerLevel11_11_dBm,

    ProLinkTxPowerLevel12_12_dBm,

    ProLinkTxPowerLevel13_13_dBm,

    ProLinkTxPowerLevel14_14_dBm,

    ProLinkTxPowerLevel15_15_dBm,

    ProLinkTxPowerLevel16_16_dBm,

    ProLinkTxPowerLevel17_17_dBm,

    ProLinkTxPowerLevel18_18_dBm,

    ProLinkTxPowerLevel19_19_dBm,

    ProLinkTxPowerLevel20_20_dBm,

} TRadioCfg_TxPowerLevelProLink;


typedef enum TRadioCfg_RxControlProLink

{

    ProLinkRxCtrl_Receiver_Off = 0,

    ProLinkRxCtrl_Receiver_AlwaysOn,

    ProLinkRxCtrl_Receiver_RxWindowed,

} TRadioCfg_RxControlProLink;


// bit field for Misc.Options in RadioConfig structure

#define PROLINK_RADIOLINK_RADIO_CFG_MISC_EXTENDED_HCI_OUTPUT_FORMAT   (1 << 0)

#define PROLINK_RADIOLINK_RADIO_CFG_MISC_HCI_TX_IND_ENABLED           (1 << 2)

#define PROLINK_RADIOLINK_RADIO_CFG_MISC_HCI_ENCTRYPTION_ENABLED      (1 << 5)


typedef enum TRadioCfg_FskDatarateProLink

{

    ProLinkFskDatarate_50kbps = 0,

} TRadioCfg_FskDatarateProLink;


//------------------------------------------------------------------------------


typedef struct TWiMODLR_ProLinkRadioLink_RadioConfig

{

    // only for reading

    UINT8                           Status;

    // only for writing

    UINT8                           StoreNwmFlag;

    TRadioCfg_RadioModeProLink      RadioMode;

    UINT8                           GroupAddress;

    UINT16                          DeviceAddress;

    TRadioCfg_ModulationProLink     Modulation;

    UINT8                           RfFreq_LSB;

    UINT8                           RfFreq_MID;

    UINT8                           RfFreq_MSB;

    TRadioCfg_LoRaBandwidthProLink  LoRaBandWidth;

    TRadioCfg_LoRaSpreadingFactorProLink   LoRaSpreadingFactor;

    TRadioCfg_ErrorCodingProLink    ErrorCoding;

    TRadioCfg_TxPowerLevelProLink   PowerLevel;

    TRadioCfg_RxControlProLink      RxControl;

    UINT16                          RxWindowTime;

    UINT8                           MiscOptions;

    TRadioCfg_FskDatarateProLink    FskDatarate;

} TWiMODLR_ProLinkRadioLink_RadioConfig;


//------------------------------------------------------------------------------

//

// misc. defines

//

//------------------------------------------------------------------------------


#define PROLINK_RADIOLINK_AES_KEY_LEN                         16      // 128 bit


#endif /* ARDUINO_SAP_WIMOD_SAP_RADIOLINK_PROLINK_IDS_H_ */