pcf8563 example driver modules More...

Collaboration diagram for pcf8563 example driver function:

Data Structures
struct	pcf8563_alarm_param_s
	pcf8563 alarm param structure definition More...

Typedefs
typedef struct pcf8563_alarm_param_s	pcf8563_alarm_param_t
	pcf8563 alarm param structure definition

Functions
uint8_t	pcf8563_alarm_irq_handler (void)
	alarm example irq
uint8_t	pcf8563_alarm_init (void(*callback)(uint8_t type))
	alarm example init
uint8_t	pcf8563_alarm_deinit (void)
	alarm example deinit
uint8_t	pcf8563_alarm_enable (pcf8563_alarm_param_t *param)
	alarm example enable the alarm
uint8_t	pcf8563_alarm_disable (void)
	alarm example disable the alarm
uint8_t	pcf8563_alarm_set_time (pcf8563_time_t *t)
	alarm example set the time
uint8_t	pcf8563_alarm_set_timestamp (time_t timestamp)
	alarm example set the time by a unix timestamp
uint8_t	pcf8563_alarm_set_timestamp_time_zone (int8_t zone)
	alarm example set the local time zone
uint8_t	pcf8563_alarm_get_time (pcf8563_time_t *t)
	alarm example get the time
uint8_t	pcf8563_alarm_get_timestamp (time_t *timestamp)
	alarm example get the time in a unix timestamp
uint8_t	pcf8563_alarm_get_timestamp_time_zone (int8_t *zone)
	alarm example get the local time zone
uint8_t	pcf8563_alarm_get_ascii_time (char *buf, uint8_t len)
	alarm example get the ascii time
uint8_t	pcf8563_basic_init (void)
	basic example init
uint8_t	pcf8563_basic_deinit (void)
	basic example deinit
uint8_t	pcf8563_basic_set_time (pcf8563_time_t *t)
	basic example set the time
uint8_t	pcf8563_basic_set_timestamp (time_t timestamp)
	basic example set the time by a unix timestamp
uint8_t	pcf8563_basic_set_timestamp_time_zone (int8_t zone)
	basic example set the local time zone
uint8_t	pcf8563_basic_get_time (pcf8563_time_t *t)
	basic example get the time
uint8_t	pcf8563_basic_get_timestamp (time_t *timestamp)
	basic example get the time in a unix timestamp
uint8_t	pcf8563_basic_get_timestamp_time_zone (int8_t *zone)
	basic example get the local time zone
uint8_t	pcf8563_basic_get_ascii_time (char *buf, uint8_t len)
	basic example get the ascii time
uint8_t	pcf8563_output_init (void)
	output example init
uint8_t	pcf8563_output_deinit (void)
	output example deinit
uint8_t	pcf8563_output_set_time (pcf8563_time_t *t)
	output example set the time
uint8_t	pcf8563_output_set_timestamp (time_t timestamp)
	output example set the time by a unix timestamp
uint8_t	pcf8563_output_set_timestamp_time_zone (int8_t zone)
	output example set the local time zone
uint8_t	pcf8563_output_get_time (pcf8563_time_t *t)
	output example get the time
uint8_t	pcf8563_output_get_timestamp (time_t *timestamp)
	output example get the time in a unix timestamp
uint8_t	pcf8563_output_get_timestamp_time_zone (int8_t *zone)
	output example get the local time zone
uint8_t	pcf8563_output_get_ascii_time (char *buf, uint8_t len)
	output example get the ascii time
uint8_t	pcf8563_output_enable (pcf8563_clock_out_t clk)
	output example enable the output
uint8_t	pcf8563_output_disable (void)
	output example disable the output
uint8_t	pcf8563_timer_irq_handler (void)
	timer example irq
uint8_t	pcf8563_timer_init (void(*callback)(uint8_t type))
	timer example init
uint8_t	pcf8563_timer_deinit (void)
	timer example deinit
uint8_t	pcf8563_timer_enable (pcf8563_timer_freq_t freq, uint8_t value, pcf8563_interrupt_mode_t mode)
	timer example enable the timer
uint8_t	pcf8563_timer_disable (void)
	timer example disable the timer
uint8_t	pcf8563_timer_set_time (pcf8563_time_t *t)
	timer example set the time
uint8_t	pcf8563_timer_set_timestamp (time_t timestamp)
	timer example set the time by a unix timestamp
uint8_t	pcf8563_timer_set_timestamp_time_zone (int8_t zone)
	timer example set the local time zone
uint8_t	pcf8563_timer_get_time (pcf8563_time_t *t)
	timer example get the time
