ds3231.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef DS3231_H
#define DS3231_H
 
#include <time.h>
#include <errno.h>
 
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DS3231_I2C_ADDR             0x68
 
enum {
    DS3231_OPT_BAT_ENABLE = 0x01,   /* enable backup battery on startup */
    DS2321_OPT_32KHZ_ENABLE = 0x02, /* enable 32KHz output */
};
 
typedef struct {
    i2c_t bus;          
} ds3231_t;
 
typedef struct {
    i2c_t bus;          
    uint8_t opt;        
} ds3231_params_t;
 
int ds3231_init(ds3231_t *dev, const ds3231_params_t *params);
 
int ds3231_get_time(const ds3231_t *dev, struct tm *time);
 
int ds3231_set_time(const ds3231_t *dev, const struct tm *time);
 
int ds3231_get_aging_offset(const ds3231_t *dev, int8_t *offset);
 
int ds3231_set_aging_offset(const ds3231_t *dev, int8_t offset);
 
int ds3231_get_temp(const ds3231_t *dev, int16_t *temp);
 
int ds3231_enable_bat(const ds3231_t *dev);
 
int ds3231_disable_bat(const ds3231_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DS3231_H */