ErriezDS1302.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2020 Erriez
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef ERRIEZ_DS1302_H_
#define ERRIEZ_DS1302_H_

#include <Arduino.h>
#include <time.h>

#define DS1302_ACB              0x80    
#define DS1302_ACB_RAM          0x40    
#define DS1302_ACB_CLOCK        0x00    
#define DS1302_ACB_READ         0x01    
#define DS1302_ACB_WRITE        0x00    

#define DS1302_CMD_READ_CLOCK_REG(reg)  (DS1302_ACB | DS1302_ACB_CLOCK | (((reg) & 0x1F) << 1) | DS1302_ACB_READ)
#define DS1302_CMD_WRITE_CLOCK_REG(reg) (DS1302_ACB | DS1302_ACB_CLOCK | (((reg) & 0x1F) << 1) | DS1302_ACB_WRITE)
#define DS1302_CMD_READ_CLOCK_BURST     (DS1302_ACB | DS1302_ACB_CLOCK | 0x3E | DS1302_ACB_READ)
#define DS1302_CMD_WRITE_CLOCK_BURST    (DS1302_ACB | DS1302_ACB_CLOCK | 0x3E | DS1302_ACB_WRITE)
#define DS1302_CMD_READ_RAM(addr)       (DS1302_ACB | DS1302_ACB_RAM | (((addr) & 0x1F) << 1) | DS1302_ACB_READ)
#define DS1302_CMD_WRITE_RAM(addr)      (DS1302_ACB | DS1302_ACB_RAM | (((addr) & 0x1F) << 1) | DS1302_ACB_WRITE)
#define DS1302_CMD_READ_RAM_BURST       (DS1302_ACB | DS1302_ACB_RAM | 0x3E | DS1302_ACB_READ)
#define DS1302_CMD_WRITE_RAM_BURST      (DS1302_ACB | DS1302_ACB_RAM | 0x3E | DS1302_ACB_WRITE)

#define DS1302_REG_SECONDS      0x00    
#define DS1302_REG_MINUTES      0x01    
#define DS1302_REG_HOURS        0x02    
#define DS1302_REG_DAY_MONTH    0x03    
#define DS1302_REG_MONTH        0x04    
#define DS1302_REG_DAY_WEEK     0x05    
#define DS1302_REG_YEAR         0x06    
#define DS1302_REG_WP           0x07    
#define DS1302_REG_TC           0x08    

#define DS1302_NUM_CLOCK_REGS   7
#define DS1302_NUM_RAM_REGS     31

#define DS1302_SEC_CH           7       
#define DS1302_BIT_WP           7       
#define DS1302_BIT_READ         0       

#define DS1302_TCS_DISABLE      0x5C    

#ifdef __AVR
#define DS1302_CLK_LOW()        { *portOutputRegister(_clkPort) &= ~_clkBit; }  
#define DS1302_CLK_HIGH()       { *portOutputRegister(_clkPort) |= _clkBit; }   
#define DS1302_CLK_INPUT()      { *portModeRegister(_clkPort) &= ~_clkBit; }    
#define DS1302_CLK_OUTPUT()     { *portModeRegister(_clkPort) |= _clkBit; }     

#define DS1302_IO_LOW()        { *portOutputRegister(_ioPort) &= ~_ioBit; }  
#define DS1302_IO_HIGH()       { *portOutputRegister(_ioPort) |= _ioBit; }   
#define DS1302_IO_INPUT()      { *portModeRegister(_ioPort) &= ~_ioBit; }    
#define DS1302_IO_OUTPUT()     { *portModeRegister(_ioPort) |= _ioBit; }     
#define DS1302_IO_READ()       ( *portInputRegister(_ioPort) & _ioBit )      

