ds3231.h

Go to the documentation of this file.

/* Copyright 2013-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the software nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BSP430_CHIPS_DS3231_H
#define BSP430_CHIPS_DS3231_H

#include <bsp430/core.h>
#include <time.h>

#define DS3231_I2C_ADDRESS 0x68

#if defined(BSP430_DOXYGEN)
struct sDS3231registers
#else /* BSP430_DOXYGEN */
BSP430_CORE_PACKED_STRUCT(sDS3231registers)
#endif /* BSP430_DOXYGEN */
{
  uint8_t seconds;              
  uint8_t minutes;              
  uint8_t hours;                
  uint8_t dow;                  
  uint8_t dom;                  
  uint8_t mon_cen;              
  uint8_t year;                 
  uint8_t alrm1_sec;            
  uint8_t alrm1_min;            
  uint8_t alrm1_hr;             
  uint8_t alrm1_doa;            
  uint8_t alrm2_min;            
  uint8_t alrm2_hr;             
  uint8_t alrm2_doa;            
  uint8_t ctrl;                 
  uint8_t stat;                 
  uint8_t aging;                
  uint8_t temp_msb;             
  uint8_t temp_lsb;             
};
typedef struct sDS3231registers sDS3231registers;

uint8_t ucDS3231encodeHour (unsigned int hours,
                            int is_12h);

unsigned int uiDS3231decodeHour (uint8_t hour_ds3231);

const struct tm *
xDS3231registersToTm (const sDS3231registers * regp,
                      struct tm * timep);

const sDS3231registers *
xDS3231tmToRegisters (const struct tm * timep,
                      sDS3231registers * regp);

#endif /* BSP430_CHIPS_DS3231_H */