Driver for the PCF8563 real-time clock (RTC) over I2C. More...

#include <SensorPCF8563.hpp>

Inheritance diagram for SensorPCF8563:

Public Types
enum	ClockHz { CLK_32768HZ , CLK_1024HZ , CLK_32HZ , CLK_1HZ , CLK_DISABLE }
	Clock output frequencies for the CLKOUT pin. More...

Public Member Functions
	SensorPCF8563 ()=default
	Construct a PCF8563 driver instance.

	~SensorPCF8563 ()=default
	Destructor.

bool	begin (SensorCommCustom::CustomCallback callback)
	Initialize the device using a user-provided transport callback.

void	setDateTime (RTC_DateTime datetime) override
	Set the RTC date/time.

RTC_DateTime	getDateTime () override
	Get the current RTC date/time.

bool	isClockIntegrityGuaranteed ()
	Check whether the clock integrity is guaranteed.

RTC_Alarm	getAlarm ()
	Read the currently configured alarm settings.

void	enableAlarm ()
	Enable the alarm interrupt.

void	disableAlarm ()
	Disable the alarm interrupt.

void	resetAlarm ()
	Clear the alarm flag.

bool	isAlarmActive ()
	Check whether the alarm flag is active.

void	setAlarm (RTC_Alarm alarm)
	Set the alarm configuration.

void	setAlarm (uint8_t hour, uint8_t minute, uint8_t day, uint8_t week)
	Set the alarm configuration.

void	setAlarmByMinutes (uint8_t minute)
	Convenience API to set an alarm that matches only minutes.

void	setAlarmByDays (uint8_t day)
	Convenience API to set an alarm that matches only day-of-month.

void	setAlarmByHours (uint8_t hour)
	Convenience API to set an alarm that matches only hours.

void	setAlarmByWeekDay (uint8_t week)
	Convenience API to set an alarm that matches only weekday.

bool	isCountdownTimerEnable ()
	Check whether the countdown timer is enabled.

bool	isCountdownTimerActive ()
	Check whether the countdown timer flag is active.

void	enableCountdownTimer ()
	Enable the countdown timer interrupt.

void	disableCountdownTimer ()
	Disable the countdown timer interrupt.

void	setCountdownTimer (uint8_t val, uint8_t freq)
	Configure countdown timer.

void	clearCountdownTimer ()
	Clear and disable the countdown timer.

void	setClockOutput (ClockHz freq)
	Configure the clock output (CLKOUT) pin.

const char *	getChipName () override
	Get the chip name string.

void	reset () override
	Reset the RTC.

virtual void	setDateTime (RTC_DateTime datetime)=0
	Set the date and time of the RTC using an RTC_DateTime object.

void	setDateTime (uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)
	Set the date and time of the RTC using individual values.

virtual RTC_DateTime	getDateTime ()=0
	Get the current date and time from the RTC.

void	getDateTime (struct tm *info)
	Retrieve the current date and time from the RTC (Real-Time Clock) and populate a struct tm object.

bool	begin (SensorCommCustom::CustomCallback callback, uint8_t addr)
	Initialize the sensor using custom callback interface.

Public Member Functions inherited from SensorRTC
void	getDateTime (struct tm *info)
	Retrieve the current date and time from the RTC (Real-Time Clock) and populate a struct tm object.

void	setDateTime (uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)
	Set the date and time of the RTC using individual values.

const char *	strftime (DateTimeFormat style=DT_FMT_YMD_HMS_WEEK)
	Format the current date and time according to the specified style.

time_t	hwClockRead (const timezone *tz=NULL)
	Read the time from the RTC (Real-Time Clock) and write it to the system clock.

int	hwClockWrite ()
	Write the current system time to the RTC clock chip.

uint32_t	getDayOfWeek (uint32_t day, uint32_t month, uint32_t year)
	Calculate the day of the week for a given date using Zeller's congruence.