#define DS1302_CE_LOW()        { *portOutputRegister(_cePort) &= ~_ceBit; }  
#define DS1302_CE_HIGH()       { *portOutputRegister(_cePort) |= _ceBit; }   
#define DS1302_CE_INPUT()      { *portModeRegister(_cePort) &= ~_ceBit; }    
#define DS1302_CE_OUTPUT()     { *portModeRegister(_cePort) |= _ceBit; }     
#else
#define DS1302_CLK_LOW()        { digitalWrite(_clkPin, LOW); }     
#define DS1302_CLK_HIGH()       { digitalWrite(_clkPin, HIGH); }    
#define DS1302_CLK_INPUT()      { pinMode(_clkPin, INPUT); }        
#define DS1302_CLK_OUTPUT()     { pinMode(_clkPin, OUTPUT); }       

#define DS1302_IO_LOW()        { digitalWrite(_ioPin, LOW); }       
#define DS1302_IO_HIGH()       { digitalWrite(_ioPin, HIGH); }      
#define DS1302_IO_INPUT()      { pinMode(_ioPin, INPUT); }          
#define DS1302_IO_OUTPUT()     { pinMode(_ioPin, OUTPUT); }         
#define DS1302_IO_READ()       ( digitalRead(_ioPin) )              

#define DS1302_CE_LOW()        { digitalWrite(_cePin, LOW); }       
#define DS1302_CE_HIGH()       { digitalWrite(_cePin, HIGH); }      
#define DS1302_CE_INPUT()      { pinMode(_cePin, INPUT); }          
#define DS1302_CE_OUTPUT()     { pinMode(_cePin, OUTPUT); }         
#endif

// Delay defines
#if F_CPU >= 20000000UL
#define DS1302_PIN_DELAY()      { delayMicroseconds(1); }           
#else
#define DS1302_PIN_DELAY()                                          
#endif


class ErriezDS1302
{
public:
    // Constructor
    ErriezDS1302(uint8_t clkPin, uint8_t ioPin, uint8_t cePin);
    bool begin();

    // Oscillator functions
    bool isRunning();
    bool clockEnable(bool enable=true);

    // Set/get date/time
    time_t getEpoch();
    bool setEpoch(time_t t);
    bool read(struct tm *dt);
    bool write(const struct tm *dt);
    bool setTime(uint8_t hour, uint8_t min, uint8_t sec);
    bool getTime(uint8_t *hour, uint8_t *min, uint8_t *sec);
    bool setDateTime(uint8_t hour, uint8_t min, uint8_t sec,
                     uint8_t mday, uint8_t mon, uint16_t year,
                     uint8_t wday);
    bool getDateTime(uint8_t *hour, uint8_t *min, uint8_t *sec,
                     uint8_t *mday, uint8_t *mon, uint16_t *year,
                     uint8_t *wday);

    // BCD conversions
    uint8_t bcdToDec(uint8_t bcd);
    uint8_t decToBcd(uint8_t dec);

    // Read/write register
    uint8_t readRegister(uint8_t reg);
    bool writeRegister(uint8_t reg, uint8_t value);

    // Read/write buffer
    bool readBuffer(uint8_t reg, void *buffer, uint8_t len);
    bool writeBuffer(uint8_t reg, void *buffer, uint8_t len);

    void writeByteRAM(uint8_t addr, uint8_t value);
    void writeBufferRAM(uint8_t *buf, uint8_t len);

    uint8_t readByteRAM(uint8_t addr);
    void readBufferRAM(uint8_t *buf, uint8_t len);

private:
#ifdef __AVR
    uint8_t _clkPort;   
    uint8_t _ioPort;    
    uint8_t _cePort;    

    uint8_t _clkBit;    
    uint8_t _ioBit;     
    uint8_t _ceBit;     
#else
    uint8_t _clkPin;    
    uint8_t _ioPin;     
    uint8_t _cePin;     
#endif

    // RTC interface functions
    void transferBegin();
    void transferEnd();
    void writeAddrCmd(uint8_t value);
    void writeByte(uint8_t value);
    uint8_t readByte();
};

#endif // ERRIEZ_DS1302_H_