リアルタイムクロック DS1307 の使い方

今回は秋月電子で販売されているこちらのリアルタイムクロック（以下RTC）のDS1307について紹介します。

1 RTCとは
2 DS1307の特徴
3 レジスタ
4 プログラム

RTCとは

まずはRTCについて説明します。電子工作で「クロック」といえば、普通は〇Hzのような一定の周波数の信号のことを指すことが多いですが、RTCは〇時〇分といった時刻を数えています。PIC等のマイコンで時計を作ろうとしたときに、一定の周波数の信号を数えれば時刻を計算することが出来ますが、その仕事をやってくれるICがRTCです。RTCを使用することでPICは他の計算に専念できたり、RTCにバックアップ電源を供給することでPICの電源を切っても時刻を保持できたりといった利点があります。

DS1307の特徴

秋月電子で取り扱っているものだけでもいくつかのRTCがありますが、DS1307の特徴としては以下のものが挙げられます。

I2C接続
バックアップ電源専用ピンあり
外付けの水晶発振子が必要

まずはインターフェースですが、I2C接続なので２本の信号線で接続できて便利です。

次に、バックアップ電源の専用ピンがついています。これがない場合は、主電源とバックアップ電源を切り替えたり逆流を防止したりする必要が生じますが、そのような問題を気にすることがなくなるのでとても便利です。

バックアップ電源には３Vのリチウム電池を繋ぐのが手軽で確実です。他にもダイオードとコンデンサを使って主電源から貯めておくという手段もあります。（主電源は５Vなので注意）

注意点としては、クロック源として32.768kHzの水晶発振子を外付けする必要があります。ただ水晶発振子は秋月電子で30円で買えますし、実装スペースも大して必要ないので、それほど気にすることでもないと思います。

レジスタ

ここからは実際の制御に必要な情報を見ていきます。DS1307のレジスタは次のようになっています。

00h ~ 06hに日付や時刻のデータが入っていて、07hが設定のレジスタとなっています。08h ~ 3Fhは自由に使えるRAMになっていて、バックアップ電源によって疑似的に不揮発メモリとして使っても良いかもしれません。

データはBCD (Binary Coded Decimal) という形になっていて、８ビットのうち上位４ビットが10の位、下位４ビットが１の位となっています。

扱いにくいと思うかもしれませんが、７セグLEDなど一桁ずつ制御する場合には都合が良いのだと思います。

次に「時」についてですが、12時間表示と24時間表示の好きな方を選べるようになっています。Hoursレジスタのbit 6が０であれば24時間表示、１であれば12時間表示となります。12時間表示の場合、10の位は１bitで足りるので、bit 5はPM/AMとなります。普通のBCD形式でデータを入力すれば、10の位の数は高々２なのでbit 6は０となり、24時間表示になります。

曜日を表すDayレジスタは１～７の値を取りますが、何曜日がどの数字かは決まっていないので、月曜始まりでも日曜始まりでも好きなように決めていいです。

ControlレジスタはSQW/OUTピンの矩形波出力に関するピンで、RSは周波数の設定、SQWEは矩形波出力のON/OFF、OUTは矩形波出力がOFFの場合の出力を設定します。（下図参照）

１Hzの矩形波はSecondsレジスタと同期しているので、これをマイコンに送れば秒まで同期可能です。

最後に、Secondsレジスタのbit 7にCH (Clock Halt) ビットがあります。リセット後はこのビットが１になっていてクロックが動かないので、必ず０にする必要があります。（私はこれに気付かず4~5時間頭を悩ませていました。なんでControlレジスタに入っていないんだよ～）

プログラム

DS1307と通信してデータを送受信するライブラリのようなものを書いてみました。

日付や時刻のデータは通信の簡単のために配列として、インデックスを定数として定義することで、例えば秒だったらdateTime[SEC] のように使うことにしました。

また、BCDのデータをそのままインクリメントする関数や、BCDと普通の数字を変換する関数も一応用意しておきました。

この中で使っているI2Cライブラリについてはこちらの記事をご覧ください。

#include "i2c.h"

#define DS 0b1101000
#define SEC   0
#define MIN   1
#define HOUR  2
#define DAY   3
#define DATE  4
#define MONTH 5
#define YEAR  6

