unit_PCF8563_types.hpp File Reference

Type definitions for PCF8563 Unit. More...

#include <cstdint>
#include <tuple>
#include <time.h>

Go to the source code of this file.

Classes
struct	m5::unit::pcf8563::rtc_time_t
	Time of day (hours, minutes, seconds) More...
struct	m5::unit::pcf8563::rtc_date_t
	Calendar date (year, month, day, weekday) More...
struct	m5::unit::pcf8563::rtc_datetime_t
	Combined date and time. More...

Enumerations
enum class	m5::unit::pcf8563::TimerClock : uint8_t { Hz4096 = 0 , Hz64 = 1 , Hz1 = 2 , HzPM = 3 }
	Timer clock source for PCF8563 countdown timer. More...
enum class	m5::unit::pcf8563::ClockOutput : uint8_t {   None = 0x00 , Hz32768 = 0x80 , Hz1024 = 0x81 , Hz32 = 0x82 ,   Hz1 = 0x83 }
	CLKOUT pin output frequency (register 0x0D) More...

Functions
rtc_time_t comparison operators
bool	m5::unit::pcf8563::operator== (const rtc_time_t &lhs, const rtc_time_t &rhs)
bool	m5::unit::pcf8563::operator!= (const rtc_time_t &lhs, const rtc_time_t &rhs)
bool	m5::unit::pcf8563::operator< (const rtc_time_t &lhs, const rtc_time_t &rhs)
bool	m5::unit::pcf8563::operator<= (const rtc_time_t &lhs, const rtc_time_t &rhs)
bool	m5::unit::pcf8563::operator> (const rtc_time_t &lhs, const rtc_time_t &rhs)
bool	m5::unit::pcf8563::operator>= (const rtc_time_t &lhs, const rtc_time_t &rhs)
rtc_date_t comparison operators (weekDay is excluded)
bool	m5::unit::pcf8563::operator== (const rtc_date_t &lhs, const rtc_date_t &rhs)
bool	m5::unit::pcf8563::operator!= (const rtc_date_t &lhs, const rtc_date_t &rhs)
bool	m5::unit::pcf8563::operator< (const rtc_date_t &lhs, const rtc_date_t &rhs)
bool	m5::unit::pcf8563::operator<= (const rtc_date_t &lhs, const rtc_date_t &rhs)
bool	m5::unit::pcf8563::operator> (const rtc_date_t &lhs, const rtc_date_t &rhs)
bool	m5::unit::pcf8563::operator>= (const rtc_date_t &lhs, const rtc_date_t &rhs)
rtc_datetime_t comparison operators (weekDay is excluded)
bool	m5::unit::pcf8563::operator== (const rtc_datetime_t &lhs, const rtc_datetime_t &rhs)
bool	m5::unit::pcf8563::operator!= (const rtc_datetime_t &lhs, const rtc_datetime_t &rhs)
bool	m5::unit::pcf8563::operator< (const rtc_datetime_t &lhs, const rtc_datetime_t &rhs)
bool	m5::unit::pcf8563::operator<= (const rtc_datetime_t &lhs, const rtc_datetime_t &rhs)
bool	m5::unit::pcf8563::operator> (const rtc_datetime_t &lhs, const rtc_datetime_t &rhs)
bool	m5::unit::pcf8563::operator>= (const rtc_datetime_t &lhs, const rtc_datetime_t &rhs)

Detailed Description

Type definitions for PCF8563 Unit.

Enumeration Type Documentation

ClockOutput

enum class m5::unit::pcf8563::ClockOutput : uint8_t

strong

CLKOUT pin output frequency (register 0x0D)

Enumerator
None	CLKOUT disabled (high-impedance)
Hz32768	32.768 kHz (FE=1, FD=00)
Hz1024	1.024 kHz (FE=1, FD=01)
Hz32	32 Hz (FE=1, FD=10)
Hz1	1 Hz (FE=1, FD=11)

TimerClock

enum class m5::unit::pcf8563::TimerClock : uint8_t

strong

Timer clock source for PCF8563 countdown timer.

Enumerator
Hz4096	4.096 kHz (~244us resolution)
Hz64	64 Hz (~15.6ms resolution)
Hz1	1 Hz (1 second resolution)
HzPM	1/60 Hz (1 minute resolution)