ds3231 alarm driver function

ds3231 alarm driver modules More...

Collaboration diagram for ds3231 alarm driver function:

Enumerations
enum	ds3231_alarm1_mode_t {   DS3231_ALARM1_MODE_ONCE_A_SECOND = 0x0F , DS3231_ALARM1_MODE_SECOND_MATCH = 0x0E , DS3231_ALARM1_MODE_MINUTE_SECOND_MATCH = 0x0C , DS3231_ALARM1_MODE_HOUR_MINUTE_SECOND_MATCH = 0x08 ,   DS3231_ALARM1_MODE_DATE_HOUR_MINUTE_SECOND_MATCH = 0x00 , DS3231_ALARM1_MODE_WEEK_HOUR_MINUTE_SECOND_MATCH = 0x10 }
	ds3231 alarm1 enumeration definition More...
enum	ds3231_alarm2_mode_t {   DS3231_ALARM2_MODE_ONCE_A_MINUTE = 0x07 , DS3231_ALARM2_MODE_MINUTE_MATCH = 0x06 , DS3231_ALARM2_MODE_HOUR_MINUTE_MATCH = 0x04 , DS3231_ALARM2_MODE_DATE_HOUR_MINUTE_MATCH = 0x00 ,   DS3231_ALARM2_MODE_WEEK_HOUR_MINUTE_MATCH = 0x10 }
	ds3231 alarm2 enumeration definition More...

Functions
uint8_t	ds3231_set_alarm_interrupt (ds3231_handle_t *handle, ds3231_alarm_t alarm, ds3231_bool_t enable)
	enable or disable the alarm interrupt
uint8_t	ds3231_get_alarm_interrupt (ds3231_handle_t *handle, ds3231_alarm_t alarm, ds3231_bool_t *enable)
	get the alarm interrupt status
uint8_t	ds3231_set_alarm1 (ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm1_mode_t mode)
	set the alarm1 time
uint8_t	ds3231_get_alarm1 (ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm1_mode_t *mode)
	get the alarm1 time
uint8_t	ds3231_set_alarm2 (ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm2_mode_t mode)
	set the alarm2 time
uint8_t	ds3231_get_alarm2 (ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm2_mode_t *mode)
	get the alarm2 time
uint8_t	ds3231_alarm_clear (ds3231_handle_t *handle, ds3231_alarm_t alarm)
	clear the alarm flag

Detailed Description

ds3231 alarm driver modules

Enumeration Type Documentation

ds3231_alarm1_mode_t

enum ds3231_alarm1_mode_t

ds3231 alarm1 enumeration definition

Enumerator
DS3231_ALARM1_MODE_ONCE_A_SECOND	interrupt once a second
DS3231_ALARM1_MODE_SECOND_MATCH	interrupt second match
DS3231_ALARM1_MODE_MINUTE_SECOND_MATCH	interrupt minute second match
DS3231_ALARM1_MODE_HOUR_MINUTE_SECOND_MATCH	interrupt hour minute second match
DS3231_ALARM1_MODE_DATE_HOUR_MINUTE_SECOND_MATCH	interrupt date hour minute second match
DS3231_ALARM1_MODE_WEEK_HOUR_MINUTE_SECOND_MATCH	interrupt week hour minute second match

Definition at line 126 of file driver_ds3231.h.

ds3231_alarm2_mode_t

enum ds3231_alarm2_mode_t

ds3231 alarm2 enumeration definition

Enumerator
DS3231_ALARM2_MODE_ONCE_A_MINUTE	interrupt once a minute
DS3231_ALARM2_MODE_MINUTE_MATCH	interrupt minute match
DS3231_ALARM2_MODE_HOUR_MINUTE_MATCH	interrupt hour minute match
DS3231_ALARM2_MODE_DATE_HOUR_MINUTE_MATCH	interrupt data hour minute match
DS3231_ALARM2_MODE_WEEK_HOUR_MINUTE_MATCH	interrupt week hour minute match

Definition at line 139 of file driver_ds3231.h.

Function Documentation

ds3231_alarm_clear()

uint8_t ds3231_alarm_clear	(	ds3231_handle_t *	handle,
		ds3231_alarm_t	alarm )

clear the alarm flag

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[in]	alarm	alarm number

Returns

status code

• 0 success
• 1 alarm clear failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1599 of file driver_ds3231.c.

ds3231_get_alarm1()

uint8_t ds3231_get_alarm1	(	ds3231_handle_t *	handle,
		ds3231_time_t *	t,
		ds3231_alarm1_mode_t *	mode )

get the alarm1 time

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[out]	*t	pointer to a time structure
[out]	*mode	pointer to an alarm1 interrupt mode buffer

Returns

status code

• 0 success
• 1 get alarm1 failed
• 2 handle or time is NULL
• 3 handle is not initialized

Note

none

Definition at line 584 of file driver_ds3231.c.

ds3231_get_alarm2()

uint8_t ds3231_get_alarm2	(	ds3231_handle_t *	handle,
		ds3231_time_t *	t,
		ds3231_alarm2_mode_t *	mode )

get the alarm2 time

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[out]	*t	pointer to a time structure
[out]	*mode	pointer to an alarm2 interrupt mode buffer

Returns

status code

• 0 success
• 1 get alarm2 failed
• 2 handle or time is NULL
• 3 handle is not initialized

Note

none

Definition at line 788 of file driver_ds3231.c.

ds3231_get_alarm_interrupt()

uint8_t ds3231_get_alarm_interrupt	(	ds3231_handle_t *	handle,
		ds3231_alarm_t	alarm,
		ds3231_bool_t *	enable )

get the alarm interrupt status

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[in]	alarm	alarm number
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get alarm interrupt failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 985 of file driver_ds3231.c.

ds3231_set_alarm1()

uint8_t ds3231_set_alarm1	(	ds3231_handle_t *	handle,
		ds3231_time_t *	t,
		ds3231_alarm1_mode_t	mode )

set the alarm1 time

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[in]	*t	pointer to a time structure
[in]	mode	alarm1 interrupt mode

Returns

status code

• 0 success
• 1 set alarm1 failed
• 2 handle or time is NULL
• 3 handle is not initialized

Note

none

Definition at line 432 of file driver_ds3231.c.

ds3231_set_alarm2()

uint8_t ds3231_set_alarm2	(	ds3231_handle_t *	handle,
		ds3231_time_t *	t,
		ds3231_alarm2_mode_t	mode )

set the alarm2 time

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[in]	*t	pointer to a time structure
[in]	mode	alarm2 interrupt mode

Returns

status code

• 0 success
• 1 set alarm2 failed
• 2 handle or time is NULL
• 3 handle is not initialized

Note

none

Definition at line 655 of file driver_ds3231.c.

ds3231_set_alarm_interrupt()

uint8_t ds3231_set_alarm_interrupt	(	ds3231_handle_t *	handle,
		ds3231_alarm_t	alarm,
		ds3231_bool_t	enable )

enable or disable the alarm interrupt

Parameters

[in]	*handle	pointer to a ds3231 handle structure
[in]	alarm	alarm number
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set alarm interrupt failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 939 of file driver_ds3231.c.