ds3231 example driver modules More...

Collaboration diagram for ds3231 example driver function:

Macros
#define	DS3231_ALARM_DEFAULT_AGING_OFFSET 0
	ds3231 alarm example default definition
#define	DS3231_BASIC_DEFAULT_AGING_OFFSET 0
	ds3231 basic example default definition
#define	DS3231_OUTPUT_DEFAULT_AGING_OFFSET 0
	ds3231 output 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
uint8_t	ds3231_basic_init (void)
	basic example init
uint8_t	ds3231_basic_deinit (void)
	basic example deinit
uint8_t	ds3231_basic_set_time (ds3231_time_t *t)
	basic example set the time
uint8_t	ds3231_basic_get_time (ds3231_time_t *t)
	basic example get the time
uint8_t	ds3231_basic_set_timestamp (time_t timestamp)
	basic example set the time by a unix timestamp
uint8_t	ds3231_basic_get_timestamp (time_t *timestamp)
	basic example get the time in a unix timestamp
uint8_t	ds3231_basic_set_timestamp_time_zone (int8_t zone)
	basic example set the local time zone
uint8_t	ds3231_basic_get_timestamp_time_zone (int8_t *zone)
	basic example get the local time zone
uint8_t	ds3231_basic_get_temperature (int16_t raw, float s)
	basic example get the current temperature
uint8_t	ds3231_basic_get_ascii_time (char *buf, uint8_t len)
	basic example get the ascii time
uint8_t	ds3231_output_init (void)
	output example init
uint8_t	ds3231_output_deinit (void)
	output example deinit
uint8_t	ds3231_output_set_time (ds3231_time_t *t)
	output example set the time
uint8_t	ds3231_output_get_time (ds3231_time_t *t)
	output example get the time
uint8_t	ds3231_output_set_timestamp (time_t timestamp)
	output example set the time by a unix timestamp
uint8_t	ds3231_output_set_timestamp_time_zone (int8_t zone)
	output example set the local time zone
uint8_t	ds3231_output_get_timestamp (time_t *timestamp)
	output example get the time in a unix timestamp
uint8_t	ds3231_output_get_timestamp_time_zone (int8_t *zone)
	output example get the local time zone
uint8_t	ds3231_output_get_temperature (int16_t raw, float s)
	output example get the current temperature
uint8_t	ds3231_output_get_ascii_time (char *buf, uint8_t len)
	output example get the ascii time
uint8_t	ds3231_output_set_square_wave (ds3231_bool_t enable)
	output example enable or disable the square wave
uint8_t	ds3231_output_get_square_wave (ds3231_bool_t *enable)
	output example get the square wave status
uint8_t	ds3231_output_set_32khz_output (ds3231_bool_t enable)
	output example enable or disable the 32KHz output
uint8_t	ds3231_output_get_32khz_output (ds3231_bool_t *enable)
	output example get the 32KHz output status

Detailed Description

ds3231 example driver modules

Macro Definition Documentation

◆ DS3231_ALARM_DEFAULT_AGING_OFFSET

#define DS3231_ALARM_DEFAULT_AGING_OFFSET 0

ds3231 alarm example default definition

0 offset

Definition at line 56 of file driver_ds3231_alarm.h.

◆ DS3231_BASIC_DEFAULT_AGING_OFFSET

#define DS3231_BASIC_DEFAULT_AGING_OFFSET 0

ds3231 basic example default definition

0 offset

Definition at line 58 of file driver_ds3231_basic.h.

◆ DS3231_OUTPUT_DEFAULT_AGING_OFFSET

#define DS3231_OUTPUT_DEFAULT_AGING_OFFSET 0

ds3231 output example default definition

0 offset

Definition at line 56 of file driver_ds3231_output.h.

Function Documentation

◆ ds3231_alarm_alarm_ascii_time()

uint8_t ds3231_alarm_alarm_ascii_time	(	char *	buf,
		uint8_t	len )

alarm example get the ascii time

Parameters

[out]	*buf	pointer to an ascii buffer
[in]	len	data length

Returns

status code

0 success
1 read failed

Note: none

Definition at line 518 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_clear_flag()

uint8_t ds3231_alarm_clear_flag ( ds3231_alarm_t alarm )

alarm clear the interrupt flag

Parameters

[in] alarm alarm number

Returns

status code

0 success
1 alarm clear failed

Note: none

Definition at line 273 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_deinit()

