Temperature Monitoring

API Reference


The Temperature API is used to retrieve Platform and Radio 's temperature values and set warning and critical thresholds.

Warning
When a Critical event occurs, some platform can automatically switch off.

IPC interfaces binding

All the functions of this API are provided by the modemService application service.

Here's a code sample binding to modem services:

bindings:
{
   clientExe.clientComponent.le_temp -> modemService.le_temp
}

Radio Temperature Thresholds

Two Thresholds are set to notify the Radio temperature state: the warning and the critical radio temperature thresholds.

if the Radio temperature reachs the:

  • "Critical Threshold", a LE_TEMP_RADIO_HI_CRITICAL event occurs.
  • "Warning Threshold" but still lower than "Critical Threshold", LE_TEMP_RADIO_HI_WARNING event occurs.

if the Radio temperature decreases below the:

  • "Critical Threshold", a LE_TEMP_RADIO_HI_WARNING event occurs.
  • "Warning Threshold", a LE_TEMP_RADIO_NORMAL event occurs.
Warning
An hysteresis can be dependent of the platform. Be sure to verify your platform's specifications.

Platform Temperature Thresholds

Fours Thresholds are set to decide the state: the low critical, low warning, high warning and the high critical Platform temperatures thresholds

if the Platform temperature reachs the:

  • "high Critical Threshold", a LE_TEMP_PLATFORM_HI_CRITICALL event occurs.
  • "high Warning Threshold" but still lower than "high Critical Threshold", LE_TEMP_PLATFORM_HI_WARNING event occurs

if the Platform temperature decreases below the:

  • "low Warning Threshold" but still higher than "low Critical Threshold", LE_TEMP_PLATFORM_LO_WARNING event occurs.
  • "low Critical Threshold", a LE_TEMP_PLATFORM_LO_CRITICALL event occurs.

if the Platform temperature decreases below the:

  • "hi Critical Threshold", a LE_TEMP_PLATFORM_HI_WARNING event occurs.
  • "hi Warning Threshold", a LE_TEMP_PLATFORM_NORMAL event occurs.

if the Platform temperature reachs the:

  • "low Warning Threshold", a LE_TEMP_PLATFORM_NORMAL event occurs..
  • "low Critical Threshold" but still lower than "high Warning Threshold", a LE_TEMP_PLATFORM_LO_WARNING event occurs..
Warning
An hysteresis can be dependent of the platform. Be sure to verify your platform's specifications.

Monitoring

This functionality allows to monitoring the platform temperature by getting the current Platform or Radio temperature and by setting warning and critical thresholds temperature.

Warning
On some platforms, the thresholds parameters are persistent and a Platform reboot is required for thresholds change takes effect.

When the warning or the critical temperature thresholds are reached an event is sent with the le_temp_ThresholdEvent_t event type .


Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.