drivers_2include_2periph_2rtc_8h_source.html

/*

 * SPDX-FileCopyrightText: 2014 Thomas Eichinger <thomas.eichinger@fu-berlin.de>

 * SPDX-License-Identifier: LGPL-2.1-only

 */


#pragma once


#include <stdbool.h>

#include <stdint.h>

#include <time.h>

#include "rtc_utils.h"

#include "periph_conf.h"


#ifdef __cplusplus

extern "C" {

#endif


#if !defined(RIOT_EPOCH)

#  define RIOT_EPOCH (2020)

#endif


typedef void(*rtc_alarm_cb_t)(void *arg);


void rtc_init(void);


int rtc_set_time(struct tm *time);


int rtc_get_time(struct tm *time);


int rtc_get_time_ms(struct tm *time, uint16_t *ms);


int rtc_set_alarm(struct tm *time, rtc_alarm_cb_t cb, void *arg);


int rtc_get_alarm(struct tm *time);


void rtc_clear_alarm(void);


void rtc_poweron(void);


void rtc_poweroff(void);


#ifdef __cplusplus

}

#endif


rtc_alarm_cb_t
void(* rtc_alarm_cb_t)(void *arg)
Signature for alarm Callback.
Definition rtc.h:71

rtc_set_alarm
int rtc_set_alarm(struct tm *time, rtc_alarm_cb_t cb, void *arg)
Set an alarm for the RTC to the specified value.

rtc_get_alarm
int rtc_get_alarm(struct tm *time)
Gets the current alarm setting.

rtc_poweroff
void rtc_poweroff(void)
Turns the RTC hardware module off.

rtc_set_time
int rtc_set_time(struct tm *time)
Set the RTC to a given time.

rtc_clear_alarm
void rtc_clear_alarm(void)
Clear any set alarm, do nothing if nothing is set.

rtc_get_time
int rtc_get_time(struct tm *time)
Get the current RTC time.

rtc_init
void rtc_init(void)
Initialize the RTC module.

rtc_poweron
void rtc_poweron(void)
Turns the RTC hardware module on.

rtc_get_time_ms
int rtc_get_time_ms(struct tm *time, uint16_t *ms)
Get the current RTC time with a sub-second component.

rtc_utils.h