driver_ds3231_alarm.h File Reference

driver ds3231 alarm header file More...

#include "driver_ds3231_interface.h"
#include <time.h>

Include dependency graph for driver_ds3231_alarm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	DS3231_ALARM_DEFAULT_AGING_OFFSET   0
	ds3231 alarm example default definition

Functions
uint8_t	ds3231_alarm_irq_handler (void)
	alarm irq handler
uint8_t	ds3231_alarm_init (void(*alarm_receive_callback)(uint8_t type))
	alarm example init
uint8_t	ds3231_alarm_deinit (void)
	alarm example deinit
uint8_t	ds3231_alarm_set_alarm1 (ds3231_time_t *t, ds3231_alarm1_mode_t mode)
	alarm example set the alarm 1
uint8_t	ds3231_alarm_get_alarm1 (ds3231_time_t *t, ds3231_alarm1_mode_t *mode)
	alarm example get the alarm 1
uint8_t	ds3231_alarm_set_alarm2 (ds3231_time_t *t, ds3231_alarm2_mode_t mode)
	alarm example set the alarm 2
uint8_t	ds3231_alarm_get_alarm2 (ds3231_time_t *t, ds3231_alarm2_mode_t *mode)
	alarm example get the alarm 2
uint8_t	ds3231_alarm_clear_flag (ds3231_alarm_t alarm)
	alarm clear the interrupt flag
uint8_t	ds3231_alarm_enable (ds3231_alarm_t alarm)
	enable the alarm
uint8_t	ds3231_alarm_disable (ds3231_alarm_t alarm)
	disable the alarm
uint8_t	ds3231_alarm_set_time (ds3231_time_t *t)
	alarm example set the time
uint8_t	ds3231_alarm_get_time (ds3231_time_t *t)
	alarm example get the time
uint8_t	ds3231_alarm_set_timestamp (time_t timestamp)
	alarm example set the time by a unix timestamp
uint8_t	ds3231_alarm_get_timestamp (time_t *timestamp)
	alarm example get the time in a unix timestamp
uint8_t	ds3231_alarm_set_timestamp_time_zone (int8_t zone)
	alarm example set the local time zone
uint8_t	ds3231_alarm_get_timestamp_time_zone (int8_t *zone)
	alarm example get the local time zone
uint8_t	ds3231_alarm_get_temperature (int16_t *raw, float *s)
	alarm example get the current temperature
uint8_t	ds3231_alarm_alarm_ascii_time (char *buf, uint8_t len)
	alarm example get the ascii time

Detailed Description

driver ds3231 alarm header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

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.

Version

2.0.0

Author

Shifeng Li

Date

2021-03-15

history

Date	Version	Author	Description
2021/03/15	2.0	Shifeng Li	format the code
2020/11/30	1.0	Shifeng Li	first upload

Definition in file driver_ds3231_alarm.h.