Thermal Protection#

Modules#

RAIL_ChipTempConfig_t

RAIL_ChipTempMetrics_t

Functions#

RAIL_Status_t
RAIL_ConfigThermalProtection(RAIL_Handle_t genericRailHandle, const RAIL_ChipTempConfig_t *chipTempConfig)

Enable or disable the thermal protection if RAIL_SUPPORTS_THERMAL_PROTECTION is defined and update the temperature threshold and cool down hysteresis preventing or allowing transmissions.

RAIL_Status_t
RAIL_GetThermalProtection(RAIL_Handle_t genericRailHandle, RAIL_ChipTempConfig_t *chipTempConfig)

Get the current thermal configuration parameter and status.

Macros#

#define
RAIL_CHIP_TEMP_THRESHOLD_MAX (398U)

Maximum junction temperature in Kelvin.

#define
RAIL_CHIP_TEMP_COOLDOWN_DEFAULT (7U)

Default number of Kelvin degrees below threshold needed to allow transmissions.

#define
RAIL_CHIP_TEMP_MEASURE_COUNT (3U)

Number of temperature values provided for the chip thermal protection.

Function Documentation#

RAIL_ConfigThermalProtection#

RAIL_Status_t RAIL_ConfigThermalProtection (RAIL_Handle_t genericRailHandle, const RAIL_ChipTempConfig_t * chipTempConfig)

Enable or disable the thermal protection if RAIL_SUPPORTS_THERMAL_PROTECTION is defined and update the temperature threshold and cool down hysteresis preventing or allowing transmissions.

Parameters
[in]genericRailHandle

A generic RAIL instance handle.

[in]chipTempConfig

A pointer to the struct RAIL_ChipTempConfig_t that contains the configuration to be applied.

When the temperature threshold minus a precise number of degrees specified by the cool down hysteresis parameter is exceeded, any future transmits are blocked until the temperature decreases below that limit. Besides, if the temperature threshold is exceeded, any active transmit is aborted.

By default the threshold is set to RAIL_CHIP_TEMP_THRESHOLD_MAX and the cool down hysteresis is set to RAIL_CHIP_TEMP_COOLDOWN_DEFAULT.

Returns

  • Status code indicating the result of the function call. Returns RAIL_STATUS_INVALID_PARAMETER if enable field from RAIL_ChipTempConfig_t is set to false when an EFF is present on the board.

Note

  • The thermal protection is automatically enabled when an EFF is present on the board. There is no use in calling this API in this case.


Definition at line 6441 of file common/rail.h

RAIL_GetThermalProtection#

RAIL_Status_t RAIL_GetThermalProtection (RAIL_Handle_t genericRailHandle, RAIL_ChipTempConfig_t * chipTempConfig)

Get the current thermal configuration parameter and status.

Parameters
[in]genericRailHandle

A generic RAIL instance handle.

[inout]chipTempConfig

A pointer to the struct RAIL_ChipTempConfig_t that will contain the current configuration.

Returns

  • Status code indicating the result of the function call.


Definition at line 6452 of file common/rail.h