Temperature Monitoring
API Reference
Sierra Wireless platforms Sierra Wireless Platforms Constraints
The temperature monitoring API allows an application to monitor the temperature by receiving temperature values from sensors and sets warnings and critical temperature thresholds.
- Warning
- When a Critical event occurs, some platform can automatically switch off.
- Some of the functions in this API may not be supported by your target. Please refer to Temperature Monitoring Constraints page for full details.
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 -> modemServices.le_temp
}
Monitoring
- Warning
- Ensure to check the names of supported sensors and thresholds for your specific platform. Please refer to Temperature Monitoring Constraints page for full details.
- An hysteresis can be dependent of the platform. Be sure to verify your platform's specifications.
- On some platforms, the thresholds parameters are persistent and a Platform reboot is required for thresholds change takes effect.
When temperature thresholds are reached, an event is sent with a string type that specifies the raised threshold.
- le_temp_Request() function allows the application to monitor a requested temperature sensor.
- le_temp_GetSensorName() function allows the application to retrieve the temperature sensor's name from its reference.
- le_temp_GetTemperature() function allows the application to retrieve the temperature of a sensor.
- le_temp_GetThreshold() function allows the application to get the configured threshold for a sensor.
- le_temp_SetThreshold() function allows the application to configure a threshold for a sensor.
- le_temp_StartMonitoring() function allows to start the temperature monitoring with the thresholds configured by le_temp_SetThreshold() function.
- le_temp_AddThresholdEventHandler() API adds a handler to notify when a temperature threshold is reached.
- le_temp_RemoveThresholdEventHandler() API removes the temperature handler.
Copyright (C) Sierra Wireless Inc.