uint8_t ds3231_alarm_deinit ( void )

alarm example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 165 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_disable()

uint8_t ds3231_alarm_disable ( ds3231_alarm_t alarm )

disable the alarm

Parameters

[in] alarm alarm number

Returns

status code

0 success
1 disable alarm failed

Note: none

Definition at line 321 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_enable()

uint8_t ds3231_alarm_enable ( ds3231_alarm_t alarm )

enable the alarm

Parameters

[in] alarm alarm number

Returns

status code

0 success
1 enable alarm failed

Note: none

Definition at line 294 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_get_alarm1()

uint8_t ds3231_alarm_get_alarm1	(	ds3231_time_t *	t,
		ds3231_alarm1_mode_t *	mode )

alarm example get the alarm 1

Parameters

[out]	*t	pointer to a time structure
[out]	*mode	pointer to a alarm 1 interrupt mode buffer

Returns

status code

0 success
1 get alarm1 failed

Note: none

Definition at line 208 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_get_alarm2()

uint8_t ds3231_alarm_get_alarm2	(	ds3231_time_t *	t,
		ds3231_alarm2_mode_t *	mode )

alarm example get the alarm 2

Parameters

[out]	*t	pointer to a time structure
[out]	*mode	pointer to a alarm 2 interrupt mode buffer

Returns

status code

0 success
1 get alarm2 failed

Note: none

Definition at line 252 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_get_temperature()

uint8_t ds3231_alarm_get_temperature	(	int16_t *	raw,
		float *	s )

alarm example get the current temperature

Parameters

[out]	*raw	pointer to a raw temperature buffer
[out]	*s	pointer to a converted temperature buffer

Returns

status code

0 success
1 read temperature failed

Note: none

Definition at line 496 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_get_time()

uint8_t ds3231_alarm_get_time ( ds3231_time_t * t )

alarm example get the time

Parameters

[out] *t pointer to a time structure

Returns

status code

0 success
1 get time failed

Note: none

Definition at line 421 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_get_timestamp()

uint8_t ds3231_alarm_get_timestamp ( time_t * timestamp )

alarm example get the time in a unix timestamp

Parameters

[out] *timestamp pointer to a unix timestamp buffer

Returns

status code

0 success
1 get timestamp failed

Note: none

Definition at line 442 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_get_timestamp_time_zone()

uint8_t ds3231_alarm_get_timestamp_time_zone ( int8_t * zone )

alarm example get the local time zone

Parameters

[out] *zone pointer to a local time zone buffer

Returns

status code

0 success

Note: none

Definition at line 480 of file driver_ds3231_alarm.c.

◆ ds3231_alarm_init()

uint8_t ds3231_alarm_init ( void(* alarm_receive_callback )(uint8_t type) )

alarm example init

Parameters

[in] *alarm_receive_callback pointer to a alarm receive callback function callback

Returns

status code

0 success
1 init failed

Note: none

Definition at line 71 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_irq_handler()

uint8_t ds3231_alarm_irq_handler ( void )

alarm irq handler

Returns

status code

0 success
1 run failed

Note: none

Definition at line 50 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_set_alarm1()

uint8_t ds3231_alarm_set_alarm1	(	ds3231_time_t *	t,
		ds3231_alarm1_mode_t	mode )

alarm example set the alarm 1

Parameters

[in]	*t	pointer to a time structure
[in]	mode	alarm 1 interrupt mode

Returns

status code

0 success
1 set alarm1 failed

Note: none

Definition at line 186 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_set_alarm2()

uint8_t ds3231_alarm_set_alarm2	(	ds3231_time_t *	t,
		ds3231_alarm2_mode_t	mode )

alarm example set the alarm 2

Parameters

[in]	*t	pointer to a time structure
[in]	mode	alarm 2 interrupt mode

Returns

status code

0 success
1 set alarm2 failed

Note: none

Definition at line 230 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_set_time()

uint8_t ds3231_alarm_set_time ( ds3231_time_t * t )

alarm example set the time

Parameters

[in] *t pointer to a time structure

Returns

status code

0 success
1 set time failed

Note: none

Definition at line 342 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_set_timestamp()

uint8_t ds3231_alarm_set_timestamp ( time_t timestamp )

alarm example set the time by a unix timestamp

Parameters

[in] timestamp unix timestamp

Returns

status code

0 success
1 set timestamp failed

Note: none

