Version of easy-connect with the u-blox cellular platforms C027 and C030 added.
Functions | |
void | SpiritQiPqiCheck (SpiritFunctionalState xNewState) |
Enables/Disables the PQI Preamble Quality Indicator check. | |
void | SpiritQiSqiCheck (SpiritFunctionalState xNewState) |
Enables/Disables the Synchronization Quality Indicator check. | |
void | SpiritQiSetPqiThreshold (PqiThreshold xPqiThr) |
Sets the PQI threshold. | |
PqiThreshold | SpiritQiGetPqiThreshold (void) |
Returns the PQI threshold. | |
void | SpiritQiSetSqiThreshold (SqiThreshold xSqiThr) |
Sets the SQI threshold. | |
SqiThreshold | SpiritQiGetSqiThreshold (void) |
Returns the SQI threshold. | |
uint8_t | SpiritQiGetPqi (void) |
Returns the PQI value. | |
uint8_t | SpiritQiGetSqi (void) |
Returns the SQI value. | |
uint8_t | SpiritQiGetLqi (void) |
Returns the LQI value. | |
SpiritFlagStatus | SpiritQiGetCs (void) |
Returns the CS status. | |
uint8_t | SpiritQiGetRssi (void) |
Returns the RSSI value. | |
void | SpiritQiSetRssiThreshold (uint8_t cRssiThr) |
Sets the RSSI threshold. | |
uint8_t | SpiritQiGetRssiThreshold (void) |
Returns the RSSI threshold. | |
uint8_t | SpiritQiComputeRssiThreshold (int nDbmValue) |
Computes the RSSI threshold from its dBm value according to the formula: (RSSI[Dbm] + 130)/0.5. | |
void | SpiritQiSetRssiThresholddBm (int nDbmValue) |
Sets the RSSI threshold from its dBm value according to the formula: (RSSI[Dbm] + 130)/0.5. | |
void | SpiritQiSetRssiFilterGain (RssiFilterGain xRssiFg) |
Sets the RSSI filter gain. | |
RssiFilterGain | SpiritQiGetRssiFilterGain (void) |
Returns the RSSI filter gain. | |
void | SpiritQiSetCsMode (CSMode xCsMode) |
Sets the CS Mode. | |
CSMode | SpiritQiGetCsMode (void) |
Returns the CS Mode. | |
void | SpiritQiCsTimeoutMask (SpiritFunctionalState xNewState) |
Enables/Disables the CS Timeout Mask. | |
void | SpiritQiPqiTimeoutMask (SpiritFunctionalState xNewState) |
Enables/Disables the PQI Timeout Mask. | |
void | SpiritQiSqiTimeoutMask (SpiritFunctionalState xNewState) |
Enables/Disables the SQI Timeout Mask. |
Function Documentation
uint8_t SpiritQiComputeRssiThreshold | ( | int | nDbmValue ) |
Computes the RSSI threshold from its dBm value according to the formula: (RSSI[Dbm] + 130)/0.5.
- Parameters:
-
nDbmValue RSSI threshold reported in dBm. This parameter must be a sint16_t.
- Return values:
-
uint8_t RSSI threshold corresponding to dBm value.
Definition at line 405 of file SPIRIT_Qi.c.
void SpiritQiCsTimeoutMask | ( | SpiritFunctionalState | xNewState ) |
Enables/Disables the CS Timeout Mask.
If enabled CS value contributes to timeout disabling.
- Parameters:
-
xNewState new state for CS Timeout Mask. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 531 of file SPIRIT_Qi.c.
SpiritFlagStatus SpiritQiGetCs | ( | void | ) |
Returns the CS status.
- Parameters:
-
None.
- Return values:
-
SpiritFlagStatus CS value (S_SET or S_RESET).
Definition at line 328 of file SPIRIT_Qi.c.
CSMode SpiritQiGetCsMode | ( | void | ) |
Returns the CS Mode.
- Parameters:
-
None.
- Return values:
-
CSMode CS mode.
Definition at line 513 of file SPIRIT_Qi.c.
uint8_t SpiritQiGetLqi | ( | void | ) |
Returns the LQI value.
- Parameters:
-
None.
- Return values:
-
uint8_t LQI value.
Definition at line 310 of file SPIRIT_Qi.c.
uint8_t SpiritQiGetPqi | ( | void | ) |
Returns the PQI value.
- Parameters:
-
None.
- Return values:
-
uint8_t PQI value.
Definition at line 274 of file SPIRIT_Qi.c.
PqiThreshold SpiritQiGetPqiThreshold | ( | void | ) |
Returns the PQI threshold.
The preamble quality threshold is 4*PQI_TH (PQI_TH = 0..15).
- Parameters:
-
None.
- Return values:
-
PqiThreshold PQI threshold (PQI_TH of the formula above).
Definition at line 209 of file SPIRIT_Qi.c.
uint8_t SpiritQiGetRssi | ( | void | ) |
Returns the RSSI value.
The measured power is reported in steps of half a dB from 0 to 255 and is offset in such a way that -120 dBm corresponds to 20.
- Parameters:
-
None.
- Return values:
-
uint8_t RSSI value.
Definition at line 354 of file SPIRIT_Qi.c.
RssiFilterGain SpiritQiGetRssiFilterGain | ( | void | ) |
Returns the RSSI filter gain.
- Parameters:
-
None.
- Return values:
-
RssiFilterGain RSSI filter gain.
Definition at line 465 of file SPIRIT_Qi.c.
uint8_t SpiritQiGetRssiThreshold | ( | void | ) |
Returns the RSSI threshold.
- Parameters:
-
None.
- Return values:
-
uint8_t RSSI threshold.
Definition at line 386 of file SPIRIT_Qi.c.
uint8_t SpiritQiGetSqi | ( | void | ) |
Returns the SQI value.
- Parameters:
-
None.
- Return values:
-
uint8_t SQI value.
Definition at line 292 of file SPIRIT_Qi.c.
SqiThreshold SpiritQiGetSqiThreshold | ( | void | ) |
Returns the SQI threshold.
The synchronization quality threshold is equal to 8 * SYNC_LEN - 2 * SQI_TH with SQI_TH = 0..3.
- Parameters:
-
None.
- Return values:
-
SqiThreshold SQI threshold (SQI_TH of the formula above).
Definition at line 256 of file SPIRIT_Qi.c.
void SpiritQiPqiCheck | ( | SpiritFunctionalState | xNewState ) |
Enables/Disables the PQI Preamble Quality Indicator check.
The running peak PQI is compared to a threshold value and the preamble valid IRQ is asserted as soon as the threshold is passed.
- Parameters:
-
xNewState new state for PQI check. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 119 of file SPIRIT_Qi.c.
void SpiritQiPqiTimeoutMask | ( | SpiritFunctionalState | xNewState ) |
Enables/Disables the PQI Timeout Mask.
If enabled PQI value contributes to timeout disabling.
- Parameters:
-
xNewState new state for PQI Timeout Mask. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 563 of file SPIRIT_Qi.c.
void SpiritQiSetCsMode | ( | CSMode | xCsMode ) |
Sets the CS Mode.
When static carrier sensing is used (cs_mode = 0), the carrier sense signal is asserted when the measured RSSI is above the value specified in the RSSI_TH register and is deasserted when the RSSI falls 3 dB below the same threshold. When dynamic carrier sense is used (cs_mode = 1, 2, 3), the carrier sense signal is asserted if the signal is above the threshold and a fast power increase of 6, 12 or 18 dB is detected; it is deasserted if a power fall of the same amplitude is detected.
- Parameters:
-
xCsMode CS mode selector. This parameter can be any value of CSMode.
- Return values:
-
None.
Definition at line 488 of file SPIRIT_Qi.c.
void SpiritQiSetPqiThreshold | ( | PqiThreshold | xPqiThr ) |
Sets the PQI threshold.
The preamble quality threshold is 4*PQI_TH (PQI_TH = 0..15).
- Parameters:
-
xPqiThr parameter of the formula above. This variable is a PqiThreshold.
- Return values:
-
None.
Definition at line 184 of file SPIRIT_Qi.c.
void SpiritQiSetRssiFilterGain | ( | RssiFilterGain | xRssiFg ) |
Sets the RSSI filter gain.
This parameter sets the bandwidth of a low pass IIR filter (RSSI_FLT register, allowed values 0..15), a lower values gives a faster settling of the measurements but lower precision. The recommended value for such parameter is 14.
- Parameters:
-
xRssiFg RSSI filter gain value. This parameter can be any value of RssiFilterGain.
- Return values:
-
None.
Definition at line 440 of file SPIRIT_Qi.c.
void SpiritQiSetRssiThreshold | ( | uint8_t | cRssiThr ) |
Sets the RSSI threshold.
- Parameters:
-
cRssiThr RSSI threshold reported in steps of half a dBm with a -130 dBm offset. This parameter must be a uint8_t.
- Return values:
-
None.
Definition at line 373 of file SPIRIT_Qi.c.
void SpiritQiSetRssiThresholddBm | ( | int | nDbmValue ) |
Sets the RSSI threshold from its dBm value according to the formula: (RSSI[Dbm] + 130)/0.5.
- Parameters:
-
nDbmValue RSSI threshold reported in dBm. This parameter must be a sint16_t.
- Return values:
-
None.
Definition at line 421 of file SPIRIT_Qi.c.
void SpiritQiSetSqiThreshold | ( | SqiThreshold | xSqiThr ) |
Sets the SQI threshold.
The synchronization quality threshold is equal to 8 * SYNC_LEN - 2 * SQI_TH with SQI_TH = 0..3. When SQI_TH is 0 perfect match is required; when SQI_TH = 1, 2, 3 then 1, 2, or 3 bit errors are respectively accepted. It is recommended that the SQI check is always enabled.
- Parameters:
-
xSqiThr parameter of the formula above. This parameter is a SqiThreshold.
- Return values:
-
None.
Definition at line 231 of file SPIRIT_Qi.c.
void SpiritQiSqiCheck | ( | SpiritFunctionalState | xNewState ) |
Enables/Disables the Synchronization Quality Indicator check.
The running peak SQI is compared to a threshold value and the sync valid IRQ is asserted as soon as the threshold is passed.
- Parameters:
-
xNewState new state for SQI check. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 152 of file SPIRIT_Qi.c.
void SpiritQiSqiTimeoutMask | ( | SpiritFunctionalState | xNewState ) |
Enables/Disables the SQI Timeout Mask.
If enabled SQI value contributes to timeout disabling.
- Parameters:
-
xNewState new state for SQI Timeout Mask. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 595 of file SPIRIT_Qi.c.
Generated on Tue Jul 12 2022 15:14:32 by 1.7.2