RTC_NXP_Arduino 1.1.1
RTC driver device operation sample code for Arduino
Loading...
Searching...
No Matches
PCF85053A Class Reference
Inheritance diagram for PCF85053A:
RTC_NXP

Public Types

enum  reg_num {
  Seconds , Seconds_alarm , Minutes , Minutes_alarm ,
  Hours , Hours_alarm , Day_of_the_Week , Day_of_the_Month ,
  Month , Year , Control_Register , Status_Register ,
  CLKOUT_Control , _2nd_Control_Register , Scratchpad , Version_Register ,
  Vendor_ID_Register , Model_Register , Offset , Oscillator ,
  Access_config , Sec_timestp , Min_timestp , Hour_timestp ,
  DayWk_timestp , DayMon_timestp , Mon_timestp , Year_timestp ,
  R_code1 , R_code2
}
 
- Public Types inherited from RTC_NXP
enum  board { NONE , ARDUINO_SHIELD }
 
enum  alarm_setting {
  SECOND , MINUTE , HOUR , DAY ,
  WEEKDAY
}
 

Public Member Functions

 PCF85053A (uint8_t i2c_address=(0xDE > > 1))
 
 PCF85053A (TwoWire &wire, uint8_t i2c_address=(0xDE > > 1))
 
virtual ~PCF85053A ()
 
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)
 
time_t rtc_time (void)
 
time_t time (time_t *tp)
 
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 RTC_NXP
 RTC_NXP ()
 
virtual ~RTC_NXP ()
 
time_t time (time_t *tp)
 

Additional Inherited Members

- 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

Definition at line 1344 of file RTC_NXP.h.

Member Enumeration Documentation

◆ reg_num

Name of the PCF85053A registers

Definition at line 1348 of file RTC_NXP.h.

Constructor & Destructor Documentation

◆ PCF85053A() [1/2]

PCF85053A::PCF85053A ( uint8_t i2c_address = (0xDE >> 1))

Create a PCF85053A instance with specified address

Parameters
wireTwoWire instance
i2c_addressI2C-bus address (default: (0xBC>>1))

Definition at line 3 of file PCF85053A.cpp.

◆ PCF85053A() [2/2]

PCF85053A::PCF85053A ( TwoWire & wire,
uint8_t i2c_address = (0xDE >> 1) )

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

Parameters
wireTwoWire instance
i2c_addressI2C-bus address (default: (0xBC>>1))

Definition at line 4 of file PCF85053A.cpp.

◆ ~PCF85053A()

PCF85053A::~PCF85053A ( )
virtual

Destructor

Definition at line 5 of file PCF85053A.cpp.

Member Function Documentation

◆ alarm()

void PCF85053A::alarm ( alarm_setting digit,
int val )
virtual

Alarm setting

Parameters
digitto specify which parameter to set: SECOND, MINUTE, HOUR in 'enum alarm_setting_85053A'
valSetting value. Set 0x80 to disabling

Implements RTC_NXP.

Definition at line 38 of file PCF85053A.cpp.

◆ alarm_clear()

void PCF85053A::alarm_clear ( void )
virtual

Alarm clearing

Implements RTC_NXP.

Definition at line 44 of file PCF85053A.cpp.

◆ alarm_disable()

void PCF85053A::alarm_disable ( void )
virtual

Alarm interrupt disable

Implements RTC_NXP.

Definition at line 51 of file PCF85053A.cpp.

◆ begin()

void PCF85053A::begin ( void )
virtual

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

Implements RTC_NXP.

Definition at line 7 of file PCF85053A.cpp.

◆ bit_op8()

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

Register overwriting with bit-mask

Register can be updated by bit level

Parameters
regregister index/address/pointer
maskbit-mask to protect overwriting
valuevalue to overwrite

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

◆ int_clear()

uint8_t PCF85053A::int_clear ( void )
virtual

Interrupt clear

Implements RTC_NXP.

Definition at line 56 of file PCF85053A.cpp.

◆ oscillator_stop()

bool PCF85053A::oscillator_stop ( void )
virtual

Detector for oscillation stop

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

Implements RTC_NXP.

Definition at line 32 of file PCF85053A.cpp.

◆ read_r8()

uint8_t PCF85053A::read_r8 ( uint8_t reg)

Register read, 8 bit

Parameters
regregister index/address/pointer
Returns
data value

◆ reg_r() [1/2]

uint8_t PCF85053A::reg_r ( uint8_t reg_adr)

Single register read

Parameters
regregister index/address/pointer
Returns
read data

◆ reg_r() [2/2]

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

Multiple register read

Parameters
regregister index/address/pointer
datapointer to data buffer
sizedata size
Returns
transferred data size

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

◆ reg_w() [1/2]

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

Multiple register write

Parameters
regregister index/address/pointer
datapointer to data buffer
sizedata size
Returns
transferred data size

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

◆ reg_w() [2/2]

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

Single register write

Parameters
regregister index/address/pointer
datapointer to data buffer
sizedata size
Returns
transferred data size

◆ rtc_time()

time_t PCF85053A::rtc_time ( void )
virtual

rtc_time

Returns
time_t returns RTC time in time_t format

Implements RTC_NXP.

Definition at line 64 of file PCF85053A.cpp.

◆ set()

void PCF85053A::set ( struct tm * now_tm)
virtual

set

Parameters
now_tmstruct to set calendar and time in RTC

Implements RTC_NXP.

Definition at line 9 of file PCF85053A.cpp.

◆ time()

time_t PCF85053A::time ( time_t * tp)

time

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

Parameters
tppointer to time_t variable
Returns
time_t value of current time

◆ write_r8()

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

Register write, 8 bit

Parameters
regregister index/address/pointer
valdata value

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