uint8_t	getNextMonth (uint8_t curMonth)
	Get the next month based on the current month.

uint16_t	getNextYear (uint16_t curYear)
	Get the next year based on the current year.

uint32_t	getLeapYear (uint32_t year)
	Determine whether a given year is a leap year.

uint8_t	getDaysInMonth (uint8_t month, uint16_t year)
	Get the number of days in a given month of a specific year, considering leap years.

void	convertUtcToTimezone (int &year, int &month, int &day, int &hour, int &minute, int &second, int timezoneOffsetSeconds)
	Convert UTC time represented by individual values to the time in the specified timezone.

void	convertUtcToTimezone (struct tm &utcTime, int timezoneOffsetSeconds)
	Overloaded function to convert UTC time represented by a struct tm object to the time in the specified timezone.

Public Member Functions inherited from I2CDeviceNoHal
bool	begin (SensorCommCustom::CustomCallback callback, uint8_t addr)
	Initialize the sensor using custom callback interface.

Public Member Functions inherited from DeviceBeginCommon
virtual	~DeviceBeginCommon ()

uint8_t	getAddress () const

uint8_t	getInterface () const

Public Member Functions inherited from SensorCommWrapper
	SensorCommWrapper ()=default

int	readReg (uint8_t reg) const

int	readRegBuff (uint8_t reg, uint8_t *buf, size_t len) const

int	readBuff (uint8_t *buf, size_t len) const

int	writeReg (uint8_t reg, uint8_t val)

int	writeRegBuff (uint8_t reg, uint8_t *buf, size_t len)

int	writeBuff (uint8_t *buf, size_t len)

int	writeThenRead (const uint8_t write_buffer, size_t write_len, uint8_t read_buffer, size_t read_len)

bool	setRegBit (uint8_t reg, uint8_t bit)

bool	clrRegBit (uint8_t reg, uint8_t bit)

bool	getRegBit (uint8_t reg, uint8_t bit)

int	updateBits (uint8_t reg, uint8_t mask, uint8_t value_shifted)

void	setAddress (uint8_t address)

void	setAck (bool enable)

Public Member Functions inherited from SensorCommInterface
virtual	~SensorCommInterface ()=default

Static Protected Attributes
static constexpr uint8_t	STAT1_REG = 0x00

static constexpr uint8_t	STAT2_REG = 0x01

static constexpr uint8_t	SEC_REG = 0x02

static constexpr uint8_t	MIN_REG = 0x03

static constexpr uint8_t	HR_REG = 0x04

static constexpr uint8_t	DAY_REG = 0x05

static constexpr uint8_t	WEEKDAY_REG = 0x06

static constexpr uint8_t	MONTH_REG = 0x07

static constexpr uint8_t	YEAR_REG = 0x08

static constexpr uint8_t	ALRM_MIN_REG = 0x09

static constexpr uint8_t	SQW_REG = 0x0D

static constexpr uint8_t	TIMER1_REG = 0x0E

static constexpr uint8_t	TIMER2_REG = 0x0F

static constexpr uint8_t	VOL_LOW_MASK = 0x80

static constexpr uint8_t	MINUTES_MASK = 0x7F

static constexpr uint8_t	HOUR_MASK = 0x3F

static constexpr uint8_t	WEEKDAY_MASK = 0x07

static constexpr uint8_t	CENTURY_MASK = 0x80

static constexpr uint8_t	DAY_MASK = 0x3F

static constexpr uint8_t	MONTH_MASK = 0x1F

static constexpr uint8_t	TIMER_CTL_MASK = 0x03

static constexpr uint8_t	ALARM_AF = 0x08

static constexpr uint8_t	TIMER_TF = 0x04

static constexpr uint8_t	ALARM_AIE = 0x02

static constexpr uint8_t	TIMER_TIE = 0x01

static constexpr uint8_t	TIMER_TE = 0x80

static constexpr uint8_t	TIMER_TD10 = 0x03

