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

Public Member Functions

 ForFutureExtention ()
 
virtual ~ForFutureExtention ()
 
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 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 ()
 
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
 

Protected Member Functions

time_t rtc_time (void)
 
virtual time_t rtc_time (void)=0
 

Additional Inherited Members

- Public Types inherited from RTC_NXP
enum  board { NONE , ARDUINO_SHIELD }
 
enum  alarm_setting {
  SECOND , MINUTE , HOUR , DAY ,
  WEEKDAY
}
 
- 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 1318 of file RTC_NXP.h.

Constructor & Destructor Documentation

◆ ForFutureExtention()

ForFutureExtention::ForFutureExtention ( )

Constructor

◆ ~ForFutureExtention()

virtual ForFutureExtention::~ForFutureExtention ( )
virtual

Destructor

Member Function Documentation

◆ alarm()

void ForFutureExtention::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'. Set 0x80 to disabling

Implements RTC_NXP.

◆ alarm_clear()

void ForFutureExtention::alarm_clear ( void  )
virtual

Alarm clearing

Implements RTC_NXP.

◆ alarm_disable()

void ForFutureExtention::alarm_disable ( void  )
virtual

Alarm interrupt disable

Implements RTC_NXP.

◆ begin()

void ForFutureExtention::begin ( void  )
virtual

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

Implements RTC_NXP.

◆ bit_op8()

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

◆ int_clear()

uint8_t ForFutureExtention::int_clear ( void  )
virtual

Interrupt clear

Implements RTC_NXP.

◆ oscillator_stop()

bool ForFutureExtention::oscillator_stop ( void  )
virtual

Detector for oscillation stop

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

Implements RTC_NXP.

◆ read_r8()

uint8_t ForFutureExtention::read_r8 ( uint8_t  reg)

Register read, 8 bit

Parameters
regregister index/address/pointer
Returns
data value

◆ reg_r() [1/2]

uint8_t ForFutureExtention::reg_r ( uint8_t  reg_adr)

Single register read

Parameters
regregister index/address/pointer
Returns
read data

◆ reg_r() [2/2]

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

◆ reg_w() [1/2]

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

◆ reg_w() [2/2]

void ForFutureExtention::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 ForFutureExtention::rtc_time ( void  )
protectedvirtual

rtc_time

Returns
time_t returns RTC time in time_t format

Implements RTC_NXP.

◆ set()

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

set

Parameters
now_tmstruct to set calendar and time in RTC

Implements RTC_NXP.

◆ time()

time_t ForFutureExtention::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 ForFutureExtention::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 file: