RTC_NXP_Arduino 0.5.0
LED driver device operation sample code for Arduino
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
PCF85263A Class Reference
Inheritance diagram for PCF85263A:
RTC_NXP

Public Types

enum  reg_num {
  _100th_seconds , Seconds , Minutes , Hours ,
  Days , Weekdays , Months , Years ,
  Second_alarm1 , Minute_alarm1 , Hour_alarm1 , Day_alarm1 ,
  Month_alarm1 , Minute_alarm2 , Hour_alarm2 , Weekday_alarm2 ,
  Alarm_enables , TSR1_seconds , TSR1_minutes , TSR1_hours ,
  TSR1_days , TSR1_months , TSR1_years , TSR2_seconds ,
  TSR2_minutes , TSR2_hours , TSR2_days , TSR2_months ,
  TSR2_years , TSR3_seconds , TSR3_minutes , TSR3_hours ,
  TSR3_days , TSR3_months , TSR3_years , TSR_mode ,
  Offset , Oscillator , Battery_switch , Pin_IO ,
  Function , INTA_enable , INTB_enable , Flags ,
  RAM_byte , WatchDog , Stop_enable , Resets ,
  Hours_xx_xx_00 = 0x03 , Hours_xx_00_xx , Hours_00_xx_xx , Reserved0 ,
  Reserved1 , Second_alm1 , Minute_alm1 , Hr_xx_xx_00_alm1 ,
  Hr_xx_00_xx_alm1 , Hr_00_xx_xx_alm1 , Minute_alm2 , Hr_xx_00_alm2 ,
  Hr_00_xx_alm2 , TSR1_hr_xx_xx_00 = 0x13 , TSR1_hr_xx_00_xx , TSR1_hr_00_xx_xx ,
  Reserved2 , TSR2_hr_xx_xx_00 = 0x19 , TSR2_hr_xx_00_xx , TSR2_hr_00_xx_xx ,
  Reserved3 , TSR3_hr_xx_xx_00 = 0x1F , TSR3_hr_xx_00_xx , TSR3_hr_00_xx_xx ,
  Reserved4
}
 
enum  alarm_setting_85263A {
  SECOND , MINUTE , HOUR , DAY ,
  MONTH , MINUTE2 , HOUR2 , WEEKDAY2
}
 
enum  periodic_int_select { DISABLE , EVERY_SECOND , EVERY_MINUTE }
 
enum  inta { INTA_CLKOUT , INTA_BATTERY_MODE_INDICATION , INTA_INTTERRUPT , INTA_HIGH_Z }
 
enum  intb { INTB_DISABLE , INTB_INTTERRUPT , INTB_CLKOUT , INTB_INPUT_MODE }
 
enum  ts_in {
  TS_PULLUP_80K = 0x00 , TS_PULLUP_40K = 0x40 , TSL_ACTIVE_HIGH = 0x00 , TSL_ACTIVE_LOW = 0x20 ,
  TSIM_CMOS = 0x00 , TSIM_MECHANICAL = 0x10
}
 
- Public Types inherited from RTC_NXP
enum  board { NONE , ARDUINO_SHIELD }
 
enum  alarm_setting {
  SECOND , MINUTE , HOUR , DAY ,
  WEEKDAY
}
 

Public Member Functions

 PCF85263A (uint8_t i2c_address=(0xA2 > > 1))
 
 PCF85263A (TwoWire &wire, uint8_t i2c_address=(0xA2 > > 1))
 
virtual ~PCF85263A ()
 
void begin (void)
 
void set (struct tm *now_tm)
 
bool oscillator_stop (void)
 
void alarm (alarm_setting digit, int val)
 
void alarm (alarm_setting digit, int val, int int_sel)
 
void alarm (alarm_setting_85263A digit, int val, int int_sel=0)
 
void alarm_clear (void)
 
void alarm_disable (void)
 
uint8_t int_clear (void)
 
time_t rtc_time (void)
 
void periodic_interrupt_enable (periodic_int_select sel, int int_sel=0)
 
void pin_congfig (inta cfg_a, intb cfg_b)
 
void ts_congfig (int setting)
 
time_t timestamp (int num)
 
- Public Member Functions inherited from RTC_NXP
 RTC_NXP ()
 
virtual ~RTC_NXP ()
 
virtual void begin (void)=0
 
time_t time (time_t *tp)
 
virtual void set (struct tm *now_tm)=0
 
virtual bool oscillator_stop (void)=0
 
virtual void alarm (alarm_setting digit, int val)=0
 
virtual void alarm_clear (void)=0
 
virtual void alarm_disable (void)=0
 
virtual uint8_t int_clear (void)=0
 

Additional Inherited Members

virtual time_t rtc_time (void)=0
 
- 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 566 of file RTC_NXP.h.

Member Enumeration Documentation

◆ alarm_setting_85263A