uint8_t	pcf8563_timer_get_timestamp (time_t *timestamp)
	timer example get the time in a unix timestamp
uint8_t	pcf8563_timer_get_timestamp_time_zone (int8_t *zone)
	timer example get the local time zone
uint8_t	pcf8563_timer_get_ascii_time (char *buf, uint8_t len)
	timer example get the ascii time

Detailed Description

pcf8563 example driver modules

Typedef Documentation

◆ pcf8563_alarm_param_t

typedef struct pcf8563_alarm_param_s pcf8563_alarm_param_t

pcf8563 alarm param structure definition

Function Documentation

◆ pcf8563_alarm_deinit()

uint8_t pcf8563_alarm_deinit ( void )

alarm example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 210 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_disable()

uint8_t pcf8563_alarm_disable ( void )

alarm example disable the alarm

Returns

status code

0 success
1 alarm disable failed

Note: none

Definition at line 477 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_enable()

uint8_t pcf8563_alarm_enable ( pcf8563_alarm_param_t * param )

alarm example enable the alarm

Parameters

[in] *param pointer to a pcf8563_alarm_param_t structure

Returns

status code

0 success
1 alarm enable failed

Note: none

Definition at line 383 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_get_ascii_time()

uint8_t pcf8563_alarm_get_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 360 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_get_time()