static constexpr uint8_t	NO_ALARM = 0xFF

static constexpr uint8_t	ALARM_ENABLE = 0x80

static constexpr uint8_t	CLK_ENABLE = 0x80

Additional Inherited Members
Static Public Member Functions inherited from SensorRTC
static uint8_t	BCD2DEC (uint8_t val)
	Convert a Binary Coded Decimal (BCD) number to a decimal number.

static uint8_t	DEC2BCD (uint8_t val)
	Convert a decimal number to a Binary Coded Decimal (BCD) number.

Protected Member Functions inherited from DeviceBeginCommon
	DeviceBeginCommon ()=default

virtual bool	ensureValid () const override

virtual SensorCommBase *	getComm () const override

virtual void	beforeBegin ()

virtual void	afterCommReady ()

virtual void	afterInitSuccess (uint8_t param)

virtual void	onBeginFail ()

bool	fail ()

void	clearCommState ()

template<typename CreateComm >
bool	beginLifecycle (uint8_t addr, uint8_t iface, uint8_t initParam, CreateComm createComm)

Protected Attributes inherited from DeviceBeginCommon
std::unique_ptr< SensorCommBase >	comm

std::unique_ptr< SensorHal >	hal

std::unique_ptr< SensorCommStatic >	staticComm

uint8_t	_addr = 0

uint8_t	_iface = COMM_CUSTOM

Detailed Description

Driver for the PCF8563 real-time clock (RTC) over I2C.

Definition at line 49 of file time/pcf8563/SensorPCF8563.hpp.

Member Enumeration Documentation

◆ ClockHz

enum SensorPCF8563::ClockHz

Clock output frequencies for the CLKOUT pin.

Enumerator
CLK_32768HZ	32.768 kHz output
CLK_1024HZ	1.024 kHz output
CLK_32HZ	32 Hz output
CLK_1HZ	1 Hz output
CLK_DISABLE	Disable CLKOUT.

Definition at line 59 of file time/pcf8563/SensorPCF8563.hpp.

Constructor & Destructor Documentation

◆ SensorPCF8563()

SensorPCF8563::SensorPCF8563 ( )

default

Construct a PCF8563 driver instance.

◆ ~SensorPCF8563()

SensorPCF8563::~SensorPCF8563 ( )

default

Destructor.

Deinitializes the underlying communication bus if it has been created.

References I2CDeviceNoHal::begin().

Member Function Documentation

◆ begin() [1/2]

bool SensorPCF8563::begin ( SensorCommCustom::CustomCallback callback )

inlinevirtual

Initialize the device using a user-provided transport callback.

Parameters

callback Custom communication callback.

Returns: true if initialization succeeds.

Implements SensorRTC.

Definition at line 127 of file time/pcf8563/SensorPCF8563.hpp.

References I2CDeviceNoHal::begin().

Referenced by setup().

◆ begin() [2/2]

bool I2CDeviceNoHal::begin	(	SensorCommCustom::CustomCallback	callback,
		uint8_t	addr
	)

inline

Initialize the sensor using custom callback interface.

Note: Suitable for other platforms not covered by standard implementations.

Parameters

interface	Communication interface type (COMM_SPI or COMM_I2C).
callback	Register read/write callback function.
addr	Device address

Returns: True if initialization is successful, false otherwise.

Definition at line 94 of file I2CDeviceNoHal.hpp.

◆ clearCountdownTimer()

void SensorPCF8563::clearCountdownTimer ( )

inline

Clear and disable the countdown timer.

Definition at line 412 of file time/pcf8563/SensorPCF8563.hpp.

References ALARM_AF, SensorCommWrapper::readReg(), STAT2_REG, TIMER1_REG, TIMER_TF, TIMER_TIE, and SensorCommWrapper::writeReg().

◆ disableAlarm()

void SensorPCF8563::disableAlarm ( )

inline

Disable the alarm interrupt.

