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_EXT_ADC1, LE_ADC_EXT_ADC2, LE_ADC_MAX }

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 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_adc_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_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