uint8_t pcf8563_alarm_get_time ( pcf8563_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 294 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_get_timestamp()

uint8_t pcf8563_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 313 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_get_timestamp_time_zone()

uint8_t pcf8563_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 344 of file driver_pcf8563_alarm.c.

◆ pcf8563_alarm_init()

uint8_t pcf8563_alarm_init ( void(* callback )(uint8_t type) )

alarm example init

Parameters

[in] *callback pointer to a receive callback function address

Returns

status code

0 success
1 init failed

Note: none

Definition at line 67 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_irq_handler()

uint8_t pcf8563_alarm_irq_handler ( void )

alarm example irq

Returns

status code

0 success
1 run failed

Note: none

Definition at line 49 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_set_time()

uint8_t pcf8563_alarm_set_time ( pcf8563_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 228 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_set_timestamp()

uint8_t pcf8563_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 247 of file driver_pcf8563_alarm.c.

Here is the call graph for this function:

◆ pcf8563_alarm_set_timestamp_time_zone()

uint8_t pcf8563_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 279 of file driver_pcf8563_alarm.c.

◆ pcf8563_basic_deinit()

uint8_t pcf8563_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 192 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_get_ascii_time()

uint8_t pcf8563_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 342 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_get_time()

uint8_t pcf8563_basic_get_time ( pcf8563_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 276 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_get_timestamp()

uint8_t pcf8563_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 295 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_get_timestamp_time_zone()

uint8_t pcf8563_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 326 of file driver_pcf8563_basic.c.

◆ pcf8563_basic_init()

uint8_t pcf8563_basic_init ( void )

basic example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 49 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_set_time()

uint8_t pcf8563_basic_set_time ( pcf8563_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 210 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_set_timestamp()

uint8_t pcf8563_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 229 of file driver_pcf8563_basic.c.

Here is the call graph for this function:

◆ pcf8563_basic_set_timestamp_time_zone()

uint8_t pcf8563_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 261 of file driver_pcf8563_basic.c.

◆ pcf8563_output_deinit()

uint8_t pcf8563_output_deinit ( void )

output example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 192 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_disable()

uint8_t pcf8563_output_disable ( void )

output example disable the output

Returns

status code

0 success
1 output disable failed

Note: none

Definition at line 393 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_enable()

uint8_t pcf8563_output_enable ( pcf8563_clock_out_t clk )

output example enable the output

Parameters

[in] clk set clock

Returns

status code

0 success
1 output enable failed

Note: none

Definition at line 365 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_get_ascii_time()

uint8_t pcf8563_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 342 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_get_time()

uint8_t pcf8563_output_get_time ( pcf8563_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 276 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_get_timestamp()

uint8_t pcf8563_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 295 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_get_timestamp_time_zone()

uint8_t pcf8563_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 326 of file driver_pcf8563_output.c.

◆ pcf8563_output_init()

uint8_t pcf8563_output_init ( void )

output example init

Returns

status code

0 success
1 init failed

Note: none

Definition at line 49 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_set_time()

uint8_t pcf8563_output_set_time ( pcf8563_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 210 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_set_timestamp()

uint8_t pcf8563_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 229 of file driver_pcf8563_output.c.

Here is the call graph for this function:

◆ pcf8563_output_set_timestamp_time_zone()

uint8_t pcf8563_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 261 of file driver_pcf8563_output.c.

◆ pcf8563_timer_deinit()

uint8_t pcf8563_timer_deinit ( void )

timer example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 210 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_disable()

uint8_t pcf8563_timer_disable ( void )

timer example disable the timer

Returns

status code

0 success
1 timer disable failed

Note: none

Definition at line 440 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_enable()

uint8_t pcf8563_timer_enable	(	pcf8563_timer_freq_t	freq,
		uint8_t	value,
		pcf8563_interrupt_mode_t	mode )

timer example enable the timer

Parameters

[in]	freq	set freq
[in]	value	set value
[in]	mode	set interrupt mode

Returns

status code

0 success
1 timer enable failed

Note: none

Definition at line 385 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_get_ascii_time()

uint8_t pcf8563_timer_get_ascii_time	(	char *	buf,
		uint8_t	len )

timer 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_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_get_time()

uint8_t pcf8563_timer_get_time ( pcf8563_time_t * t )

timer 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 294 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_get_timestamp()

uint8_t pcf8563_timer_get_timestamp ( time_t * timestamp )

timer 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 313 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_get_timestamp_time_zone()

uint8_t pcf8563_timer_get_timestamp_time_zone ( int8_t * zone )

timer 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 344 of file driver_pcf8563_timer.c.

◆ pcf8563_timer_init()

uint8_t pcf8563_timer_init ( void(* callback )(uint8_t type) )

timer example init

Parameters

[in] *callback pointer to a receive callback function address

Returns

status code

0 success
1 init failed

Note: none

Definition at line 67 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_irq_handler()

uint8_t pcf8563_timer_irq_handler ( void )

timer example irq

Returns

status code

0 success
1 run failed

Note: none

Definition at line 49 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_set_time()

uint8_t pcf8563_timer_set_time ( pcf8563_time_t * t )

timer 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 228 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_set_timestamp()

uint8_t pcf8563_timer_set_timestamp ( time_t timestamp )

timer 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 247 of file driver_pcf8563_timer.c.

Here is the call graph for this function:

◆ pcf8563_timer_set_timestamp_time_zone()

uint8_t pcf8563_timer_set_timestamp_time_zone ( int8_t zone )

timer example set the local time zone

Parameters

[in] zone local time zone

Returns

status code

0 success

Note: none

Definition at line 279 of file driver_pcf8563_timer.c.

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ pcf8563_alarm_param_t

Function Documentation

◆ pcf8563_alarm_deinit()

◆ pcf8563_alarm_disable()

◆ pcf8563_alarm_enable()

◆ pcf8563_alarm_get_ascii_time()

◆ pcf8563_alarm_get_time()

◆ pcf8563_alarm_get_timestamp()

◆ pcf8563_alarm_get_timestamp_time_zone()

◆ pcf8563_alarm_init()

◆ pcf8563_alarm_irq_handler()

◆ pcf8563_alarm_set_time()

◆ pcf8563_alarm_set_timestamp()

◆ pcf8563_alarm_set_timestamp_time_zone()

◆ pcf8563_basic_deinit()

◆ pcf8563_basic_get_ascii_time()

◆ pcf8563_basic_get_time()

◆ pcf8563_basic_get_timestamp()

◆ pcf8563_basic_get_timestamp_time_zone()

◆ pcf8563_basic_init()

◆ pcf8563_basic_set_time()

◆ pcf8563_basic_set_timestamp()

◆ pcf8563_basic_set_timestamp_time_zone()

◆ pcf8563_output_deinit()

◆ pcf8563_output_disable()

◆ pcf8563_output_enable()

◆ pcf8563_output_get_ascii_time()

◆ pcf8563_output_get_time()

◆ pcf8563_output_get_timestamp()

◆ pcf8563_output_get_timestamp_time_zone()

◆ pcf8563_output_init()

◆ pcf8563_output_set_time()

◆ pcf8563_output_set_timestamp()

◆ pcf8563_output_set_timestamp_time_zone()

◆ pcf8563_timer_deinit()

◆ pcf8563_timer_disable()

◆ pcf8563_timer_enable()

◆ pcf8563_timer_get_ascii_time()

◆ pcf8563_timer_get_time()

◆ pcf8563_timer_get_timestamp()

◆ pcf8563_timer_get_timestamp_time_zone()

◆ pcf8563_timer_init()

◆ pcf8563_timer_irq_handler()

◆ pcf8563_timer_set_time()

◆ pcf8563_timer_set_timestamp()

◆ pcf8563_timer_set_timestamp_time_zone()