Definition at line 227 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::clrRegBit(), and STAT2_REG.

◆ disableCountdownTimer()

void SensorPCF8563::disableCountdownTimer ( )

inline

Disable the countdown timer interrupt.

Definition at line 388 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::clrRegBit(), and STAT2_REG.

◆ enableAlarm()

void SensorPCF8563::enableAlarm ( )

inline

Enable the alarm interrupt.

Definition at line 219 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::setRegBit(), and STAT2_REG.

Referenced by setup().

◆ enableCountdownTimer()

void SensorPCF8563::enableCountdownTimer ( )

inline

Enable the countdown timer interrupt.

Definition at line 380 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::setRegBit(), and STAT2_REG.

◆ getAlarm()

RTC_Alarm SensorPCF8563::getAlarm ( )

inline

Read the currently configured alarm settings.

Note: This returns the currently stored alarm registers; it does not imply that the alarm is enabled.

Returns: Alarm configuration.

Definition at line 204 of file time/pcf8563/SensorPCF8563.hpp.

References ALRM_MIN_REG, SensorRTC::BCD2DEC(), and SensorCommWrapper::readRegBuff().

◆ getChipName()

const char * SensorPCF8563::getChipName ( )

inlineoverridevirtual

Get the chip name string.

Returns: Constant chip name string.

Implements SensorRTC.

Definition at line 439 of file time/pcf8563/SensorPCF8563.hpp.

◆ getDateTime() [1/3]

RTC_DateTime SensorPCF8563::getDateTime ( )

inlineoverridevirtual

Get the current RTC date/time.

Reads the registers and converts the BCD values into a RTC_DateTime.

Returns: Current date/time.

Implements SensorRTC.

Definition at line 166 of file time/pcf8563/SensorPCF8563.hpp.

References SensorRTC::BCD2DEC(), CENTURY_MASK, SensorCommWrapper::readRegBuff(), and SEC_REG.

Referenced by loop(), and setAlarm().

◆ getDateTime() [2/3]

virtual RTC_DateTime SensorRTC::getDateTime ( )

virtual

Get the current date and time from the RTC.

This is a pure virtual function that derived classes must implement. It retrieves the current date and time from the RTC and returns them as an RTC_DateTime object.

Returns: An RTC_DateTime object representing the current date and time of the RTC.

Implements SensorRTC.

◆ getDateTime() [3/3]

void SensorRTC::getDateTime ( struct tm * info )

inline

Retrieve the current date and time from the RTC (Real-Time Clock) and populate a struct tm object.

This function fetches the current date and time information from the RTC device. It then fills the provided struct tm object with the corresponding values. The struct tm object is a standard C structure used to represent date and time components, such as year, month, day, hour, minute, and second.

Parameters

info	A pointer to a `struct tm` object where the retrieved date and time information will be stored. This pointer must not be a null pointer

Note: The year value in the struct tm object is the number of years since 1900. The month value ranges from 0 (January) to 11 (December). The day value represents the day of the month, starting from 1. The hour value ranges from 0 to 23, the minute and second values range from 0 to 59.

Definition at line 335 of file SensorRTC.h.

◆ isAlarmActive()

bool SensorPCF8563::isAlarmActive ( )

inline

Check whether the alarm flag is active.

Returns: true if active.

Definition at line 244 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::getRegBit(), and STAT2_REG.

Referenced by testAlarmDay(), testAlarmHour(), and testAlarmMinute().

◆ isClockIntegrityGuaranteed()

bool SensorPCF8563::isClockIntegrityGuaranteed ( )

inline

Check whether the clock integrity is guaranteed.

The PCF8563 sets the VL (Voltage Low) flag when the supply voltage has dropped below the minimum for reliable timekeeping.

Returns: true if the VL flag is clear; false otherwise.

Definition at line 191 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::getRegBit(), and SEC_REG.

Referenced by setup().

◆ isCountdownTimerActive()

bool SensorPCF8563::isCountdownTimerActive ( )