Alarm setting digit selection descriptor

Definition at line 591 of file RTC_NXP.h.

◆ inta

INT_A pin setting descriptor

Definition at line 610 of file RTC_NXP.h.

◆ intb

INT_B pin setting descriptor

Definition at line 618 of file RTC_NXP.h.

◆ periodic_int_select

Periodic interrupt selection descriptor

Definition at line 603 of file RTC_NXP.h.

◆ reg_num

enum PCF85263A::reg_num

Definition at line 569 of file RTC_NXP.h.

◆ ts_in

Timestamp pin input setting descriptor

Definition at line 626 of file RTC_NXP.h.

Constructor & Destructor Documentation

◆ PCF85263A() [1/2]

PCF85263A::PCF85263A ( uint8_t  i2c_address = (0xA2 >> 1))

Constructor

Definition at line 3 of file PCF85263A.cpp.

◆ PCF85263A() [2/2]

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

Constructor

Definition at line 7 of file PCF85263A.cpp.

◆ ~PCF85263A()

PCF85263A::~PCF85263A ( )
virtual

Destructor

Definition at line 11 of file PCF85263A.cpp.

Member Function Documentation

◆ alarm() [1/3]

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

Alarm setting

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

Implements RTC_NXP.

Definition at line 50 of file PCF85263A.cpp.

Referenced by alarm().

◆ alarm() [2/3]

void PCF85263A::alarm ( alarm_setting  digit,
int  val,
int  int_sel 
)

Alarm setting

Parameters
digitto specify which parameter to set: SECOND, MINUTE, HOUR, DAY, WEEKDAY in 'enum alarm_setting'
valSetting value. Set 0x80 to disabling
int_selInterrupt output selector. ) for INT_A, 1 for INT_B

Definition at line 55 of file PCF85263A.cpp.

◆ alarm() [3/3]

void PCF85263A::alarm ( alarm_setting_85263A  digit,
int  val,
int  int_sel = 0 
)

Alarm setting

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

Definition at line 65 of file PCF85263A.cpp.

◆ alarm_clear()

void PCF85263A::alarm_clear ( void  )
virtual

Alarm clearing

Implements RTC_NXP.

Definition at line 83 of file PCF85263A.cpp.

◆ alarm_disable()

void PCF85263A::alarm_disable ( void  )
virtual

Alarm interrupt disable

Implements RTC_NXP.

Definition at line 88 of file PCF85263A.cpp.

◆ begin()

void PCF85263A::begin ( void  )
virtual

Initializer

Implements RTC_NXP.

Definition at line 15 of file PCF85263A.cpp.

◆ int_clear()

uint8_t PCF85263A::int_clear ( void  )
virtual

Interrupt clear

Implements RTC_NXP.

Definition at line 94 of file PCF85263A.cpp.

◆ oscillator_stop()

bool PCF85263A::oscillator_stop ( void  )
virtual

Detector for oscillation stop

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

Implements RTC_NXP.

Definition at line 45 of file PCF85263A.cpp.

◆ periodic_interrupt_enable()

void PCF85263A::periodic_interrupt_enable ( periodic_int_select  sel,
int  int_sel = 0 
)

Enabling every second/minute interrupt

Parameters
selchoose DISABLE, EVERY_SECOND or EVERY_MINUTE in 'enum periodic_int_select'

Definition at line 120 of file PCF85263A.cpp.

◆ pin_congfig()

void PCF85263A::pin_congfig ( inta  cfg_a,
intb  cfg_b 
)

Pin configuration

Parameters
cfg_aTo choose INT_A pin congiguration: Use CLKOUT, BATTERY_MODE_INDICATION, INTTERRUPT or HIGH_Z
cfg_bTo choose INT_A pin congiguration: Use DISABLE, INTTERRUPT, CLKOUT or INPUTMODE

Definition at line 128 of file PCF85263A.cpp.

◆ rtc_time()

time_t PCF85263A::rtc_time ( void  )
virtual

rtc_time

Returns
time_t returns RTC time in time_t format

Implements RTC_NXP.

Definition at line 102 of file PCF85263A.cpp.

◆ set()

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

set

Parameters
now_tmstruct to set calendar and time in RTC

Implements RTC_NXP.

Definition at line 19 of file PCF85263A.cpp.

◆ timestamp()

time_t PCF85263A::timestamp ( int  num)

Timestamp register read

Parameters
numtimestamp index

Definition at line 139 of file PCF85263A.cpp.

◆ ts_congfig()

void PCF85263A::ts_congfig ( int  setting)

Timestamp pin configuration

Parameters
settingTo choose options: Compose value by ORing next constants: TS_PULLUP_80K, TS_PULLUP_40K, TSL_ACTIVE_HIGH, TSL_ACTIVE_LOW, TSIM_CMOS and TSIM_MECHANICAL

Definition at line 133 of file PCF85263A.cpp.


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