documentation/html/_wi_m_o_d___s_a_p___d_e_v_m_g_m_t___p_l_u_s___i_ds_8h_source.html

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

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


/*

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

 * FOR FIRMWARE: LR-BASE PLUS

 *

 * SEE FILE: WiMOD_LR_Base_Plus_HCI_Spec_V1_2.pdf for detailed information

 */


#ifndef ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PLUS_IDS_H_

#define ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PLUS_IDS_H_


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

//

// Section Includes Files

//

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


#include "WiMOD_SAP_DEVMGMT_IDs.h"


// bit field for Misc.Options in RadioConfig structure (additonal for LR-Base_PLUS)

#define DEVMGMT_RADIO_CFG_MISC_REMOTE_CTRL_ENABLED          (1 << 6)


// bit field for WRONG_PARAMETER bit mask of the DEVMGMT_SET_RADIO_CONFIG_RSP messasge


// byte 0

#define RADIO_CFG_BYTE0_WRONG_MODULATION          (1 << 0)

#define RADIO_CFG_BYTE0_WRONG_FREQ                (1 << 1)

#define RADIO_CFG_BYTE0_WRONG_BANDWIDTH           (1 << 2)

#define RADIO_CFG_BYTE0_WRONG_SF                  (1 << 3)

#define RADIO_CFG_BYTE0_WRONG_ERROR_CODE          (1 << 4)

#define RADIO_CFG_BYTE0_WRONG_POWER_LEVEL         (1 << 5)


// byte1

// -> reserved


// byte2

#define RADIO_CFG_BYTE2_WRONG_RADIO_MODE          (1 << 0)

#define RADIO_CFG_BYTE2_WRONG_RX_OPTIONS          (1 << 1)

#define RADIO_CFG_BYTE2_WRONG_LBT_THRESHOLD       (1 << 2)

#define RADIO_CFG_BYTE2_WRONG_GRP_ADR             (1 << 3)

#define RADIO_CFG_BYTE2_WRONG_DEV_ADR             (1 << 4)

#define RADIO_CFG_BYTE2_WRONG_PWR_SAVE_MODE       (1 << 5)


// byte3

// -> reserved


typedef enum TRadioCfg_RadioModePlus

{

        LRBASE_PLUS_RadioMode_Standard = 0,

        LRBASE_PLUS_RadioMode_Reserved,

        LRBASE_PLUS_RadioMode_Sniffer,

} TRadioCfg_RadioModePlus;


typedef enum TRadioCfg_ModulationPlus

{

    LRBASE_PLUS_Modulation_LoRa = 0,

    LRBASE_PLUS_Modulation_FLRC,

    LRBASE_PLUS_Modulation_FSK,

    LRBASE_PLUS_Modulation_Fail,  // dummy

} TRadioCfg_ModulationPlus;


typedef enum TRadioCfg_LoRaBandwidthPlus

{

        LRBASE_PLUS_LoRaBandwith_200kHz  = 2,

        LRBASE_PLUS_LoRaBandwith_400kHz  = 3,

        LRBASE_PLUS_LoRaBandwith_800kHz  = 4,

        LRBASE_PLUS_LoRaBandwith_1600kHz = 5,

        LRBASE_PLUS_LoRaBandwith_fail,                                              // dummy


} TRadioCfg_LoRaBandwidthPlus;


typedef enum TRadioCfg_FLRCBandwidthPlus

{

        LRBASE_PLUS_FLRCBandwith_0_260MBs_0_3_MHz_DSB  = 1,

        LRBASE_PLUS_FLRCBandwith_0_325MBs_0_3_MHz_DSB  = 2,

        LRBASE_PLUS_FLRCBandwith_0_520MBs_0_6_MHz_DSB  = 3,

        LRBASE_PLUS_FLRCBandwith_0_650MBs_0_6_MHz_DSB  = 4,

        LRBASE_PLUS_FLRCBandwith_1_040MBs_1_2_MHz_DSB  = 5,

        LRBASE_PLUS_FLRCBandwith_1_300MBs_1_2_MHz_DSB  = 6,

        LRBASE_PLUS_FLRCBandwith_fail,                                              // dummy

} TRadioCfg_FLRCBandwidthPlus;


