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 client to the service

void le_riPin_DisconnectService

(

void

)

Disconnect the client from the service

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.