le_rtc_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Functions
void	le_rtc_ConnectService (void)
void	le_rtc_DisconnectService (void)
le_result_t	le_rtc_GetUserTime (uint64_t *millisecondsPastGpsEpochPtr)
le_result_t	le_rtc_SetUserTime (uint64_t millisecondsPastGpsEpoch)

Detailed Description

Legato User Timebase include file.

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

Function Documentation

void le_rtc_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_rtc_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_rtc_GetUserTime

(

uint64_t *

millisecondsPastGpsEpochPtr

)

Get the current time from the RTC

Returns

• LE_OK Function succeeded.
• LE_FAULT Function failed.

Parameters

[out]

millisecondsPastGpsEpochPtr

le_result_t le_rtc_SetUserTime

(

uint64_t

millisecondsPastGpsEpoch

)

Set the RTC with the given time string

Returns

• LE_OK Function succeeded.
• LE_FAULT Function failed.

Parameters

[in]

millisecondsPastGpsEpoch