Appiko
Data Structures | Enumerations | Functions
S2LP_Qi.h File Reference

Configuration and management of S2LP QI. More...

#include "S2LP_Regs.h"
#include "S2LP_Types.h"

Go to the source code of this file.

Data Structures

struct  SRssiInit
 S2LP RSSI Init structure definition. More...
 

Enumerations

enum  SRssiMode
 S2LP RSSI mode enumeration.
 

Functions

int32_t S2LPRadioGetRssidBm (void)
 Returns the RSSI value. More...
 
int32_t S2LPRadioGetRssidBmRun (void)
 Returns the RSSI value from a current RX mode. More...
 
void S2LPRadioSetRssiThreshdBm (int32_t wRssiThrehsold)
 Set the RSSI threshold in dBm. More...
 
void S2LPRadioCsBlanking (SFunctionalState xCsBlank)
 Enable or disables the CS blanking. More...
 
void S2LPRadioRssiInit (SRssiInit *xSRssiInit)
 Initialize the RSSI measurement. More...
 
void S2LPRadioGetRssiInfo (SRssiInit *xSRssiInit)
 Return the RSSI measurements information to be filled with the information. More...
 
void S2LPRadioAntennaSwitching (SFunctionalState xAntennaSwitch)
 Enable or Disable the antenna switching. More...
 
void S2LPRadioSetPqiCheck (uint8_t cPqiLevel)
 Set the PQI check. More...
 
SFlagStatus S2LPQiGetCs (void)
 Return the CS (carrier sense) indication. More...
 

Detailed Description

Author
LowPower RF BU - AMG
Version
1.2.1
Date
16-April-2018

This module can be used to configure and read some quality indicators used by S2-LP. API to set thresholds and to read values in raw mode or in dBm are provided.

Example:

int32_t rssiValuedBm;
uint8_t pqiValue, sqiValue;
S2LPQiPqiCheck(S_ENABLE);
S2LPQiSqiCheck(S_ENABLE);
...
rssiValueDbm = S2LPQiGetRssidBm();
pqiValue = S2LPQiGetPqi();
sqiValue = S2LPQiGetSqi();
...

THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.

THIS SOURCE CODE IS PROTECTED BY A LICENSE. FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE.

© COPYRIGHT 2016 STMicroelectronics

Definition in file S2LP_Qi.h.