ds1307 example driver modules More...

Collaboration diagram for ds1307 example driver function:

Functions
uint8_t	ds1307_basic_init (void)
	basic example init
uint8_t	ds1307_basic_deinit (void)
	basic example deinit
uint8_t	ds1307_basic_set_time (ds1307_time_t *t)
	basic example set the time
uint8_t	ds1307_basic_set_timestamp (time_t timestamp)
	basic example set the time by a unix timestamp
uint8_t	ds1307_basic_set_timestamp_time_zone (int8_t zone)
	basic example set the local time zone
uint8_t	ds1307_basic_get_time (ds1307_time_t *t)
	basic example get the time
uint8_t	ds1307_basic_get_timestamp (time_t *timestamp)
	basic example get the time in a unix timestamp
uint8_t	ds1307_basic_get_timestamp_time_zone (int8_t *zone)
	basic example get the local time zone
uint8_t	ds1307_basic_get_ascii_time (char *buf, uint8_t len)
	basic example get the ascii time
uint8_t	ds1307_basic_read_ram (uint8_t addr, uint8_t *buf, uint8_t len)
	basic example read ram
uint8_t	ds1307_basic_write_ram (uint8_t addr, uint8_t *buf, uint8_t len)
	basic example write ram
uint8_t	ds1307_output_init (void)
	output example init
uint8_t	ds1307_output_deinit (void)
	output example deinit
uint8_t	ds1307_output_set_time (ds1307_time_t *t)
	output example set the time
uint8_t	ds1307_output_set_timestamp (time_t timestamp)
	output example set the time by a unix timestamp
uint8_t	ds1307_output_set_timestamp_time_zone (int8_t zone)
	output example set the local time zone
uint8_t	ds1307_output_get_time (ds1307_time_t *t)
	output example get the time
uint8_t	ds1307_output_get_timestamp (time_t *timestamp)
	output example get the time in a unix timestamp
uint8_t	ds1307_output_get_timestamp_time_zone (int8_t *zone)
	output example get the local time zone
uint8_t	ds1307_output_get_ascii_time (char *buf, uint8_t len)
	output example get the ascii time
uint8_t	ds1307_output_set_mode (ds1307_output_mode_t mode)
	output example set output mode
uint8_t	ds1307_output_get_mode (ds1307_output_mode_t *mode)
	output example get output mode
uint8_t	ds1307_output_set_level (ds1307_output_level_t level)
	output example set output level
uint8_t	ds1307_output_get_level (ds1307_output_level_t *level)
	output example get output level
uint8_t	ds1307_output_set_square_wave_frequency (ds1307_square_wave_frequency_t freq)
	output example set square wave frequency
uint8_t	ds1307_output_get_square_wave_frequency (ds1307_square_wave_frequency_t *freq)
	output example get square wave frequency

Detailed Description

ds1307 example driver modules

Function Documentation

◆ ds1307_basic_deinit()

uint8_t ds1307_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 101 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_get_ascii_time()

uint8_t ds1307_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 267 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_get_time()