inline

Check whether the countdown timer flag is active.

Returns: true if active.

Definition at line 372 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::getRegBit(), and STAT2_REG.

◆ isCountdownTimerEnable()

bool SensorPCF8563::isCountdownTimerEnable ( )

inline

Check whether the countdown timer is enabled.

This checks both the timer interrupt enable (TIE) and timer enable (TE) bits.

Returns: true if enabled.

Definition at line 357 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::readReg(), STAT2_REG, TIMER1_REG, TIMER_TE, and TIMER_TIE.

◆ reset()

void SensorPCF8563::reset ( )

inlineoverridevirtual

Reset the RTC.

Reimplemented from SensorRTC.

Definition at line 447 of file time/pcf8563/SensorPCF8563.hpp.

◆ resetAlarm()

void SensorPCF8563::resetAlarm ( )

inline

Clear the alarm flag.

Definition at line 235 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::clrRegBit(), and STAT2_REG.

Referenced by testAlarmDay(), testAlarmHour(), and testAlarmMinute().

◆ setAlarm() [1/2]

void SensorPCF8563::setAlarm ( RTC_Alarm alarm )

inline

Set the alarm configuration.

Parameters

alarm Alarm configuration object.

Definition at line 253 of file time/pcf8563/SensorPCF8563.hpp.

References RTC_Alarm::getDay(), RTC_Alarm::getHour(), RTC_Alarm::getMinute(), RTC_Alarm::getWeek(), and setAlarm().

Referenced by setAlarm(), setAlarmByDays(), setAlarmByHours(), setAlarmByMinutes(), and setAlarmByWeekDay().

◆ setAlarm() [2/2]

void SensorPCF8563::setAlarm	(	uint8_t	hour,
		uint8_t	minute,
		uint8_t	day,
		uint8_t	week
	)

inline

Set the alarm configuration.

Any field can be disabled by passing NO_ALARM.

Parameters

hour	Hour value [0..23] or NO_ALARM.
minute	Minute value [0..59] or NO_ALARM.
day	Day-of-month [1..31] or NO_ALARM (clamped to the current month).
week	Weekday [0..6] or NO_ALARM.

Definition at line 268 of file time/pcf8563/SensorPCF8563.hpp.

References ALARM_ENABLE, ALRM_MIN_REG, SensorRTC::DEC2BCD(), getDateTime(), SensorRTC::getDaysInMonth(), RTC_DateTime::getMonth(), RTC_DateTime::getYear(), NO_ALARM, and SensorCommWrapper::writeRegBuff().

◆ setAlarmByDays()

void SensorPCF8563::setAlarmByDays ( uint8_t day )

inline

Convenience API to set an alarm that matches only day-of-month.

Parameters

day	Day-of-month value.

Definition at line 326 of file time/pcf8563/SensorPCF8563.hpp.

References NO_ALARM, and setAlarm().

Referenced by testAlarmHour().

◆ setAlarmByHours()

void SensorPCF8563::setAlarmByHours ( uint8_t hour )

inline

Convenience API to set an alarm that matches only hours.

Parameters

hour	Hour value.

Definition at line 335 of file time/pcf8563/SensorPCF8563.hpp.

References NO_ALARM, and setAlarm().

Referenced by testAlarmMinute().

◆ setAlarmByMinutes()

void SensorPCF8563::setAlarmByMinutes ( uint8_t minute )

inline

Convenience API to set an alarm that matches only minutes.

Parameters

minute Minute value [0..59].

Definition at line 317 of file time/pcf8563/SensorPCF8563.hpp.

References NO_ALARM, and setAlarm().

Referenced by setup().

◆ setAlarmByWeekDay()

void SensorPCF8563::setAlarmByWeekDay ( uint8_t week )

inline

Convenience API to set an alarm that matches only weekday.

Parameters

week	Weekday [0..6].

Definition at line 344 of file time/pcf8563/SensorPCF8563.hpp.

