ErriezDS1307.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_DS1307_H_
#define ERRIEZ_DS1307_H_

#include <stdint.h>
#include <time.h>

#define DS1307_REG_SECONDS      0x00    
#define DS1307_REG_MINUTES      0x01    
#define DS1307_REG_HOURS        0x02    
#define DS1307_REG_DAY_WEEK     0x03    
#define DS1307_REG_DAY_MONTH    0x04    
#define DS1307_REG_MONTH        0x05    
#define DS1307_REG_YEAR         0x06    
#define DS1307_REG_CONTROL      0x07    

#define DS1307_NUM_REGS         8       

#define DS1307_SEC_CH           7       
#define DS1307_HOUR_12H_24H     6       
#define DS1307_HOUR_AM_PM       5       

#define DS1307_CTRL_OUT         7       
#define DS1307_CTRL_SQWE        4       
#define DS1307_CTRL_RS1         1       
#define DS1307_CTRL_RS0         0       

#define DS1307_ADDR             (0xD0 >> 1)

typedef enum {
    SquareWaveDisable = ((0 << DS1307_CTRL_SQWE) | (0 << DS1307_CTRL_RS1) | (0 << DS1307_CTRL_RS0)),  
    SquareWave1Hz = ((1 << DS1307_CTRL_SQWE) | (0 << DS1307_CTRL_RS1) | (0 << DS1307_CTRL_RS0)),      
    SquareWave4096Hz = ((1 << DS1307_CTRL_SQWE) | (0 << DS1307_CTRL_RS1) | (1 << DS1307_CTRL_RS0)),   
    SquareWave8192Hz = ((1 << DS1307_CTRL_SQWE) | (1 << DS1307_CTRL_RS1) | (0 << DS1307_CTRL_RS0)),   
    SquareWave32768Hz = ((1 << DS1307_CTRL_SQWE) | (1 << DS1307_CTRL_RS1) | (1 << DS1307_CTRL_RS0)),  
} SquareWave;


class ErriezDS1307
{
public:
    // Initialize
    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);

    // Output signal control
    bool setSquareWave(SquareWave squareWave);

    // 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);
};

#endif // ERRIEZ_DS1307_H_