le_riPin_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Functions
void	le_riPin_ConnectService (void)
void	le_riPin_DisconnectService (void)
le_result_t	le_riPin_AmIOwnerOfRingSignal (bool *amIOwnerPtr)
le_result_t	le_riPin_TakeRingSignal (void)
le_result_t	le_riPin_ReleaseRingSignal (void)
void	le_riPin_PulseRingSignal (uint32_t duration)

Detailed Description

Legato Ring Indicator Signal include file.

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

Function Documentation

le_result_t le_riPin_AmIOwnerOfRingSignal

(

bool *

amIOwnerPtr

)

Check whether the application core is the current owner of the Ring Indicator signal.

Returns

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

Parameters

[out]

amIOwnerPtr

true when application core is the owner of the Ring Indicator signal,

void le_riPin_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_riPin_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.

void le_riPin_PulseRingSignal

(

uint32_t

duration

)

Set the Ring Indicator signal to high for configurable duration of time before lowering it.

Parameters

[in]

duration

[IN] Duration in ms

le_result_t le_riPin_ReleaseRingSignal

(

void

)

Release control of the Ring Indicator signal.

Returns

• LE_OK Function succeeded.
• LE_FAULT Function failed.

le_result_t le_riPin_TakeRingSignal

(

void

)

Take control of the Ring Indicator signal.

Returns

• LE_OK Function succeeded.
• LE_FAULT Function failed.