ds1302 example driver modules More...

Collaboration diagram for ds1302 example driver function:

Enumerations
enum	ds1302_burst_type_t { DS1302_BURST_TYPE_CLOCK = 0x00 , DS1302_BURST_TYPE_RAM = 0x01 }
	ds1302 burst type enumeration definition More...

Functions
uint8_t	ds1302_advance_init (void)
	advance example init
uint8_t	ds1302_advance_deinit (void)
	advance example deinit
uint8_t	ds1302_advance_set_time (ds1302_time_t *t)
	advance example set the time
uint8_t	ds1302_advance_set_timestamp (time_t timestamp)
	advance example set the time by a unix timestamp
uint8_t	ds1302_advance_set_timestamp_time_zone (int8_t zone)
	advance example set the local time zone
uint8_t	ds1302_advance_get_time (ds1302_time_t *t)
	advance example get the time
uint8_t	ds1302_advance_get_timestamp (time_t *timestamp)
	advance example get the time in a unix timestamp
uint8_t	ds1302_advance_get_timestamp_time_zone (int8_t *zone)
	advance example get the local time zone
uint8_t	ds1302_advance_get_ascii_time (char *buf, uint8_t len)
	advance example get the ascii time
uint8_t	ds1302_advance_read_ram (uint8_t addr, uint8_t *buf, uint8_t len)
	advance example read ram
uint8_t	ds1302_advance_write_ram (uint8_t addr, uint8_t *buf, uint8_t len)
	advance example write ram
uint8_t	ds1302_advance_set_charge (uint8_t charge)
	advance example set charge
uint8_t	ds1302_advance_get_charge (uint8_t *charge)
	advance example get charge
uint8_t	ds1302_advance_burst_write (ds1302_burst_type_t type, uint8_t *buf, uint8_t len)
	advance example burst write
uint8_t	ds1302_advance_burst_read (ds1302_burst_type_t type, uint8_t *buf, uint8_t len)
	advance example burst read
uint8_t	ds1302_basic_init (void)
	basic example init
uint8_t	ds1302_basic_deinit (void)
	basic example deinit
uint8_t	ds1302_basic_set_time (ds1302_time_t *t)
	basic example set the time
uint8_t	ds1302_basic_set_timestamp (time_t timestamp)
	basic example set the time by a unix timestamp
uint8_t	ds1302_basic_set_timestamp_time_zone (int8_t zone)
	basic example set the local time zone
uint8_t	ds1302_basic_get_time (ds1302_time_t *t)
	basic example get the time
uint8_t	ds1302_basic_get_timestamp (time_t *timestamp)
	basic example get the time in a unix timestamp
uint8_t	ds1302_basic_get_timestamp_time_zone (int8_t *zone)
	basic example get the local time zone
uint8_t	ds1302_basic_get_ascii_time (char *buf, uint8_t len)
	basic example get the ascii time
uint8_t	ds1302_basic_read_ram (uint8_t addr, uint8_t *buf, uint8_t len)
	basic example read ram
uint8_t	ds1302_basic_write_ram (uint8_t addr, uint8_t *buf, uint8_t len)
	basic example write ram

Detailed Description

ds1302 example driver modules

Enumeration Type Documentation

◆ ds1302_burst_type_t

enum ds1302_burst_type_t

ds1302 burst type enumeration definition

Enumerator
DS1302_BURST_TYPE_CLOCK	clock burst type
DS1302_BURST_TYPE_RAM	ram burst type

Definition at line 55 of file driver_ds1302_advance.h.

Function Documentation

◆ ds1302_advance_burst_read()

uint8_t ds1302_advance_burst_read	(	ds1302_burst_type_t	type,
		uint8_t *	buf,
		uint8_t	len )

advance example burst read

Parameters

[in]	type	burst type
[out]	*buf	pointer to a data buffer
[in]	len	data buffer length

Returns

status code

0 success
1 burst read failed

Note: none

Definition at line 418 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_burst_write()

uint8_t ds1302_advance_burst_write	(	ds1302_burst_type_t	type,
		uint8_t *	buf,
		uint8_t	len )

advance example burst write

Parameters

[in]	type	burst type
[in]	*buf	pointer to a data buffer
[in]	len	data buffer length

Returns

status code

0 success
1 burst write failed

Note: none

Definition at line 386 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_deinit()

uint8_t ds1302_advance_deinit ( void )

advance example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 108 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_get_ascii_time()