Definition at line 363 of file driver_ds3231_alarm.c.

Here is the call graph for this function:

◆ ds3231_alarm_set_timestamp_time_zone()

uint8_t ds3231_alarm_set_timestamp_time_zone ( int8_t zone )

alarm example set the local time zone

Parameters

[in] zone local time zone

Returns

status code

0 success

Note: none

Definition at line 406 of file driver_ds3231_alarm.c.

◆ ds3231_basic_deinit()

uint8_t ds3231_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 164 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_get_ascii_time()

uint8_t ds3231_basic_get_ascii_time	(	char *	buf,
		uint8_t	len )

basic example get the ascii time

Parameters

[out]	*buf	pointer to an ascii buffer
[in]	len	data length

Returns

status code

0 success
1 read failed

Note: none

Definition at line 360 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_get_temperature()

uint8_t ds3231_basic_get_temperature	(	int16_t *	raw,
		float *	s )

basic example get the current temperature

Parameters

[out]	*raw	pointer to a raw temperature buffer
[out]	*s	pointer to a converted temperature buffer

Returns

status code

0 success
1 read temperature failed

Note: none

Definition at line 338 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_get_time()

uint8_t ds3231_basic_get_time ( ds3231_time_t * t )

basic example get the time

Parameters

[out] *t pointer to a time structure

Returns

status code

0 success
1 get time failed

Note: none

Definition at line 263 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_get_timestamp()

uint8_t ds3231_basic_get_timestamp ( time_t * timestamp )

basic example get the time in a unix timestamp

Parameters

[out] *timestamp pointer to a unix timestamp buffer

Returns

status code

0 success
1 get timestamp failed

Note: none

Definition at line 284 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_get_timestamp_time_zone()

uint8_t ds3231_basic_get_timestamp_time_zone ( int8_t * zone )

basic example get the local time zone

Parameters

[out] *zone pointer to a local time zone buffer

Returns

status code

0 success

Note: none

Definition at line 322 of file driver_ds3231_basic.c.

◆ ds3231_basic_init()

uint8_t ds3231_basic_init ( void )

basic example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_set_time()

uint8_t ds3231_basic_set_time ( ds3231_time_t * t )

basic example set the time

Parameters

[in] *t pointer to a time structure

Returns

status code

0 success
1 set time failed

Note: none

Definition at line 184 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_set_timestamp()

uint8_t ds3231_basic_set_timestamp ( time_t timestamp )

basic example set the time by a unix timestamp

Parameters

[in] timestamp unix timestamp

Returns

status code

0 success
1 set timestamp failed

Note: none

Definition at line 205 of file driver_ds3231_basic.c.

Here is the call graph for this function:

◆ ds3231_basic_set_timestamp_time_zone()

uint8_t ds3231_basic_set_timestamp_time_zone ( int8_t zone )

basic example set the local time zone

Parameters

[in] zone local time zone

Returns

status code

0 success

Note: none

Definition at line 248 of file driver_ds3231_basic.c.

◆ ds3231_output_deinit()

uint8_t ds3231_output_deinit ( void )

output example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 144 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_32khz_output()

uint8_t ds3231_output_get_32khz_output ( ds3231_bool_t * enable )

output example get the 32KHz output status

Parameters

[out] *enable pointer to a bool value buffer

Returns

status code

0 success
1 get 32KHz output failed

Note: none

Definition at line 435 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_ascii_time()

uint8_t ds3231_output_get_ascii_time	(	char *	buf,
		uint8_t	len )

output example get the ascii time

Parameters

[out]	*buf	pointer to an ascii buffer
[in]	len	data length

Returns

status code

0 success
1 read failed

Note: none

Definition at line 340 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_square_wave()

uint8_t ds3231_output_get_square_wave ( ds3231_bool_t * enable )

output example get the square wave status

Parameters

[out] *enable pointer to a bool value buffer

Returns

status code

0 success
1 get square wave failed

Note: none

Definition at line 393 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_temperature()

uint8_t ds3231_output_get_temperature	(	int16_t *	raw,
		float *	s )

output example get the current temperature

Parameters

[out]	*raw	pointer to a raw temperature buffer
[out]	*s	pointer to a converted temperature buffer

Returns

status code

0 success
1 read temperature failed

Note: none

Definition at line 318 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_time()

uint8_t ds3231_output_get_time ( ds3231_time_t * t )

output example get the time

Parameters

