RTC_NXP_Arduino: PCF85063_base Class Reference

RTC_NXP_Arduino 1.1.1

RTC driver device operation sample code for Arduino

Loading...

Searching...

No Matches

Inheritance diagram for PCF85063_base:

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 RTC_NXP
enum	board { NONE , ARDUINO_SHIELD }

enum	alarm_setting { SECOND , MINUTE , HOUR , DAY , WEEKDAY }

Public Member Functions
	PCF85063_base ()

virtual	~PCF85063_base ()

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)

Public Member Functions inherited from RTC_NXP
	RTC_NXP ()

virtual	~RTC_NXP ()

time_t	time (time_t *tp)

Protected Member Functions
time_t	rtc_time (void)

virtual void	_reg_w (uint8_t reg, uint8_t *vp, int len)=0

virtual void	_reg_r (uint8_t reg, uint8_t *vp, int len)=0

virtual void	_reg_w (uint8_t reg, uint8_t val)=0

virtual uint8_t	_reg_r (uint8_t reg)=0

virtual void	_bit_op8 (uint8_t reg, uint8_t mask, uint8_t val)=0

Protected Member Functions inherited from RTC_NXP

Additional Inherited Members
Static Protected Member Functions inherited from RTC_NXP
static uint8_t	bcd2dec (uint8_t v)

static uint8_t	dec2bcd (uint8_t v)

Detailed Description

Definition at line 740 of file RTC_NXP.h.

Member Enumeration Documentation

◆ reg_num

enum PCF85063_base::reg_num

Name of the PCF85063 registers

Definition at line 744 of file RTC_NXP.h.

Constructor & Destructor Documentation

◆ PCF85063_base()

PCF85063_base::PCF85063_base ( )

Constructor

Definition at line 3 of file PCF85063A.cpp.

◆ ~PCF85063_base()

PCF85063_base::~PCF85063_base ( )

virtual

Destructor

Definition at line 7 of file PCF85063A.cpp.

Member Function Documentation

◆ _bit_op8()

virtual void PCF85063_base::_bit_op8	(	uint8_t	reg,
		uint8_t	mask,
		uint8_t	val )

protectedpure virtual

Proxy method for interface (pure virtual method)

Referenced by alarm(), alarm_disable(), and set().

◆ _reg_r() [1/2]

virtual uint8_t PCF85063_base::_reg_r ( uint8_t reg )

protectedpure virtual

Proxy method for interface (pure virtual method)

◆ _reg_r() [2/2]

virtual void PCF85063_base::_reg_r	(	uint8_t	reg,
		uint8_t *	vp,
		int	len )

protectedpure virtual

Proxy method for interface (pure virtual method)

Referenced by int_clear(), oscillator_stop(), and rtc_time().

◆ _reg_w() [1/2]

virtual void PCF85063_base::_reg_w	(	uint8_t	reg,
		uint8_t *	vp,
		int	len )

protectedpure virtual

Proxy method for interface (pure virtual method)

Referenced by alarm(), int_clear(), set(), and timer().

◆ _reg_w() [2/2]

virtual void PCF85063_base::_reg_w	(	uint8_t	reg,
		uint8_t	val )

protectedpure virtual

Proxy method for interface (pure virtual method)

◆ alarm()

void PCF85063_base::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

Implements RTC_NXP.

Reimplemented in PCF85063A.

Definition at line 43 of file PCF85063A.cpp.

◆ alarm_clear()

void PCF85063_base::alarm_clear ( void )

virtual

Alarm clearing

Implements RTC_NXP.

Reimplemented in PCF85063A.

Definition at line 50 of file PCF85063A.cpp.

◆ alarm_disable()

void PCF85063_base::alarm_disable ( void )

virtual

Alarm interrupt disable

Implements RTC_NXP.

Reimplemented in PCF85063A.

Definition at line 55 of file PCF85063A.cpp.

◆ begin()

void PCF85063_base::begin ( void )

virtual

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

Implements RTC_NXP.

Reimplemented in PCF85063A, and PCF85063TP.

Definition at line 11 of file PCF85063A.cpp.

◆ int_clear()

uint8_t PCF85063_base::int_clear ( void )

virtual

Interrupt clear

Implements RTC_NXP.

Reimplemented in PCF85063A.

Definition at line 60 of file PCF85063A.cpp.

◆ oscillator_stop()

bool PCF85063_base::oscillator_stop ( void )

virtual

Detector for oscillation stop

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

Implements RTC_NXP.

Reimplemented in PCF85063A, and PCF85063TP.

Definition at line 38 of file PCF85063A.cpp.

◆ rtc_time()

time_t PCF85063_base::rtc_time ( void )

protectedvirtual

rtc_time

Returns: time_t returns RTC time in time_t format

Implements RTC_NXP.

Definition at line 100 of file PCF85063A.cpp.

◆ set()

void PCF85063_base::set ( struct tm * now_tm )

virtual

set

Parameters

now_tm struct to set calendar and time in RTC

Implements RTC_NXP.

Reimplemented in PCF85063A, and PCF85063TP.

Definition at line 15 of file PCF85063A.cpp.

◆ timer()

float PCF85063_base::timer ( float period )

Timer setting

Parameters

period timer interval in second

Returns: actual timer set value in second

Definition at line 68 of file PCF85063A.cpp.

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