uint8_t ds1302_advance_get_ascii_time	(	char *	buf,
		uint8_t	len )

advance 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 274 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_get_charge()

uint8_t ds1302_advance_get_charge ( uint8_t * charge )

advance example get charge

Parameters

[out] *charge pointer to a charge buffer

Returns

status code

0 success
1 get charge failed

Note: none

Definition at line 366 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_get_time()

uint8_t ds1302_advance_get_time ( ds1302_time_t * t )

advance 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 201 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_get_timestamp()

uint8_t ds1302_advance_get_timestamp ( time_t * timestamp )

advance 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 220 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_get_timestamp_time_zone()

uint8_t ds1302_advance_get_timestamp_time_zone ( int8_t * zone )

advance 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 258 of file driver_ds1302_advance.c.

◆ ds1302_advance_init()

uint8_t ds1302_advance_init ( void )

advance example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 49 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_read_ram()

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

advance 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 308 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_set_charge()

uint8_t ds1302_advance_set_charge ( uint8_t charge )

advance example set charge

Parameters

[in] charge charge mode

Returns

status code

0 success
1 set charge failed

Note: charge: DS1302_CHARGE_DISABLE DS1302_CHARGE_ENABLE | (DS1302_CHARGE_1_DIODE or DS1302_CHARGE_2_DIODE) | (DS1302_CHARGE_2K or DS1302_CHARGE_4K or DS1302_CHARGE_8K)

Definition at line 348 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_set_time()

uint8_t ds1302_advance_set_time ( ds1302_time_t * t )

advance 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 126 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_set_timestamp()

uint8_t ds1302_advance_set_timestamp ( time_t timestamp )

advance 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 145 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_advance_set_timestamp_time_zone()

uint8_t ds1302_advance_set_timestamp_time_zone ( int8_t zone )

advance example set the local time zone

Parameters

[in] zone local time zone

Returns

status code

0 success

Note: none

Definition at line 186 of file driver_ds1302_advance.c.

◆ ds1302_advance_write_ram()

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

advance 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 328 of file driver_ds1302_advance.c.

Here is the call graph for this function:

◆ ds1302_basic_deinit()

uint8_t ds1302_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 108 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_get_ascii_time()

uint8_t ds1302_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 274 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_get_time()

uint8_t ds1302_basic_get_time ( ds1302_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 201 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_get_timestamp()

uint8_t ds1302_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 220 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_get_timestamp_time_zone()

uint8_t ds1302_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 258 of file driver_ds1302_basic.c.

◆ ds1302_basic_init()

uint8_t ds1302_basic_init ( void )

basic example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 49 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_read_ram()

uint8_t ds1302_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 308 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_set_time()

uint8_t ds1302_basic_set_time ( ds1302_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 126 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_set_timestamp()

uint8_t ds1302_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 145 of file driver_ds1302_basic.c.

Here is the call graph for this function:

◆ ds1302_basic_set_timestamp_time_zone()

uint8_t ds1302_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 186 of file driver_ds1302_basic.c.

◆ ds1302_basic_write_ram()

uint8_t ds1302_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 328 of file driver_ds1302_basic.c.

Here is the call graph for this function:

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ds1302_burst_type_t

Function Documentation

◆ ds1302_advance_burst_read()

◆ ds1302_advance_burst_write()

◆ ds1302_advance_deinit()

◆ ds1302_advance_get_ascii_time()

◆ ds1302_advance_get_charge()

◆ ds1302_advance_get_time()

◆ ds1302_advance_get_timestamp()

◆ ds1302_advance_get_timestamp_time_zone()

◆ ds1302_advance_init()

◆ ds1302_advance_read_ram()

◆ ds1302_advance_set_charge()

◆ ds1302_advance_set_time()

◆ ds1302_advance_set_timestamp()

◆ ds1302_advance_set_timestamp_time_zone()

◆ ds1302_advance_write_ram()

◆ ds1302_basic_deinit()

◆ ds1302_basic_get_ascii_time()

◆ ds1302_basic_get_time()

◆ ds1302_basic_get_timestamp()

◆ ds1302_basic_get_timestamp_time_zone()

◆ ds1302_basic_init()

◆ ds1302_basic_read_ram()

◆ ds1302_basic_set_time()

◆ ds1302_basic_set_timestamp()

◆ ds1302_basic_set_timestamp_time_zone()

◆ ds1302_basic_write_ram()