[out] *t pointer to a time structure

Returns

status code

0 success
1 get time failed

Note: none

Definition at line 243 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_timestamp()

uint8_t ds3231_output_get_timestamp ( time_t * timestamp )

output example get the time in a unix timestamp

Parameters

[out] *timestamp pointer to a unix timestamp buffer

Returns

status code

0 success
1 get timestamp failed

Note: none

Definition at line 264 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_get_timestamp_time_zone()

uint8_t ds3231_output_get_timestamp_time_zone ( int8_t * zone )

output example get the local time zone

Parameters

[out] *zone pointer to a local time zone buffer

Returns

status code

0 success

Note: none

Definition at line 302 of file driver_ds3231_output.c.

◆ ds3231_output_init()

uint8_t ds3231_output_init ( void )

output example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_set_32khz_output()

uint8_t ds3231_output_set_32khz_output ( ds3231_bool_t enable )

output example enable or disable the 32KHz output

Parameters

[in] enable bool value

Returns

status code

0 success
1 set 32khz output failed

Note: none

Definition at line 414 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_set_square_wave()

uint8_t ds3231_output_set_square_wave ( ds3231_bool_t enable )

output example enable or disable the square wave

Parameters

[in] enable bool value

Returns

status code

0 success
1 set square wave failed

Note: none

Definition at line 372 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_set_time()

uint8_t ds3231_output_set_time ( ds3231_time_t * t )

output example set the time

Parameters

[in] *t pointer to a time structure

Returns

status code

0 success
1 set time failed

Note: none

Definition at line 164 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_set_timestamp()

uint8_t ds3231_output_set_timestamp ( time_t timestamp )

output example set the time by a unix timestamp

Parameters

[in] timestamp unix timestamp

Returns

status code

0 success
1 set timestamp failed

Note: none

Definition at line 185 of file driver_ds3231_output.c.

Here is the call graph for this function:

◆ ds3231_output_set_timestamp_time_zone()

uint8_t ds3231_output_set_timestamp_time_zone ( int8_t zone )

output example set the local time zone

Parameters

[in] zone local time zone

Returns

status code

0 success

Note: none

Definition at line 228 of file driver_ds3231_output.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ DS3231_ALARM_DEFAULT_AGING_OFFSET

◆ DS3231_BASIC_DEFAULT_AGING_OFFSET

◆ DS3231_OUTPUT_DEFAULT_AGING_OFFSET

Function Documentation

◆ ds3231_alarm_alarm_ascii_time()

◆ ds3231_alarm_clear_flag()

◆ ds3231_alarm_deinit()

◆ ds3231_alarm_disable()

◆ ds3231_alarm_enable()

◆ ds3231_alarm_get_alarm1()

◆ ds3231_alarm_get_alarm2()

◆ ds3231_alarm_get_temperature()

◆ ds3231_alarm_get_time()

◆ ds3231_alarm_get_timestamp()

◆ ds3231_alarm_get_timestamp_time_zone()

◆ ds3231_alarm_init()

◆ ds3231_alarm_irq_handler()

◆ ds3231_alarm_set_alarm1()

◆ ds3231_alarm_set_alarm2()

◆ ds3231_alarm_set_time()

◆ ds3231_alarm_set_timestamp()

◆ ds3231_alarm_set_timestamp_time_zone()

◆ ds3231_basic_deinit()

◆ ds3231_basic_get_ascii_time()

◆ ds3231_basic_get_temperature()

◆ ds3231_basic_get_time()

◆ ds3231_basic_get_timestamp()

◆ ds3231_basic_get_timestamp_time_zone()

◆ ds3231_basic_init()

◆ ds3231_basic_set_time()

◆ ds3231_basic_set_timestamp()

◆ ds3231_basic_set_timestamp_time_zone()

◆ ds3231_output_deinit()

◆ ds3231_output_get_32khz_output()

◆ ds3231_output_get_ascii_time()

◆ ds3231_output_get_square_wave()

◆ ds3231_output_get_temperature()

◆ ds3231_output_get_time()

◆ ds3231_output_get_timestamp()

◆ ds3231_output_get_timestamp_time_zone()

◆ ds3231_output_init()

◆ ds3231_output_set_32khz_output()

◆ ds3231_output_set_square_wave()

◆ ds3231_output_set_time()

◆ ds3231_output_set_timestamp()

◆ ds3231_output_set_timestamp_time_zone()