ds3231.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <time.h>
#include <errno.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define DS3231_I2C_ADDR             0x68

#define DS3231_FLAG_ALARM_1         0x01
#define DS3231_FLAG_ALARM_2         0x02

enum {
    DS3231_OPT_BAT_ENABLE = 0x01,   
    DS3221_OPT_32KHZ_ENABLE = 0x02, 
    DS3231_OPT_INTER_ENABLE = 0x04, 
};

typedef enum {
    DS3231_AL1_TRIG_PER_S = 0x0F, 
    DS3231_AL1_TRIG_S = 0x0E, 
    DS3231_AL1_TRIG_M_S = 0x0C, 
    DS3231_AL1_TRIG_H_M_S = 0x08, 
    DS3231_AL1_TRIG_D_H_M_S = 0x00, 
} ds3231_alm_1_mode_t;

typedef enum {
    DS3231_AL2_TRIG_PER_M = 0x07,  
    DS3231_AL2_TRIG_M = 0x06,  
    DS3231_AL2_TRIG_H_M = 0x04,  
    DS3231_AL2_TRIG_D_H_M_S = 0x00, 
} ds3231_alm_2_mode_t;

typedef struct {
    i2c_t bus;          
#if IS_USED(MODULE_DS3231_INT)
    gpio_t int_pin;     
#endif /* MODULE_DS3231_INT */
} ds3231_t;

typedef struct {
    i2c_t bus;          
    uint8_t opt;        
#if IS_USED(MODULE_DS3231_INT)
    gpio_t int_pin;     
#endif /* MODULE_DS3231_INT */
} ds3231_params_t;
 
#if IS_USED(MODULE_DS3231_INT)
typedef void (*ds3231_alarm_cb_t)(void *);
 
#endif /* MODULE_DS3231_INT */

int ds3231_init(ds3231_t *dev, const ds3231_params_t *params);
 
#if IS_USED(MODULE_DS3231_INT)
int ds3231_await_alarm(ds3231_t *dev);
#endif /* MODULE_DS3231_INT */

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_set_alarm_1(const ds3231_t *dev, struct tm *time,
                       ds3231_alm_1_mode_t trigger);

int ds3231_set_alarm_2(const ds3231_t *dev, struct tm *time,
                       ds3231_alm_2_mode_t trigger);

int ds3231_clear_alarm_1_flag(const ds3231_t *dev);

int ds3231_clear_alarm_2_flag(const ds3231_t *dev);

int ds3231_get_alarm_1_flag(const ds3231_t *dev, bool *flag);

int ds3231_get_alarm_2_flag(const ds3231_t *dev, bool *flag);

int ds3231_toggle_alarm_1(const ds3231_t *dev, bool enable);

int ds3231_toggle_alarm_2(const ds3231_t *dev, bool enable);

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