References NO_ALARM, and setAlarm().

◆ setClockOutput()

void SensorPCF8563::setClockOutput ( ClockHz freq )

inline

Configure the clock output (CLKOUT) pin.

Parameters

freq	Output frequency selection.

Definition at line 426 of file time/pcf8563/SensorPCF8563.hpp.

References CLK_DISABLE, CLK_ENABLE, SensorCommWrapper::clrRegBit(), SQW_REG, and SensorCommWrapper::writeReg().

Referenced by loop().

◆ setCountdownTimer()

void SensorPCF8563::setCountdownTimer	(	uint8_t	val,
		uint8_t	freq
	)

inline

Configure countdown timer.

Parameters

val	Countdown value.
freq	Timer frequency selection (see PCF8563Constants).

Definition at line 399 of file time/pcf8563/SensorPCF8563.hpp.

References SensorCommWrapper::readReg(), TIMER1_REG, TIMER2_REG, TIMER_TD10, and SensorCommWrapper::writeReg().

◆ setDateTime() [1/3]

void SensorPCF8563::setDateTime ( RTC_DateTime datetime )

inlineoverridevirtual

Set the RTC date/time.

Converts the provided datetime to BCD and writes it to the device.

Parameters

datetime Date/time to write.

Implements SensorRTC.

Definition at line 139 of file time/pcf8563/SensorPCF8563.hpp.

References SensorRTC::DEC2BCD(), RTC_DateTime::getDay(), SensorRTC::getDayOfWeek(), RTC_DateTime::getHour(), RTC_DateTime::getMinute(), RTC_DateTime::getMonth(), RTC_DateTime::getSecond(), RTC_DateTime::getYear(), SEC_REG, and SensorCommWrapper::writeRegBuff().

Referenced by loop(), setup(), testAlarmDay(), testAlarmHour(), and testAlarmMinute().

◆ setDateTime() [2/3]

virtual void SensorRTC::setDateTime ( RTC_DateTime datetime )

virtual

Set the date and time of the RTC using an RTC_DateTime object.

This is a pure virtual function that derived classes must implement. It allows setting the RTC's date and time using a single RTC_DateTime object.

Parameters

datetime An RTC_DateTime object containing the date and time information to set on the RTC.

Implements SensorRTC.

◆ setDateTime() [3/3]

void SensorRTC::setDateTime	(	uint16_t	year,
		uint8_t	month,
		uint8_t	day,
		uint8_t	hour,
		uint8_t	minute,
		uint8_t	second
	)

inline

Set the date and time of the RTC using individual values.

Parameters

year	The year to set on the RTC. It's usually a 16 - bit unsigned integer.
month	The month to set on the RTC, ranging from 1 (January) to 12 (December).
day	The day of the month to set on the RTC, ranging from 1 to 31, depending on the month and leap year.
hour	The hour to set on the RTC, ranging from 0 to 23.
minute	The minute to set on the RTC, ranging from 0 to 59.
second	The second to set on the RTC, ranging from 0 to 59.

Definition at line 351 of file SensorRTC.h.

Member Data Documentation

◆ ALARM_AF

constexpr uint8_t SensorPCF8563::ALARM_AF = 0x08

staticconstexprprotected

Definition at line 499 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by clearCountdownTimer().

◆ ALARM_AIE

constexpr uint8_t SensorPCF8563::ALARM_AIE = 0x02

staticconstexprprotected

Definition at line 501 of file time/pcf8563/SensorPCF8563.hpp.

◆ ALARM_ENABLE

constexpr uint8_t SensorPCF8563::ALARM_ENABLE = 0x80

staticconstexprprotected

Definition at line 508 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by setAlarm().

◆ ALRM_MIN_REG

constexpr uint8_t SensorPCF8563::ALRM_MIN_REG = 0x09

staticconstexprprotected

Definition at line 483 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by getAlarm(), and setAlarm().

