DS3231.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
#ifdef ARDUINO
 
 
#include <stdint.h>
#include <stddef.h>
 
#include "freertos/FreeRTOS.h"
 
#include "fabglconf.h"
#include "fabutils.h"
#include "comdrivers/tsi2c.h"
 
 
 
namespace fabgl {
 
 
struct DateTime {
  int8_t  seconds;      
  int8_t  minutes;      
  int8_t  hours;        
  int8_t  dayOfWeek;    
  int8_t  dayOfMonth;   
  int8_t  month;        
  int16_t year;         
  DateTime() { }
  DateTime(int seconds_, int minutes_, int hours_, int dayOfMonth_, int month_, int year_);
 
  time_t timestamp(int timezone);
 
private:
  void calcDayOfWeek();
};
 
 
class DS3231 {
 
public:
 
  DS3231();
 
  void begin(I2C * i2c);
 
  bool available() { return m_available; }
 
  bool dateTimeValid() { return m_dateTimeValid; }
 
  DateTime const & datetime();
 
  bool setDateTime(DateTime const & value);
 
  double temperature();
 
  void clockEnabled(bool value);
 
private:
 
  uint8_t readReg(int reg);
 
  bool writeReg(int reg, int value);
 
  I2C *    m_i2c;
  bool     m_available;
  bool     m_dateTimeValid;
 
  DateTime m_datetime;
 
 
};
 
 
 
} // fabgl namespace
 
 
#endif  // #ifdef ARDUINO