typedef enum TRadioCfg_FSKBandwidthPlus

{

    LRBASE_PLUS_FSKBandwith_2_0MBs_2_4_MHz   = 0,

    LRBASE_PLUS_FSKBandwith_1_0MBs_1_2_MHz   = 3,

    LRBASE_PLUS_FSKBandwith_0_250MBs_0_3_MHz = 11,

    LRBASE_PLUS_FSKBandwith_0_125MBs_0_3_MHz = 12,

    LRBASE_PLUS_FSKBandwith_fail,                                               // dummy

} TRadioCfg_FSKBandwidthPlus;


typedef enum TRadioCfg_LoRaSpreadingFactorPlus

{

        LRBASE_PLUS_LoRa_SF5  = 5,

        LRBASE_PLUS_LoRa_SF6  = 6,

        LRBASE_PLUS_LoRa_SF7  = 7,

        LRBASE_PLUS_LoRa_SF8  = 8,

        LRBASE_PLUS_LoRa_SF9  = 9,

        LRBASE_PLUS_LoRa_SF10 = 10,

        LRBASE_PLUS_LoRa_SF11 = 11,

        LRBASE_PLUS_LoRa_SF12 = 12,

        LRBASE_PLUS_LoRa_SF_fail,                                                   // dummy

} TRadioCfg_LoRaSpreadingFactorPlus;


typedef enum TRadioCfg_LoRaErrorCodingPlus

{

        LRBASE_PLUS_LoRa_ErrorCoding_4_5 = 1,

        LRBASE_PLUS_LoRa_ErrorCoding_4_6 = 2,

        LRBASE_PLUS_LoRa_ErrorCoding_4_7 = 3,

        LRBASE_PLUS_LoRa_ErrorCoding_4_8 = 4,

        // new in V 1.2

    LRBASE_PLUS_LoRa_ErrorCoding_LI_4_5 = 5,

    LRBASE_PLUS_LoRa_ErrorCoding_LI_4_6 = 6,

    LRBASE_PLUS_LoRa_ErrorCoding_LI_4_8 = 7,

    LRBASE_PLUS_LoRa_ErrorCoding_fail,                                          // dummy


} TRadioCfg_LoRaErrorCodingPlus;


typedef enum TRadioCfg_FLRCErrorCodingPlus

{

        LRBASE_PLUS_FLRC_ErrorCoding_1_2 = 1,

        LRBASE_PLUS_FLRC_ErrorCoding_3_4 = 2,

        LRBASE_PLUS_FLRC_ErrorCoding_1_1 = 3,

        LRBASE_PLUS_FLRC_ErrorCoding_fail,                                          // dummy

} TRadioCfg_FLRCErrorCodingPlus;


typedef enum TRadioCfg_TxPowerLevelPlus

{

        LRBASE_PLUS_TxPowerLevel_m18_dBm = -18,

        LRBASE_PLUS_TxPowerLevel_m17_dBm,

        LRBASE_PLUS_TxPowerLevel_m16_dBm,

        LRBASE_PLUS_TxPowerLevel_m15_dBm,

        LRBASE_PLUS_TxPowerLevel_m14_dBm,

        LRBASE_PLUS_TxPowerLevel_m13_dBm,

        LRBASE_PLUS_TxPowerLevel_m12_dBm,

        LRBASE_PLUS_TxPowerLevel_m11_dBm,

        LRBASE_PLUS_TxPowerLevel_m10_dBm,

        LRBASE_PLUS_TxPowerLevel_m09_dBm,

        LRBASE_PLUS_TxPowerLevel_m08_dBm,

        LRBASE_PLUS_TxPowerLevel_m07_dBm,

        LRBASE_PLUS_TxPowerLevel_m06_dBm,

        LRBASE_PLUS_TxPowerLevel_m05_dBm,

        LRBASE_PLUS_TxPowerLevel_m04_dBm,

        LRBASE_PLUS_TxPowerLevel_m03_dBm,

        LRBASE_PLUS_TxPowerLevel_m02_dBm,

        LRBASE_PLUS_TxPowerLevel_m01_dBm,

        LRBASE_PLUS_TxPowerLevel_m00_dBm,

        LRBASE_PLUS_TxPowerLevel_p01_dBm,

        LRBASE_PLUS_TxPowerLevel_p02_dBm,

        LRBASE_PLUS_TxPowerLevel_p03_dBm,

        LRBASE_PLUS_TxPowerLevel_p04_dBm,

        LRBASE_PLUS_TxPowerLevel_p05_dBm,

        LRBASE_PLUS_TxPowerLevel_p06_dBm,

        LRBASE_PLUS_TxPowerLevel_p07_dBm,

        LRBASE_PLUS_TxPowerLevel_p08_dBm,

        LRBASE_PLUS_TxPowerLevel_p09_dBm,

        LRBASE_PLUS_TxPowerLevel_p10_dBm,

        LRBASE_PLUS_TxPowerLevel_p11_dBm,

        LRBASE_PLUS_TxPowerLevel_p12_dBm,

        LRBASE_PLUS_TxPowerLevel_p13_dBm,

        LRBASE_PLUS_TxPowerLevel_fail,                                              // dummy


} TRadioCfg_PowerLevelPlus;


