Motoo Tanaka / RTC8564

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   testRTC8564

Embed: (wiki syntax)

« Back to documentation index

RTC8564 Class Reference
Public Member Functions

RTC8564 Class Reference

EPSON TOYOCOM Real Time Clock Module RTC-8564JE/NB (ref: ETM11J-06) More...

#include <RTC8564.h>

Public Member Functions

 RTC8564 (PinName sda, PinName scl, int addr)
 RTC8564 constructor.
 ~RTC8564 ()
 RTC8564 destructor.
void setReg (int addr, uint8_t data)
 setReg : set arbitrary register
uint8_t getReg (int addr)
 getReg : get arbitrary register value
void setAll (uint8_t data[])
 setAll : set all registers at once
void getAll (uint8_t data[])
 getAll : get values of all registers
void setControl1 (uint8_t data)
 setControl1 : assign value to Control 1 register (0x00)
uint8_t getControl1 (void)
 getControl1 : get Control 1 register value
void setControl2 (uint8_t data)
 setControl2 : assign value to Control 2 register (0x01)
uint8_t getControl2 (void)
 getControl2 : get value of Control 2 register (0x01)
void setSeconds (uint8_t data)
 set seconds
uint8_t getSeconds (void)
 get seconds
void setMinutes (uint8_t data)
 set minutes
uint8_t getMinutes (void)
 get minutes
void setHours (uint8_t data)
 set hours
uint8_t getHours (void)
 get hours
void setDays (uint8_t data)
 set days
uint8_t getDays (void)
 get days
void setWeekdays (uint8_t data)
 set day of week
uint8_t getWeekdays (void)
 get day of week
void setMonths (uint8_t data)
 set months
uint8_t getMonths (void)
 get months
void setYears (uint8_t data)
 set years
uint8_t getYears (void)
 get Years
void setMinuteAlarm (uint8_t data)
 set Minute Alarm
uint8_t getMinuteAlarm (void)
 get Minute Alarm
void setHourAlarm (uint8_t data)
 set Hour Alarm
uint8_t getHourAlarm (void)
 get Hour Alarm
void setDayAlarm (uint8_t data)
 set Day Alarm
uint8_t getDayAlarm (void)
 get Day Alarm
void setWeekdayAlarm (uint8_t data)
 set day of week alarm
uint8_t getWeekdayAlarm (void)
 get day of week alarm
void setCLKOUTFrequency (uint8_t data)
 set CLKOUT Frequency
uint8_t getCLKOUTFrequency (void)
 get CLKOUT Frequency
void setTimerControl (uint8_t data)
 set Timer Control
uint8_t getTimerControl (void)
 get Timer Control none
void setTimer (uint8_t data)
 set Timer
uint8_t getTimer (void)
 get Timer
void stop (void)
 stop RTC
void start (void)
 start RTC

Detailed Description

EPSON TOYOCOM Real Time Clock Module RTC-8564JE/NB (ref: ETM11J-06) 

 

Definition at line 12 of file RTC8564.h.


Constructor & Destructor Documentation






      

        

          RTC8564 
          (
          PinName 
           sda, 
        

        

          
          
          PinName 
           scl, 
        

        

          
          
          int 
           addr 
        

        

          
          )
          
        

      







RTC8564 constructor. 


Parameters:

  

    
sdaSDA pin 

    
sdlSCL pin 

    
addraddr of the I2C peripheral 

  

  





Definition at line 102 of file RTC8564.cpp.











      

        

          ~RTC8564 
          (
           )
          
        

      







RTC8564 destructor. 



Definition at line 107 of file RTC8564.cpp.







Member Function Documentation






      

        

          void getAll 
          (
          uint8_t 
           data[] )
          
        

      







getAll : get values of all registers 


Parameters:

  

    
data16 x uint8_t values to receive 

  

  




Returns:
none 



Definition at line 256 of file RTC8564.cpp.











      

        

          uint8_t getCLKOUTFrequency 
          (
          void 
           )
          
        

      







get CLKOUT Frequency 


Parameters:

  

    
none

  

  




Returns:
uint8_t CLKOUT Frequency 


Note:
please refer to setCLKOUTFrequency comment 



and Datasheet for details 



Definition at line 374 of file RTC8564.cpp.











      

        

          uint8_t getControl1 
          (
          void 
           )
          
        

      







getControl1 : get Control 1 register value 


Parameters:

  

    
none

  

  




Returns:
uint8_t value of Control 1 register 



Definition at line 261 of file RTC8564.cpp.











      

        

          uint8_t getControl2 
          (
          void 
           )
          
        

      







getControl2 : get value of Control 2 register (0x01) 


Parameters:

  

    
none

  

  




Returns:
uint8_t value of Control 1 register 



