#include "legato.h"
Go to the source code of this file.
Typedefs | |
typedef struct le_antenna_Obj * | le_antenna_ObjRef_t |
typedef struct le_antenna_StatusEventHandler * | le_antenna_StatusEventHandlerRef_t |
typedef void(* | le_antenna_StatusHandlerFunc_t) (le_antenna_ObjRef_t antennaRef, le_antenna_Status_t status, void *contextPtr) |
Enumerations | |
enum | le_antenna_Type_t { LE_ANTENNA_PRIMARY_CELLULAR, LE_ANTENNA_DIVERSITY_CELLULAR, LE_ANTENNA_GNSS, LE_ANTENNA_MAX } |
enum | le_antenna_Status_t { LE_ANTENNA_SHORT_CIRCUIT, LE_ANTENNA_CLOSE_CIRCUIT, LE_ANTENNA_OPEN_CIRCUIT, LE_ANTENNA_OVER_CURRENT, LE_ANTENNA_INACTIVE, LE_ANTENNA_LAST_STATUS } |
Legato Antenna Monitoring include file.
Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
typedef struct le_antenna_Obj* le_antenna_ObjRef_t |
Reference type for an antenna diagnostic.
typedef struct le_antenna_StatusEventHandler* le_antenna_StatusEventHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'le_antenna_StatusEvent'
typedef void(* le_antenna_StatusHandlerFunc_t) (le_antenna_ObjRef_t antennaRef, le_antenna_Status_t status, void *contextPtr) |
Handler for antenna status.
antennaRef | antenna reference |
status | antenna status |
contextPtr |
enum le_antenna_Status_t |
Antenna status
enum le_antenna_Type_t |
le_antenna_StatusEventHandlerRef_t le_antenna_AddStatusEventHandler | ( | le_antenna_ObjRef_t | antennaRef, |
le_antenna_StatusHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'le_antenna_StatusEvent'
This event provides information on antenna status for the given antennaRef.
[in] | antennaRef | antenna reference |
[in] | handlerPtr | |
[in] | contextPtr |
void le_antenna_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_antenna_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_antenna_GetExternalAdc | ( | le_antenna_ObjRef_t | antennaRef, |
int8_t * | adcIdPtr | ||
) |
Get the external ADC used to monitor the requested antenna.
[in] | antennaRef | antenna reference |
[out] | adcIdPtr | The ADC index used to monitor the requested antenna |
le_result_t le_antenna_GetOpenLimit | ( | le_antenna_ObjRef_t | antennaRef, |
uint32_t * | openLimitPtr | ||
) |
Get the ADC value used to detect an open circuit.
[in] | antennaRef | antenna reference |
[out] | openLimitPtr | The ADC value used to detect an open circuit |
le_result_t le_antenna_GetShortLimit | ( | le_antenna_ObjRef_t | antennaRef, |
uint32_t * | shortLimitPtr | ||
) |
Get the ADC value used to detect a short circuit.
[in] | antennaRef | antenna reference |
[out] | shortLimitPtr | The ADC value used to detect a short circuit |
le_result_t le_antenna_GetStatus | ( | le_antenna_ObjRef_t | antennaRef, |
le_antenna_Status_t * | statusPtr | ||
) |
Get the antenna status.
[in] | antennaRef | antenna reference |
[out] | statusPtr | antenna status |
le_result_t le_antenna_GetType | ( | le_antenna_ObjRef_t | antennaRef, |
le_antenna_Type_t * | antennaTypePtr | ||
) |
Get the antenna type.
[in] | antennaRef | antenna reference |
[out] | antennaTypePtr | allocated antenna type |
void le_antenna_RemoveStatusEventHandler | ( | le_antenna_StatusEventHandlerRef_t | addHandlerRef | ) |
Remove handler function for EVENT 'le_antenna_StatusEvent'
[in] | addHandlerRef |
le_antenna_ObjRef_t le_antenna_Request | ( | le_antenna_Type_t | antennaType | ) |
Requested the antenna monitoring.
[in] | antennaType | antenna to be monitored |
le_result_t le_antenna_SetExternalAdc | ( | le_antenna_ObjRef_t | antennaRef, |
int8_t | adcId | ||
) |
Set the external ADC used to monitor the requested antenna.
[in] | antennaRef | antenna reference |
[in] | adcId | The ADC index used to monitor the requested antenna |
le_result_t le_antenna_SetOpenLimit | ( | le_antenna_ObjRef_t | antennaRef, |
uint32_t | openLimit | ||
) |
Set the ADC value used to detect an open circuit.
[in] | antennaRef | antenna reference |
[in] | openLimit | The ADC value used to detect an open circuit |
le_result_t le_antenna_SetShortLimit | ( | le_antenna_ObjRef_t | antennaRef, |
uint32_t | shortLimit | ||
) |
Set the ADC value used to detect a short circuit.
[in] | antennaRef | antenna reference |
[in] | shortLimit | The ADC value used to detect a short circuit |