Sensor-Watch/patch/watch__rtc_8h_source.html

 /*

-  * MIT License

-  *

-  * Copyright (c) 2020 Joey Castillo

-  *

-  * Permission is hereby granted, free of charge, to any person obtaining a copy

-  * of this software and associated documentation files (the "Software"), to deal

-  * in the Software without restriction, including without limitation the rights

-  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

-  * copies of the Software, and to permit persons to whom the Software is

-  * furnished to do so, subject to the following conditions:

-  *

-  * The above copyright notice and this permission notice shall be included in all

-  * copies or substantial portions of the Software.

-  *

-  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

-  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

-  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

-  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

-  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

-  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

-  * SOFTWARE.

-  */

- #ifndef _WATCH_RTC_H_INCLUDED

- #define _WATCH_RTC_H_INCLUDED

-

- #include "watch.h"

- #include "hpl_calendar.h"

-

-

- #define WATCH_RTC_REFERENCE_YEAR (2020)

-

- typedef union {

-     struct {

-         uint32_t second : 6;    // 0-59

-         uint32_t minute : 6;    // 0-59

-         uint32_t hour : 5;      // 0-23

-         uint32_t day : 5;       // 1-31

-         uint32_t month : 4;     // 1-12

-         uint32_t year : 6;      // 0-63 (representing 2020-2083)

-     } unit;

-     uint32_t reg;               // the bit-packed value as expected by the RTC peripheral's CLOCK register.

- } watch_date_time;

-

- typedef enum watch_rtc_alarm_match {

-     ALARM_MATCH_DISABLED = 0,

-     ALARM_MATCH_SS,

-     ALARM_MATCH_MMSS,

-     ALARM_MATCH_HHMMSS,

- } watch_rtc_alarm_match;

-

- bool _watch_rtc_is_enabled(void);

-

- void watch_rtc_set_date_time(watch_date_time date_time);

-

- watch_date_time watch_rtc_get_date_time(void);

-

- void watch_rtc_register_alarm_callback(ext_irq_cb_t callback, watch_date_time alarm_time, watch_rtc_alarm_match mask);

-

- void watch_rtc_disable_alarm_callback(void);

-

- void watch_rtc_register_tick_callback(ext_irq_cb_t callback);

-

- void watch_rtc_disable_tick_callback(void);

-

- void watch_rtc_register_periodic_callback(ext_irq_cb_t callback, uint8_t frequency);

-

- void watch_rtc_disable_periodic_callback(uint8_t frequency);

-

- void watch_rtc_disable_all_periodic_callbacks(void);

-

- __attribute__((deprecated("Use watch_rtc_set_date_time function instead")))

- void watch_set_date_time(struct calendar_date_time date_time);

-

- __attribute__((deprecated("Use the watch_rtc_get_date_time function instead")))

- void watch_get_date_time(struct calendar_date_time *date_time);

-

- __attribute__((deprecated("Use the watch_rtc_register_tick_callback function instead")))

- void watch_register_tick_callback(ext_irq_cb_t callback);

-

- #endif

-watch_rtc_disable_all_periodic_callbacks
void watch_rtc_disable_all_periodic_callbacks(void)
Disables all periodic callbacks, including the once-per-second tick callback.
Definition: watch_rtc.c:105

-watch_rtc_get_date_time
watch_date_time watch_rtc_get_date_time(void)
Returns the date and time.
Definition: watch_rtc.c:64

-_watch_rtc_is_enabled
bool _watch_rtc_is_enabled(void)
Called by main.c to check if the RTC is enabled. You may call this function, but outside of app_init,...
Definition: watch_rtc.c:33

-watch_rtc_disable_periodic_callback
void watch_rtc_disable_periodic_callback(uint8_t frequency)
Disables the tick callback for the given period.
Definition: watch_rtc.c:99

-watch_rtc_disable_tick_callback
void watch_rtc_disable_tick_callback(void)
Disables the tick callback for the given period.
Definition: watch_rtc.c:77

-watch_rtc_disable_alarm_callback
void watch_rtc_disable_alarm_callback(void)
Disables the alarm callback.
Definition: watch_rtc.c:119

-watch_rtc_register_tick_callback
void watch_rtc_register_tick_callback(ext_irq_cb_t callback)
Registers a "tick" callback that will be called once per second.
Definition: watch_rtc.c:73

-__attribute__
__attribute__((deprecated("Use watch_rtc_set_date_time function instead"))) void watch_set_date_time(struct calendar_date_time date_time)
Sets the system date and time.

-watch_rtc_register_alarm_callback
void watch_rtc_register_alarm_callback(ext_irq_cb_t callback, watch_date_time alarm_time, watch_rtc_alarm_match mask)
Registers an alarm callback that will be called when the RTC time matches the target time,...
Definition: watch_rtc.c:109

-watch_rtc_set_date_time
void watch_rtc_set_date_time(watch_date_time date_time)
Sets the date and time.
Definition: watch_rtc.c:59

-watch_rtc_register_periodic_callback
void watch_rtc_register_periodic_callback(ext_irq_cb_t callback, uint8_t frequency)
Registers a callback that will be called at a configurable period.
Definition: watch_rtc.c:81

-watch_date_time
Definition: watch_rtc.h:44

-watch.h

-