char dateTime[7];

void GetDateTime(){
    SendI2C(DS, 0);
    GetDataI2C(DS, dateTime, 7);
}

void SetTimeDate(){
    for(char i=0; i<7; i++){
        CmdI2C(DS, i, dateTime[i]);
    }
    CmdI2C(DS, 7, 0x10);            //output 1Hz
}

char BCDincrement(char c){
    c++;
    if((c & 0x0F) == 10)
        c += 6;                     //繰り上がり(-10 + 16)
    return c;
}

char BCDtoBIN(char bcd){
    char bin = ((bcd >> 4) & 0x0F) * 10 + (bcd & 0x0F);
    return bin;
}

char BINtoBCD(char bin){
    char bcd = ((bin / 10) << 4 ) | (bin % 10);
    return bcd;

}

#include "i2c.h"

#define DS 0b1101000

#define SEC 0

#define MIN 1

#define HOUR 2

#define DAY 3

#define DATE 4

#define MONTH 5

#define YEAR 6

char dateTime[7];

void GetDateTime(){

SendI2C(DS, 0);

GetDataI2C(DS, dateTime, 7);

}

void SetTimeDate(){

for(char i=0; i<7; i++){

CmdI2C(DS, i, dateTime[i]);

}

CmdI2C(DS, 7, 0x10); //output 1Hz

}

char BCDincrement(char c){

c++;

if((c & 0x0F) == 10)

c += 6; //繰り上がり(-10 + 16)

return c;

}

char BCDtoBIN(char bcd){

char bin = ((bcd >> 4) & 0x0F) * 10 + (bcd & 0x0F);

return bin;

}

char BINtoBCD(char bin){

char bcd = ((bin / 10) << 4 ) | (bin % 10);

return bcd;

}

▼I2Cライブラリ

#include<xc.h>
#define _XTAL_FREQ 1000000

void I2C_Master_Init(const unsigned long c){
  SSP1CON1 = 0x28;                //SSP1 Module as Master
  SSP1CON2 = 0x00;
  SSP1CON3 = 0x00;
  SSP1ADD = (_XTAL_FREQ/(4*c))-1; //Setting Clock Speed
  SSP1STAT = 0x80;
  
  //SSP1CLKPPS = 0x0E;              //PPS Settings
  //SSP1DATPPS = 0x0C;              // SCL : RB6
  //RB6PPS = 0x18;                  // SDA : RB4
  //RB4PPS = 0x19;
}
void I2C_Master_Wait(){
  while ((SSP1STAT & 0x04) || (SSP1CON2 & 0x1F)); //Transmit is in progress
    
}
void I2C_Master_Start(){
  I2C_Master_Wait();    
  SSP1CON2bits.SEN = 1;           //Initiate start condition
}
void I2C_Master_RepeatedStart(){
  I2C_Master_Wait();
  SSP1CON2bits.RSEN = 1;          //Initiate repeated start condition
}
void I2C_Master_Stop(){
  I2C_Master_Wait();
  SSP1CON2bits.PEN = 1;           //Initiate stop condition
}
void I2C_Master_Write(unsigned d){
  I2C_Master_Wait();
  SSP1BUF = d;                    //Write data to SSP1BUF
}
unsigned short I2C_Master_Read(unsigned short a){
  unsigned short temp;
  I2C_Master_Wait();
  SSP1CON2bits.RCEN = 1;
  I2C_Master_Wait();
  temp = SSP1BUF;                 //Read data from SSP1BUF
  I2C_Master_Wait();
  SSP1CON2bits.ACKDT = a;         //Acknowledge bit		1:Not Ack	0:Ack
  SSP1CON2bits.ACKEN = 1;         //Acknowledge sequence
  return temp;
}
void SendI2C(char adrs, char data){
    I2C_Master_Start();
    I2C_Master_Write(adrs<<1);      //SlaveAdress + Write
    I2C_Master_Write(data);         //mainly RegisterAdress
    I2C_Master_Stop();
}
void CmdI2C(char adrs, char reg, char data){
    I2C_Master_Start();
    I2C_Master_Write(adrs<<1);      //SlaveAdress + Write
    I2C_Master_Write(reg);          //RegisterAdress
    I2C_Master_Write(data);
    I2C_Master_Stop();
}
void GetDataI2C(char adrs, char* buf, char cnt){
    I2C_Master_Start();
    I2C_Master_Write((adrs<<1)+1);      //SlaveAdress + Read
    for(char i=0; i<cnt-1; i++)
        buf[i] = I2C_Master_Read(0);    //ACK
    buf[cnt-1] = I2C_Master_Read(1);    //NACK
    I2C_Master_Stop();
}

