3.1.9 PAL_GetTrxAntennaGain Function

C

PAL_Status_t PAL_GetTrxAntennaGain(int8_t *antGain)

Summary

Gets the Antenna gain from the information block of device support library.

Description

This function is used to get the antenna gain either from the information block of device support library or the user specified custom antenna gain.

Precondition

None

Parameters

ParamDescription
antGainPointer holding the module's antenna gain value

Returns

None

Example

int8_t antGain = INT8_MAX;
PAL_GetTrxAntennaGain(&antGain);
printf ("Antenna Gain of the module - %i", antGain);

Remarks

If customer provides the antenna gain of the module, this function returns CUSTOM_ANT_GAIN value or it will read from the information block of device support library if valid.Otherwise, DEFAULT_ANT_GAIN value is returned.