uint8_t ds1307_basic_get_time ( ds1307_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 194 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_get_timestamp()

uint8_t ds1307_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 213 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_get_timestamp_time_zone()

uint8_t ds1307_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 251 of file driver_ds1307_basic.c.

◆ ds1307_basic_init()

uint8_t ds1307_basic_init ( void )

basic example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 49 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_read_ram()

uint8_t ds1307_basic_read_ram	(	uint8_t	addr,
		uint8_t *	buf,
		uint8_t	len )

basic example read ram

Parameters

[in]	addr	ram address
[out]	*buf	pointer to a data buffer
[in]	len	buffer length

Returns

status code

0 success
1 read ram failed

Note: none

Definition at line 301 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_set_time()

uint8_t ds1307_basic_set_time ( ds1307_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 119 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_set_timestamp()

uint8_t ds1307_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 138 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_basic_set_timestamp_time_zone()

uint8_t ds1307_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 179 of file driver_ds1307_basic.c.

◆ ds1307_basic_write_ram()

uint8_t ds1307_basic_write_ram	(	uint8_t	addr,
		uint8_t *	buf,
		uint8_t	len )

basic example write ram

Parameters

[in]	addr	ram address
[in]	*buf	pointer to a data buffer
[in]	len	buffer length

Returns

status code

0 success
1 write ram failed

Note: none

Definition at line 321 of file driver_ds1307_basic.c.

Here is the call graph for this function:

◆ ds1307_output_deinit()

uint8_t ds1307_output_deinit ( void )

output example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 101 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_ascii_time()

uint8_t ds1307_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 267 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_level()

uint8_t ds1307_output_get_level ( ds1307_output_level_t * level )

output example get output level

Parameters

[out] *level pointer to an output level buffer

Returns

status code

0 success
1 get level failed

Note: none

Definition at line 356 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_mode()

uint8_t ds1307_output_get_mode ( ds1307_output_mode_t * mode )

output example get output mode

Parameters

[out] *mode pointer to an output mode buffer

Returns

status code

0 success
1 get mode failed

Note: none

Definition at line 318 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_square_wave_frequency()

uint8_t ds1307_output_get_square_wave_frequency ( ds1307_square_wave_frequency_t * freq )

output example get square wave frequency

Parameters

[out] *freq pointer to a square wave frequency buffer

Returns

status code

0 success
1 get square wave frequency failed

Note: none

Definition at line 394 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_time()

uint8_t ds1307_output_get_time ( ds1307_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 194 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_timestamp()

uint8_t ds1307_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 213 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_get_timestamp_time_zone()

uint8_t ds1307_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 251 of file driver_ds1307_output.c.

◆ ds1307_output_init()

uint8_t ds1307_output_init ( void )

output example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 49 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_set_level()

uint8_t ds1307_output_set_level ( ds1307_output_level_t level )

output example set output level

Parameters

[in] level output level

Returns

status code

0 success
1 set level failed

Note: none

Definition at line 337 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_set_mode()

uint8_t ds1307_output_set_mode ( ds1307_output_mode_t mode )

output example set output mode

Parameters

[in] mode output mode

Returns

status code

0 success
1 set mode failed

Note: none

Definition at line 299 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_set_square_wave_frequency()

uint8_t ds1307_output_set_square_wave_frequency ( ds1307_square_wave_frequency_t freq )

output example set square wave frequency

Parameters

[in] freq square wave frequency

Returns

status code

0 success
1 set square wave frequency failed

Note: none

Definition at line 375 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_set_time()

uint8_t ds1307_output_set_time ( ds1307_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 119 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_set_timestamp()

uint8_t ds1307_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 138 of file driver_ds1307_output.c.

Here is the call graph for this function:

◆ ds1307_output_set_timestamp_time_zone()

uint8_t ds1307_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 179 of file driver_ds1307_output.c.

Functions

Detailed Description

Function Documentation

◆ ds1307_basic_deinit()

◆ ds1307_basic_get_ascii_time()

◆ ds1307_basic_get_time()

◆ ds1307_basic_get_timestamp()

◆ ds1307_basic_get_timestamp_time_zone()

◆ ds1307_basic_init()

◆ ds1307_basic_read_ram()

◆ ds1307_basic_set_time()

◆ ds1307_basic_set_timestamp()

◆ ds1307_basic_set_timestamp_time_zone()

◆ ds1307_basic_write_ram()

◆ ds1307_output_deinit()

◆ ds1307_output_get_ascii_time()

◆ ds1307_output_get_level()

◆ ds1307_output_get_mode()

◆ ds1307_output_get_square_wave_frequency()

◆ ds1307_output_get_time()

◆ ds1307_output_get_timestamp()

◆ ds1307_output_get_timestamp_time_zone()

◆ ds1307_output_init()

◆ ds1307_output_set_level()

◆ ds1307_output_set_mode()

◆ ds1307_output_set_square_wave_frequency()

◆ ds1307_output_set_time()

◆ ds1307_output_set_timestamp()

◆ ds1307_output_set_timestamp_time_zone()