#include<xc.h>

#define _XTAL_FREQ 1000000

void I2C_Master_Init(const unsigned long c){

SSP1CON1 = 0x28; //SSP1 Module as Master

SSP1CON2 = 0x00;

SSP1CON3 = 0x00;

SSP1ADD = (_XTAL_FREQ/(4*c))-1; //Setting Clock Speed

SSP1STAT = 0x80;

//SSP1CLKPPS = 0x0E; //PPS Settings

//SSP1DATPPS = 0x0C; // SCL : RB6

//RB6PPS = 0x18; // SDA : RB4

//RB4PPS = 0x19;

}

void I2C_Master_Wait(){

while ((SSP1STAT & 0x04) || (SSP1CON2 & 0x1F)); //Transmit is in progress

}

void I2C_Master_Start(){

I2C_Master_Wait();

SSP1CON2bits.SEN = 1; //Initiate start condition

}

void I2C_Master_RepeatedStart(){

I2C_Master_Wait();

SSP1CON2bits.RSEN = 1; //Initiate repeated start condition

}

void I2C_Master_Stop(){

I2C_Master_Wait();

SSP1CON2bits.PEN = 1; //Initiate stop condition

}

void I2C_Master_Write(unsigned d){

I2C_Master_Wait();

SSP1BUF = d; //Write data to SSP1BUF

}

unsigned short I2C_Master_Read(unsigned short a){

unsigned short temp;

I2C_Master_Wait();

SSP1CON2bits.RCEN = 1;

I2C_Master_Wait();

temp = SSP1BUF; //Read data from SSP1BUF

I2C_Master_Wait();

SSP1CON2bits.ACKDT = a; //Acknowledge bit 1:Not Ack 0:Ack

SSP1CON2bits.ACKEN = 1; //Acknowledge sequence

return temp;

}

void SendI2C(char adrs, char data){

I2C_Master_Start();

I2C_Master_Write(adrs<<1); //SlaveAdress + Write

I2C_Master_Write(data); //mainly RegisterAdress

I2C_Master_Stop();

}

void CmdI2C(char adrs, char reg, char data){

I2C_Master_Start();

I2C_Master_Write(adrs<<1); //SlaveAdress + Write

I2C_Master_Write(reg); //RegisterAdress

I2C_Master_Write(data);

I2C_Master_Stop();

}

void GetDataI2C(char adrs, char* buf, char cnt){

I2C_Master_Start();

I2C_Master_Write((adrs<<1)+1); //SlaveAdress + Read

for(char i=0; i<cnt-1; i++)

buf[i] = I2C_Master_Read(0); //ACK

buf[cnt-1] = I2C_Master_Read(1); //NACK

I2C_Master_Stop();

}

void I2C_Master_Init(const unsigned long c);
void I2C_Master_Wait();
void I2C_Master_Start();
void I2C_Master_RepeatedStart();
void I2C_Master_Stop();
void I2C_Master_Write(unsigned d);
unsigned short I2C_Master_Read(unsigned short a);
void SendI2C(char adrs, char data);
void CmdI2C(char adrs, char reg, char data);
void GetDataI2C(char adrs, char* buf, char cnt);

void I2C_Master_Init(const unsigned long c);

void I2C_Master_Wait();

void I2C_Master_Start();

void I2C_Master_RepeatedStart();

void I2C_Master_Stop();

void I2C_Master_Write(unsigned d);

unsigned short I2C_Master_Read(unsigned short a);

void SendI2C(char adrs, char data);

void CmdI2C(char adrs, char reg, char data);

void GetDataI2C(char adrs, char* buf, char cnt);

今回の記事は以上です。ご覧いただきありがとうございました。

この記事では都合上実際に動作テストはしていませんが、このICを使って卓上時計を作ったので実例はこちらをご覧ください。https://rikeden.net/?p=697