Definition at line 268 of file RTC8564.cpp.











      

        

          uint8_t getDayAlarm 
          (
          void 
           )
          
        

      







get Day Alarm 


Parameters:

  

    
none

  

  




Returns:
uint8_t Day Alarm 



Definition at line 358 of file RTC8564.cpp.











      

        

          uint8_t getDays 
          (
          void 
           )
          
        

      







get days 


Parameters:

  

    
none

  

  




Returns:
uint8_t days (0..31) 



Definition at line 307 of file RTC8564.cpp.











      

        

          uint8_t getHourAlarm 
          (
          void 
           )
          
        

      







get Hour Alarm 


Parameters:

  

    
none

  

  




Returns:
Hour Alarm 



Definition at line 350 of file RTC8564.cpp.











      

        

          uint8_t getHours 
          (
          void 
           )
          
        

      







get hours 


Parameters:

  

    
none

  

  




Returns:
uint8_t hours (0..23) 



Definition at line 298 of file RTC8564.cpp.











      

        

          uint8_t getMinuteAlarm 
          (
          void 
           )
          
        

      







get Minute Alarm 


Parameters:

  

    
none

  

  




Returns:
uint8_t Minute Alarm 



Definition at line 345 of file RTC8564.cpp.











      

        

          uint8_t getMinutes 
          (
          void 
           )
          
        

      







get minutes 


Parameters:

  

    
none

  

  




Returns:
uint8_t minutes (0..59) 



Definition at line 289 of file RTC8564.cpp.











      

        

          uint8_t getMonths 
          (
          void 
           )
          
        

      







get months 


Parameters:

  

    
none

  

  




Returns:
uint8_t monts (1..12) 



Definition at line 325 of file RTC8564.cpp.











      

        

          uint8_t getReg 
          (
          int 
           addr )
          
        

      







getReg : get arbitrary register value 


Parameters:

  

    
addrregister address 

  

  




Returns:
uint8_t register value 



Definition at line 249 of file RTC8564.cpp.











      

        

          uint8_t getSeconds 
          (
          void 
           )
          
        

      







get seconds 


Parameters:

  

    
none

  

  




Returns:
uint8_t seconds (0..59) 



Definition at line 275 of file RTC8564.cpp.











      

        

          uint8_t getTimer 
          (
          void 
           )
          
        

      







get Timer 


Parameters:

  

    
none

  

  




Returns:
uint8_t timer value 



Definition at line 390 of file RTC8564.cpp.











      

        

          uint8_t getTimerControl 
          (
          void 
           )
          
        

      







get Timer Control  none 


Returns:
uint8_t Timer Control register value 



Definition at line 382 of file RTC8564.cpp.











      

        

          uint8_t getWeekdayAlarm 
          (
          void 
           )
          
        

      







get day of week alarm 


Parameters:

  

    
none

  

  




Returns:
day of week alarm 



Definition at line 366 of file RTC8564.cpp.











      

        

          uint8_t getWeekdays 
          (
          void 
           )
          
        

      







get day of week 


Parameters:

  

    
none

  

  




Returns:
uint8_t day of week 



Definition at line 316 of file RTC8564.cpp.











      

        

          uint8_t getYears 
          (
          void 
           )
          
        

      







get Years 


Parameters:

  

    
none

  

  




Returns:
uint8_t years 



Definition at line 337 of file RTC8564.cpp.











      

        

          void setAll 
          (
          uint8_t 
           data[] )
          
        

      







setAll : set all registers at once 


Parameters:

  

    
data16 x uint8_t values 

  

  





Definition at line 130 of file RTC8564.cpp.











      

        

          void setCLKOUTFrequency 
          (
          uint8_t 
           data )
          
        

      







set CLKOUT Frequency 


Parameters:

  

    
uint8_tdata FE_BIT(0x80) is enable 

  

  




Note:
bit[1] FD1, bit[0] FD0 to select FREQ. 



CLKOUT outputs only when CLKOE pin is "H" 



and FE_BIT is 1. 



FD1=0, FD0=0 : 32768 Hz, 



FD1=0, FD0=1 : 1024 Hz, 



FD1=1, FD0=0 : 32 Hz 



FD1=1, FD0=1 : 1 Hz 



When STOP_BIT is high, only 32768 Hz will be output 



and other freq clock will not be generated. 



Definition at line 231 of file RTC8564.cpp.











      

        

          void setControl1 
          (
          uint8_t 
           data )
          
        

      







setControl1 : assign value to Control 1 register (0x00) 


Parameters:

  

    
datauint8_t value to assign 

  

  




Note:
bit[5] is STOP_BIT 1: stop 0: start 



all other bits should be 0 



Definition at line 142 of file RTC8564.cpp.











      

        

          void setControl2 
          (
          uint8_t 
           data )
          
        

      