◆ CENTURY_MASK

constexpr uint8_t SensorPCF8563::CENTURY_MASK = 0x80

staticconstexprprotected

Definition at line 493 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by getDateTime().

◆ CLK_ENABLE

constexpr uint8_t SensorPCF8563::CLK_ENABLE = 0x80

staticconstexprprotected

Definition at line 509 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by setClockOutput().

◆ DAY_MASK

constexpr uint8_t SensorPCF8563::DAY_MASK = 0x3F

staticconstexprprotected

Definition at line 494 of file time/pcf8563/SensorPCF8563.hpp.

◆ DAY_REG

constexpr uint8_t SensorPCF8563::DAY_REG = 0x05

staticconstexprprotected

Definition at line 479 of file time/pcf8563/SensorPCF8563.hpp.

◆ HOUR_MASK

constexpr uint8_t SensorPCF8563::HOUR_MASK = 0x3F

staticconstexprprotected

Definition at line 491 of file time/pcf8563/SensorPCF8563.hpp.

◆ HR_REG

constexpr uint8_t SensorPCF8563::HR_REG = 0x04

staticconstexprprotected

Definition at line 478 of file time/pcf8563/SensorPCF8563.hpp.

◆ MIN_REG

constexpr uint8_t SensorPCF8563::MIN_REG = 0x03

staticconstexprprotected

Definition at line 477 of file time/pcf8563/SensorPCF8563.hpp.

◆ MINUTES_MASK

constexpr uint8_t SensorPCF8563::MINUTES_MASK = 0x7F

staticconstexprprotected

Definition at line 490 of file time/pcf8563/SensorPCF8563.hpp.

◆ MONTH_MASK

constexpr uint8_t SensorPCF8563::MONTH_MASK = 0x1F

staticconstexprprotected

Definition at line 495 of file time/pcf8563/SensorPCF8563.hpp.

◆ MONTH_REG

constexpr uint8_t SensorPCF8563::MONTH_REG = 0x07

staticconstexprprotected

Definition at line 481 of file time/pcf8563/SensorPCF8563.hpp.

◆ NO_ALARM

constexpr uint8_t SensorPCF8563::NO_ALARM = 0xFF

staticconstexprprotected

Definition at line 507 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by setAlarm(), setAlarmByDays(), setAlarmByHours(), setAlarmByMinutes(), and setAlarmByWeekDay().

◆ SEC_REG

constexpr uint8_t SensorPCF8563::SEC_REG = 0x02

staticconstexprprotected

Definition at line 476 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by getDateTime(), isClockIntegrityGuaranteed(), and setDateTime().

◆ SQW_REG

constexpr uint8_t SensorPCF8563::SQW_REG = 0x0D

staticconstexprprotected

Definition at line 484 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by setClockOutput().

◆ STAT1_REG

constexpr uint8_t SensorPCF8563::STAT1_REG = 0x00

staticconstexprprotected

Definition at line 474 of file time/pcf8563/SensorPCF8563.hpp.

◆ STAT2_REG

constexpr uint8_t SensorPCF8563::STAT2_REG = 0x01

staticconstexprprotected

Definition at line 475 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by clearCountdownTimer(), disableAlarm(), disableCountdownTimer(), enableAlarm(), enableCountdownTimer(), isAlarmActive(), isCountdownTimerActive(), isCountdownTimerEnable(), and resetAlarm().

◆ TIMER1_REG

constexpr uint8_t SensorPCF8563::TIMER1_REG = 0x0E

staticconstexprprotected

Definition at line 485 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by clearCountdownTimer(), isCountdownTimerEnable(), and setCountdownTimer().

◆ TIMER2_REG

constexpr uint8_t SensorPCF8563::TIMER2_REG = 0x0F

staticconstexprprotected

Definition at line 486 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by setCountdownTimer().

◆ TIMER_CTL_MASK

constexpr uint8_t SensorPCF8563::TIMER_CTL_MASK = 0x03

