Classes | Macros | Typedefs | Enumerations | Functions
app_rtc.h File Reference

Header file containing functions prototypes of RTC app library. More...

`#include "grx_hal.h"`
`#include "app_drv_error.h"`
`#include "app_drv_config.h"`
Include dependency graph for app_rtc.h:

Go to the source code of this file.

## Classes
struct | app_rtc_evt_t
| RTC event structure definition. More...

## Macros
#define | APP_RTC_ALARM_DISABLE_DATE CALENDAR_ALARM_DISABLE_DATE
| App rtc time disable macro definition. More...
#define | APP_RTC_ALARM_DISABLE_TICK CALENDAR_ALARM_DISABLE_TICK
| Disable rtc tick alarm. More...
#define | APP_RTC_ALARM_DISABLE_ALL CALENDAR_ALARM_DISABLE_ALL
| Disable rtc all alarm. More...

## Typedefs
typedef calendar_time_t | app_rtc_time_t
| App time structure definition. More...
typedef calendar_alarm_t | app_rtc_alarm_t
| App alarm structure definition. More...
typedef void(* | app_rtc_evt_handler_t) (app_rtc_evt_t *p_evt)
| RTC event callback definition. More...

## Enumerations
enum | app_rtc_evt_type_t { APP_RTC_EVT_DATE_ALARM, APP_RTC_EVT_TICK_ALARM, APP_RTC_EVT_OVERFLOW }
| RTC event Enumerations definition. More...

## Functions
uint16_t | app_rtc_init (app_rtc_evt_handler_t evt_handler)
| Initialize the APP RTC DRIVER. More...
uint16_t | app_rtc_deinit (void)
| De-initialize the app rtc. More...
uint16_t | app_rtc_init_time (app_rtc_time_t *p_time)
| Initialize the rtc time. More...
uint16_t | app_rtc_get_time (app_rtc_time_t *p_time)
| Get current rtc time. More...
uint16_t | app_rtc_setup_alarm (app_rtc_alarm_t *p_alarm)
| Set a rtc date alarm. More...
uint16_t | app_rtc_setup_tick (uint32_t interval)
| Set a rtc tick alarm. More...
uint16_t | app_rtc_disable_event (uint32_t disable_mode)
| Disable rtc alarm event. More...

## Detailed Description

Header file containing functions prototypes of RTC app library.

Author
  BLE Driver Team

Attention

  ##### Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file app_rtc.h.