le_temp_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Typedefs
typedef struct le_temp_ThresholdEventHandler *	le_temp_ThresholdEventHandlerRef_t
typedef void(*	le_temp_ThresholdEventHandlerFunc_t) (le_temp_ThresholdStatus_t event, void *contextPtr)

Enumerations
enum	le_temp_ThresholdStatus_t {   LE_TEMP_PLATFORM_HI_CRITICAL, LE_TEMP_RADIO_HI_CRITICAL, LE_TEMP_PLATFORM_HI_WARNING, LE_TEMP_RADIO_HI_WARNING,   LE_TEMP_PLATFORM_NORMAL, LE_TEMP_RADIO_NORMAL, LE_TEMP_PLATFORM_LOW_WARNING, LE_TEMP_PLATFORM_LOW_CRITICAL }

Functions
void	le_temp_ConnectService (void)
void	le_temp_DisconnectService (void)
le_temp_ThresholdEventHandlerRef_t	le_temp_AddThresholdEventHandler (le_temp_ThresholdEventHandlerFunc_t handlerPtr, void *contextPtr)
void	le_temp_RemoveThresholdEventHandler (le_temp_ThresholdEventHandlerRef_t addHandlerRef)
le_result_t	le_temp_GetPlatformTemperature (int32_t *platformTempPtr)
le_result_t	le_temp_GetRadioTemperature (int32_t *radioTempPtr)
le_result_t	le_temp_SetPlatformThresholds (int32_t lowCriticalTemp, int32_t lowWarningTemp, int32_t hiWarningTemp, int32_t hiCriticalTemp)
le_result_t	le_temp_GetPlatformThresholds (int32_t *lowCriticalTempPtr, int32_t *lowWarningTempPtr, int32_t *hiWarningTempPtr, int32_t *hiCriticalTempPtr)
le_result_t	le_temp_SetRadioThresholds (int32_t hiWarningTemp, int32_t hiCriticalTemp)
le_result_t	le_temp_GetRadioThresholds (int32_t *hiWarningTempPtr, int32_t *hiCriticalTempPtr)

Detailed Description

Legato Temperature Monitoring include file.

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

Typedef Documentation

typedef void(* le_temp_ThresholdEventHandlerFunc_t) (le_temp_ThresholdStatus_t event, void *contextPtr)

Handler for Temperature event.

Parameters

event	Temperature threshold event reached.
contextPtr

typedef struct le_temp_ThresholdEventHandler* le_temp_ThresholdEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'le_temp_ThresholdEvent'

Enumeration Type Documentation

enum le_temp_ThresholdStatus_t

Temperature event type.

Enumerator
LE_TEMP_PLATFORM_HI_CRITICAL	High Platform Critical temperature threshold is reached.
LE_TEMP_RADIO_HI_CRITICAL	High Radio Critical temperature threshold is reached.
LE_TEMP_PLATFORM_HI_WARNING	High Platform Warning temperature threshold is reached.
LE_TEMP_RADIO_HI_WARNING	High Radio Warning temperature threshold is reached.
LE_TEMP_PLATFORM_NORMAL	Normal Platform temperature threshold is reached.
LE_TEMP_RADIO_NORMAL	Normal Radio temperature threshold is reached.
LE_TEMP_PLATFORM_LOW_WARNING	Low Platform Warning temperature threshold is reached.
LE_TEMP_PLATFORM_LOW_CRITICAL	Low Platform Critical temperature threshold is reached.

Function Documentation

le_temp_ThresholdEventHandlerRef_t le_temp_AddThresholdEventHandler	(	le_temp_ThresholdEventHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'le_temp_ThresholdEvent'

This event provides information on Threshold reached.

Parameters

[in]	handlerPtr
[in]	contextPtr

void le_temp_ConnectService

(

void

)

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

void le_temp_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

le_result_t le_temp_GetPlatformTemperature

(

int32_t *

platformTempPtr

)

Get the Platform temperature level in degree celsius.

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed to get the temperature.

Parameters

[out]

platformTempPtr

[OUT] The Platform temperature level in degree celsius.

le_result_t le_temp_GetPlatformThresholds	(	int32_t *	lowCriticalTempPtr,
		int32_t *	lowWarningTempPtr,
		int32_t *	hiWarningTempPtr,
		int32_t *	hiCriticalTempPtr
	)

Get the Platform warning and critical temperature thresholds in degree celsius.

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed to get the thresholds.

Parameters

[out]	lowCriticalTempPtr	[OUT] The low critical temperature threshold in degree celsius.
[out]	lowWarningTempPtr	[OUT] The low warning temperature threshold in degree celsius.
[out]	hiWarningTempPtr	[OUT] The high warning temperature threshold in degree celsius.
[out]	hiCriticalTempPtr	[OUT] The high critical temperature threshold in degree celsius.

le_result_t le_temp_GetRadioTemperature

(

int32_t *

radioTempPtr

)

Get the Radio temperature level in degree celsius.

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed to get the temperature.

Parameters

[out]

radioTempPtr

[OUT] The Radio temperature level in degree celsius.

le_result_t le_temp_GetRadioThresholds	(	int32_t *	hiWarningTempPtr,
		int32_t *	hiCriticalTempPtr
	)

Get the Radio warning and critical temperature thresholds in degree celsius.

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed to get the thresholds.

Parameters

[out]	hiWarningTempPtr	[OUT] The high warning temperature threshold in degree celsius.
[out]	hiCriticalTempPtr	[OUT] The high critical temperature threshold in degree celsius.

void le_temp_RemoveThresholdEventHandler

(

le_temp_ThresholdEventHandlerRef_t

addHandlerRef

)

Remove handler function for EVENT 'le_temp_ThresholdEvent'

Parameters

[in]

addHandlerRef

le_result_t le_temp_SetPlatformThresholds	(	int32_t	lowCriticalTemp,
		int32_t	lowWarningTemp,
		int32_t	hiWarningTemp,
		int32_t	hiCriticalTemp
	)

Set the Platform warning and critical temperature thresholds in degree celsius. When thresholds temperature are reached, a temperature event is triggered.

Returns

• LE_OK The function succeeded.
• LE_BAD_PARAMETER The hiWarning threshold + 1 is equal to or higher than the hiCritical threshold. The loWwarning threshold is equal to or higher than the hiWarning threshold. The loWwarning threshold is equal to or lower than the loCritical threshold.
• LE_FAULT The function failed to set the thresholds.

Parameters

[in]	lowCriticalTemp	[IN] The low critical temperature threshold in degree celsius.
[in]	lowWarningTemp	[IN] The low warning temperature threshold in degree celsius.
[in]	hiWarningTemp	[IN] The high warning temperature threshold in degree celsius.
[in]	hiCriticalTemp	[IN] The high critical temperature threshold in degree celsius.

le_result_t le_temp_SetRadioThresholds	(	int32_t	hiWarningTemp,
		int32_t	hiCriticalTemp
	)

Set the Radio warning and critical temperature thresholds in degree celsius. When thresholds temperature are reached, a temperature event is triggered.

Returns

• LE_OK The function succeeded.
• LE_BAD_PARAMETER The hiWarning threshold + 1 is equal to or higher than the hiCritical threshold.
• LE_FAULT The function failed to set the thresholds.

Parameters

[in]	hiWarningTemp	[IN] The high warning temperature threshold in degree celsius.
[in]	hiCriticalTemp	[IN] The high critical temperature threshold in degree celsius.