PCF85063A Class Reference

#include <RTC_NXP.h>

Inheritance diagram for PCF85063A:

Public Types
enum	reg_num {   Control_1 , Control_2 , Offset , RAM_byte ,   Seconds , Minutes , Hours , Days ,   Weekdays , Months , Years , Second_alarm ,   Minute_alarm , Hour_alarm , Day_alarm , Weekday_alarm ,   Timer_value , Timer_mode }
Public Types inherited from PCF85063_base
enum	reg_num {   Control_1 , Control_2 , Offset , RAM_byte ,   Seconds , Minutes , Hours , Days ,   Weekdays , Months , Years , Second_alarm ,   Minute_alarm , Hour_alarm , Day_alarm , Weekday_alarm ,   Timer_value , Timer_mode }
Public Types inherited from RTC_NXP
enum	board { NONE , ARDUINO_SHIELD }
enum	alarm_setting {   SECOND , MINUTE , HOUR , DAY ,   WEEKDAY }

Public Member Functions
	PCF85063A (uint8_t i2c_address=(0xA2 > > 1))
	PCF85063A (TwoWire &wire, uint8_t i2c_address=(0xA2 > > 1))
virtual	~PCF85063A ()
time_t	time (time_t *tp)
void	begin (void)
void	set (struct tm *now_tm)
bool	oscillator_stop (void)
void	alarm (alarm_setting digit, int val)
void	alarm_clear (void)
void	alarm_disable (void)
uint8_t	int_clear (void)
float	timer (float period)
void	reg_w (uint8_t reg_adr, uint8_t *data, int size)
void	reg_w (uint8_t reg_adr, uint8_t data)
void	reg_r (uint8_t reg_adr, uint8_t *data, int size)
uint8_t	reg_r (uint8_t reg_adr)
void	write_r8 (uint8_t reg, uint8_t val)
uint8_t	read_r8 (uint8_t reg)
void	bit_op8 (uint8_t reg, uint8_t mask, uint8_t value)
Public Member Functions inherited from PCF85063_base
	PCF85063_base ()
virtual	~PCF85063_base ()
float	timer (float period)
Public Member Functions inherited from RTC_NXP
	RTC_NXP ()
virtual	~RTC_NXP ()
time_t	time (time_t *tp)

Additional Inherited Members
Protected Member Functions inherited from PCF85063_base
time_t	rtc_time (void)
Protected Member Functions inherited from RTC_NXP
Static Protected Member Functions inherited from RTC_NXP
static uint8_t	bcd2dec (uint8_t v)
static uint8_t	dec2bcd (uint8_t v)

Detailed Description

PCF85063A class

PCF85063A class driver

Definition at line 826 of file RTC_NXP.h.

Member Enumeration Documentation

reg_num

enum PCF85063A::reg_num

Name of the PCF85063A registers

Definition at line 847 of file RTC_NXP.h.

Constructor & Destructor Documentation

PCF85063A() [1/2]

PCF85063A::PCF85063A

(

uint8_t

i2c_address = (0xA2 >> 1)

)

Create a PCF85063A instance with specified address

Parameters

i2c_address

I2C-bus address (default: (0xBC>>1))

Definition at line 120 of file PCF85063A.cpp.

PCF85063A() [2/2]

PCF85063A::PCF85063A	(	TwoWire &	wire,
		uint8_t	i2c_address = (0xA2 >> 1) )

Create a PCF85063A instance connected to specified I2C pins with specified address

Parameters

wire	TwoWire instance
i2c_address	I2C-bus address (default: (0xBC>>1))

Definition at line 124 of file PCF85063A.cpp.

~PCF85063A()

PCF85063A::~PCF85063A ( )

virtual

Destructor

Definition at line 128 of file PCF85063A.cpp.

Member Function Documentation

alarm()

void PCF85063A::alarm ( alarm_setting digit, int val )

virtual

Alarm setting

Parameters

digit	to specify which parameter to set: SECOND, MINUTE, HOUR, DAY, WEEKDAY in 'enum alarm_setting'
val	Setting value. Set 0x80 to disabling

Reimplemented from PCF85063_base.

alarm_clear()

void PCF85063A::alarm_clear ( void )

virtual

Alarm clearing

Reimplemented from PCF85063_base.

alarm_disable()

void PCF85063A::alarm_disable ( void )

virtual

Alarm interrupt disable

Reimplemented from PCF85063_base.

begin()

void PCF85063A::begin ( void )

virtual

Initializer but nothing done with this menthod in this version. Don't need to call

Reimplemented from PCF85063_base.

Reimplemented in PCF85063TP.

bit_op8()

void PCF85063A::bit_op8	(	uint8_t	reg,
		uint8_t	mask,
		uint8_t	value )

Register overwriting with bit-mask

Register can be updated by bit level

Parameters

reg	register index/address/pointer
mask	bit-mask to protect overwriting
value	value to overwrite

int_clear()

uint8_t PCF85063A::int_clear ( void )

virtual

Interrupt clear

Reimplemented from PCF85063_base.

oscillator_stop()

bool PCF85063A::oscillator_stop ( void )

virtual

Detector for oscillation stop

Returns

true, if the OSF (Oscillator Stop Flag) is set

Reimplemented from PCF85063_base.

Reimplemented in PCF85063TP.

read_r8()

uint8_t PCF85063A::read_r8

(

uint8_t

reg

)

Register read, 8 bit

Parameters

reg	register index/address/pointer

Returns

data value

reg_r() [1/2]

uint8_t PCF85063A::reg_r

(

uint8_t

reg_adr

)

Single register read

Parameters

reg	register index/address/pointer

Returns

read data

reg_r() [2/2]

void PCF85063A::reg_r	(	uint8_t	reg_adr,
		uint8_t *	data,
		int	size )

Multiple register read

Parameters

reg	register index/address/pointer
data	pointer to data buffer
size	data size

Returns

transferred data size

reg_w() [1/2]

void PCF85063A::reg_w	(	uint8_t	reg_adr,
		uint8_t *	data,
		int	size )

Multiple register write

Parameters

reg	register index/address/pointer
data	pointer to data buffer
size	data size

Returns

transferred data size

reg_w() [2/2]

void PCF85063A::reg_w	(	uint8_t	reg_adr,
		uint8_t	data )

Single register write

Parameters

reg	register index/address/pointer
data	pointer to data buffer
size	data size

Returns

transferred data size

set()

void PCF85063A::set ( struct tm * now_tm )

virtual

set

Parameters

now_tm

struct to set calendar and time in RTC

Reimplemented from PCF85063_base.

Reimplemented in PCF85063TP.

time()

time_t PCF85063A::time

(

time_t *

tp

)

time

"time()" in "time.h" compatible method for RTC

Parameters

tp	pointer to time_t variable

Returns

time_t value of current time

timer()

float PCF85063A::timer

(

float

period

)

Timer setting

Parameters

period

timer interval in second

Returns

actual timer set value in second

write_r8()

void PCF85063A::write_r8	(	uint8_t	reg,
		uint8_t	val )

Register write, 8 bit

Parameters

reg	register index/address/pointer
val	data value

---

The documentation for this class was generated from the following files:

• RTC_NXP.h
• PCF85063A.cpp