typedef enum TRadioCfg_RxControlPlus

{

        LRBASE_PLUS_RxCtrl_Receiver_Off = 0,

        LRBASE_PLUS_RxCtrl_Receiver_AlwaysOn,

        LRBASE_PLUS_RxCtrl_Receiver_RxWindowed,

} TRadioCfg_RxControlPlus;


typedef enum TRadioCfg_TxControlPlus

{

    LRBASE_PLUS_TxCtrl_LBT_Off = 0,

    LRBASE_PLUS_TxCtrl_LBT_On = 1,

} TRadioCfg_TxControlPlus;


typedef enum TRadioCfg_PowerSavingModePlus

{

        LRBASE_PLUS_PowerSaving_Off = 0,

        LRBASE_PLUS_PowerSaving_On  = 1,

} TRadioCfg_PowerSavingModePlus;


typedef struct TWiMODLR_DevMgmt_RadioConfigPlus

{

    // only for reading

    UINT8                           Status;

    // only for writing

    UINT8                           StoreNwmFlag;

    TRadioCfg_RadioModePlus         RadioMode;

    UINT8                           GroupAddress;

    UINT8                           TxGroupAddress;

    UINT16                          DeviceAddress;

    UINT16                          TxDeviceAddress;

    TRadioCfg_ModulationPlus        Modulation;

    UINT8                           RfFreq_LSB;

    UINT8                           RfFreq_MID;

    UINT8                           RfFreq_MSB;

    TRadioCfg_LoRaBandwidthPlus     LoRaBandWidth;

    TRadioCfg_FLRCBandwidthPlus         FLRCBandWidth;

    TRadioCfg_FSKBandwidthPlus      FSKBandWidth;

    TRadioCfg_LoRaSpreadingFactorPlus   LoRaSpreadingFactor;

    TRadioCfg_LoRaErrorCodingPlus   LoRaErrorCoding;

    TRadioCfg_FLRCErrorCodingPlus   FLRCErrorCoding;

    TRadioCfg_PowerLevelPlus        PowerLevel;

    TRadioCfg_TxControlPlus         TxControl;

    TRadioCfg_RxControlPlus         RxControl;

    UINT16                          RxWindowTime;

    UINT8                           LedControl;

    UINT8                           MiscOptions;

    TRadioCfg_PowerSavingModePlus   PowerSavingMode;

    INT16                           LbtThreshold;

} TWiMODLR_DevMgmt_RadioConfigPlus;


typedef struct TWiMODLR_DevMgmt_SystemStatusPlus

{

    UINT8       Status;

    UINT8       SysTickResolution;

    UINT32      SysTickCounter;

    UINT32      RtcTime;

    UINT16      NvmStatus;

    UINT16      BatteryStatus;

    UINT16      ExtraStatus;

    UINT32              RxPackets;

        UINT32          RxAddressMatch;

        UINT32          RxCRCError;

        UINT32          TxPackets;

        UINT32          TxError;

    UINT32      TxMediaBusyEvents;

} TWiMODLR_DevMgmt_SystemStatusPlus;


#endif /* ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PLUS_IDS_H_ */