staticconstexprprotected

Definition at line 496 of file time/pcf8563/SensorPCF8563.hpp.

◆ TIMER_TD10

constexpr uint8_t SensorPCF8563::TIMER_TD10 = 0x03

staticconstexprprotected

Definition at line 504 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by setCountdownTimer().

◆ TIMER_TE

constexpr uint8_t SensorPCF8563::TIMER_TE = 0x80

staticconstexprprotected

Definition at line 503 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by isCountdownTimerEnable().

◆ TIMER_TF

constexpr uint8_t SensorPCF8563::TIMER_TF = 0x04

staticconstexprprotected

Definition at line 500 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by clearCountdownTimer().

◆ TIMER_TIE

constexpr uint8_t SensorPCF8563::TIMER_TIE = 0x01

staticconstexprprotected

Definition at line 502 of file time/pcf8563/SensorPCF8563.hpp.

Referenced by clearCountdownTimer(), and isCountdownTimerEnable().

◆ VOL_LOW_MASK

constexpr uint8_t SensorPCF8563::VOL_LOW_MASK = 0x80

staticconstexprprotected

Definition at line 489 of file time/pcf8563/SensorPCF8563.hpp.

◆ WEEKDAY_MASK

constexpr uint8_t SensorPCF8563::WEEKDAY_MASK = 0x07

staticconstexprprotected

Definition at line 492 of file time/pcf8563/SensorPCF8563.hpp.

◆ WEEKDAY_REG

constexpr uint8_t SensorPCF8563::WEEKDAY_REG = 0x06

staticconstexprprotected

Definition at line 480 of file time/pcf8563/SensorPCF8563.hpp.

◆ YEAR_REG

constexpr uint8_t SensorPCF8563::YEAR_REG = 0x08

staticconstexprprotected

Definition at line 482 of file time/pcf8563/SensorPCF8563.hpp.

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

time/pcf8563/SensorPCF8563.hpp

Public Types

Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ClockHz

Constructor & Destructor Documentation

◆ SensorPCF8563()

◆ ~SensorPCF8563()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearCountdownTimer()

◆ disableAlarm()

◆ disableCountdownTimer()

◆ enableAlarm()

◆ enableCountdownTimer()

◆ getAlarm()

◆ getChipName()

◆ getDateTime() [1/3]

◆ getDateTime() [2/3]

◆ getDateTime() [3/3]

◆ isAlarmActive()

◆ isClockIntegrityGuaranteed()

◆ isCountdownTimerActive()

◆ isCountdownTimerEnable()

◆ reset()

◆ resetAlarm()

◆ setAlarm() [1/2]

◆ setAlarm() [2/2]

◆ setAlarmByDays()

◆ setAlarmByHours()

◆ setAlarmByMinutes()

◆ setAlarmByWeekDay()

◆ setClockOutput()

◆ setCountdownTimer()

◆ setDateTime() [1/3]

◆ setDateTime() [2/3]

◆ setDateTime() [3/3]

Member Data Documentation

◆ ALARM_AF

◆ ALARM_AIE

◆ ALARM_ENABLE

◆ ALRM_MIN_REG

◆ CENTURY_MASK

◆ CLK_ENABLE

◆ DAY_MASK

◆ DAY_REG

◆ HOUR_MASK

◆ HR_REG

◆ MIN_REG

◆ MINUTES_MASK

◆ MONTH_MASK

◆ MONTH_REG

◆ NO_ALARM

◆ SEC_REG

◆ SQW_REG

◆ STAT1_REG

◆ STAT2_REG

◆ TIMER1_REG

◆ TIMER2_REG

◆ TIMER_CTL_MASK

◆ TIMER_TD10

◆ TIMER_TE

◆ TIMER_TF

◆ TIMER_TIE

◆ VOL_LOW_MASK

◆ WEEKDAY_MASK

◆ WEEKDAY_REG

◆ YEAR_REG