setControl2 : assign value to Control 2 register (0x01) 


Parameters:

  

    
datauint8_t value to assign 

  

  




Note:
bit[0]: TIE, bit[1]: AIE, bit[2]: TF, bit[3]: AF 



bit[4]: TI/TP 



Definition at line 147 of file RTC8564.cpp.











      

        

          void setDayAlarm 
          (
          uint8_t 
           data )
          
        

      







set Day Alarm 


Parameters:

  

    
uint8_tdata AE_BIT(0x80) is enable 

  

  




Note:
rest of 6bit is 2bit and 4bit BCD value (00..31) 



Definition at line 219 of file RTC8564.cpp.











      

        

          void setDays 
          (
          uint8_t 
           data )
          
        

      







set days 


Parameters:

  

    
datauint8_t value to assing (0..31) 

  

  





Definition at line 176 of file RTC8564.cpp.











      

        

          void setHourAlarm 
          (
          uint8_t 
           data )
          
        

      







set Hour Alarm 


Parameters:

  

    
uint8_tdata AE_BIT(0x80) is enable 

  

  




Note:
rest of 6bit is 2bit and 4bit BCD value (00..23) 



Definition at line 213 of file RTC8564.cpp.











      

        

          void setHours 
          (
          uint8_t 
           data )
          
        

      







set hours 


Parameters:

  

    
datauint8_t value to assign (0..23) 

  

  





Definition at line 168 of file RTC8564.cpp.











      

        

          void setMinuteAlarm 
          (
          uint8_t 
           data )
          
        

      







set Minute Alarm 


Parameters:

  

    
uint8_tdata AE_BIT(0x80) is enable, 

  

  




Note:
rest of 7bit is 3bit and 4bit BCD value (00..59) 



Definition at line 207 of file RTC8564.cpp.











      

        

          void setMinutes 
          (
          uint8_t 
           data )
          
        

      







set minutes 


Parameters:

  

    
datauint8_t value to assign (0..59) 

  

  





Definition at line 160 of file RTC8564.cpp.











      

        

          void setMonths 
          (
          uint8_t 
           data )
          
        

      







set months 


Parameters:

  

    
datavalue to assign (1..12) 

  

  





Definition at line 191 of file RTC8564.cpp.











      

        

          void setReg 
          (
          int 
           addr, 
        

        

          
          
          uint8_t 
           data 
        

        

          
          )
          
        

      







setReg : set arbitrary register 


Parameters:

  

    
addrregister address 

    
datavalue to assign 

  

  




Returns:
none 



Definition at line 122 of file RTC8564.cpp.











      

        

          void setSeconds 
          (
          uint8_t 
           data )
          
        

      







set seconds 


Parameters:

  

    
datauint8_t value to assign (0..59) 

  

  





Definition at line 152 of file RTC8564.cpp.











      

        

          void setTimer 
          (
          uint8_t 
           data )
          
        

      







set Timer 


Parameters:

  

    
uint8_tdata preset value for the count down timer 

  

  




Note:
please refer to the Datasheet for the details 



Definition at line 243 of file RTC8564.cpp.











      

        

          void setTimerControl 
          (
          uint8_t 
           data )
          
        

      







set Timer Control 


Parameters:

  

    
uint8_tdata TE_BIT (0x80) is enable 

  

  




Note:
bit[1] TD1, bit[0] TD0 



please refer to the Datasheet for the details 



Definition at line 237 of file RTC8564.cpp.











      

        

          void setWeekdayAlarm 
          (
          uint8_t 
           data )
          
        

      







set day of week alarm 


Parameters:

  

    
uint8_tdata AE_BIT(0x80) is enable 

  

  




Note:
rest of 3bit is BCD value (0..6) 



Definition at line 225 of file RTC8564.cpp.











      

        

          void setWeekdays 
          (
          uint8_t 
           data )
          
        

      







set day of week 


Parameters:

  

    
data

  

  




Note:
0: Sunday, 1: Monday, 2: Tuesday, 



3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday 



Definition at line 185 of file RTC8564.cpp.











      

        

          void setYears 
          (
          uint8_t 
           data )
          
        

      







set years 


Parameters:

  

    
datalower 2 digits of the year. 

  

  




Note:
Currently 20xx is assumed. 



Definition at line 199 of file RTC8564.cpp.











      

        

          void start 
          (
          void 
           )
          
        

      







start RTC 


Note:
clear the STOP_BIT of the control1 register 



Definition at line 395 of file RTC8564.cpp.











      

        

          void stop 
          (
          void 
           )
          
        

      







stop RTC 


Note:
assert the STOP_BIT of the control1 register 



Definition at line 400 of file RTC8564.cpp.









Generated on Wed Aug 10 2022 01:48:37 by 

doxygen 1.7.2