Macros | Typedefs | Functions

le_adc_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros

#define LE_ADC_ADC_NAME_MAX_LEN   30
 
#define LE_ADC_ADC_NAME_MAX_BYTES   31
 

Typedefs

typedef void(* le_adc_DisconnectHandler_t) (void *)
 

Functions

void le_adc_ConnectService (void)
 
le_result_t le_adc_TryConnectService (void)
 
void le_adc_SetServerDisconnectHandler (le_adc_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_adc_DisconnectService (void)
 
le_result_t le_adc_ReadValue (const char *LE_NONNULL adcName, int32_t *adcValuePtr)
 

Detailed Description

Legato ADC Channel API include file.

Copyright (C) Sierra Wireless Inc.

Macro Definition Documentation

◆ LE_ADC_ADC_NAME_MAX_BYTES

#define LE_ADC_ADC_NAME_MAX_BYTES   31

Maximum ADC's name string length. One extra byte is added for the null character.

◆ LE_ADC_ADC_NAME_MAX_LEN

#define LE_ADC_ADC_NAME_MAX_LEN   30

Maximum ADC's name string length.

Typedef Documentation

◆ le_adc_DisconnectHandler_t

typedef void(* le_adc_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_adc_ConnectService()

void le_adc_ConnectService ( void  )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

◆ le_adc_DisconnectService()

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_adc_ReadValue()

le_result_t le_adc_ReadValue ( const char *LE_NONNULL  adcName,
int32_t *  adcValuePtr 
)

Get the value of an ADC input

Returns
  • LE_OK The function succeeded.
  • LE_FAULT The function failed.
Parameters
[in]adcNameName of the ADC to read.
[out]adcValuePtrThe adc value

◆ le_adc_SetServerDisconnectHandler()

void le_adc_SetServerDisconnectHandler ( le_adc_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ le_adc_TryConnectService()

le_result_t le_adc_TryConnectService ( void  )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.