le_adc_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Enumerations
enum	le_adc_AdcChannelInput_t {   LE_ADC_VBATT, LE_ADC_VCOIN, LE_ADC_PA_THERM, LE_ADC_PMIC_THERM,   LE_ADC_XO_THERM, LE_ADC_EXT_ADC1, LE_ADC_EXT_ADC2, LE_ADC_PRI_ANT,   LE_ADC_SEC_ANT, LE_ADC_GNSS_ANT, LE_ADC_END_OF_INPUTS }

Functions
void	le_adc_ConnectService (void)
void	le_adc_DisconnectService (void)
le_result_t	le_adc_ReadValue (le_adc_AdcChannelInput_t adcChannel, int32_t *adcValuePtr)

Detailed Description

Legato ADC Channel API include file.

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

Enumeration Type Documentation

enum le_adc_AdcChannelInput_t

Available ADC channels

Warning

Ensure to check the list of supported ADC channels on your specific platform before calling the le_adc_ReadValue() function.

Function Documentation

void le_adc_ConnectService

(

void

)

Connect the client to the service

void le_adc_DisconnectService

(

void

)

Disconnect the client from the service

le_result_t le_adc_ReadValue	(	le_adc_AdcChannelInput_t	adcChannel,
		int32_t *	adcValuePtr
	)

Get the value of an ADC input

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed.

Parameters

[in]	adcChannel	The adc channel to read (as per Inputs)
[out]	adcValuePtr	The adc value