Temperature Monitoring
API Reference
Temperature Monitoring Constraints
The Temperature API is used to retrieve 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 -> modemServices.le_temp }
Monitoring
This functionality allows to monitor the temperature by getting the temperature sensor and by setting several temperature thresholds.
- Warning
- Ensure to check the names of supported sensors and thresholds for your specific platform. Please refer to Temperature Monitoring platform constraints page.
- 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.