driver_ds3231.h

Go to the documentation of this file.

 
#ifndef DRIVER_DS3231_H
#define DRIVER_DS3231_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    DS3231_BOOL_FALSE = 0x00,        
    DS3231_BOOL_TRUE  = 0x01,        
} ds3231_bool_t;

typedef enum
{
    DS3231_ALARM_1 = 0x00,        
    DS3231_ALARM_2 = 0x01,        
} ds3231_alarm_t;

typedef enum
{
    DS3231_AM = 0x00,        
    DS3231_PM = 0x01,        
} ds3231_am_pm_t;

typedef enum
{
    DS3231_PIN_SQUARE_WAVE = 0x00,        
    DS3231_PIN_INTERRUPT   = 0x01,        
} ds3231_pin_t;

typedef enum
{
    DS3231_FORMAT_12H = 0x01,        
    DS3231_FORMAT_24H = 0x00,        
} ds3231_format_t;

typedef enum
{
    DS3231_STATUS_ALARM_2 = (1 << 1),        
    DS3231_STATUS_ALARM_1 = (1 << 0),        
} ds3231_status_t;



typedef enum
{
    DS3231_ALARM1_MODE_ONCE_A_SECOND                 = 0x0F,        
    DS3231_ALARM1_MODE_SECOND_MATCH                  = 0x0E,        
    DS3231_ALARM1_MODE_MINUTE_SECOND_MATCH           = 0x0C,        
    DS3231_ALARM1_MODE_HOUR_MINUTE_SECOND_MATCH      = 0x08,        
    DS3231_ALARM1_MODE_DATE_HOUR_MINUTE_SECOND_MATCH = 0x00,        
    DS3231_ALARM1_MODE_WEEK_HOUR_MINUTE_SECOND_MATCH = 0x10,        
} ds3231_alarm1_mode_t;

typedef enum
{
    DS3231_ALARM2_MODE_ONCE_A_MINUTE          = 0x07,        
    DS3231_ALARM2_MODE_MINUTE_MATCH           = 0x06,        
    DS3231_ALARM2_MODE_HOUR_MINUTE_MATCH      = 0x04,        
    DS3231_ALARM2_MODE_DATE_HOUR_MINUTE_MATCH = 0x00,        
    DS3231_ALARM2_MODE_WEEK_HOUR_MINUTE_MATCH = 0x10,        
} ds3231_alarm2_mode_t;



typedef struct ds3231_time_s
{
    uint16_t year;                 
    uint8_t month;                 
    uint8_t week;                  
    uint8_t date;                  
    uint8_t hour;                  
    uint8_t minute;                
    uint8_t second;                
    ds3231_format_t format;        
    ds3231_am_pm_t am_pm;          
} ds3231_time_t;

typedef struct ds3231_handle_s
{
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    void (*debug_print)(const char *const fmt, ...);                                    
    void (*receive_callback)(uint8_t type);                                             
    void (*delay_ms)(uint32_t ms);                                                      
    uint8_t inited;                                                                     
} ds3231_handle_t;

typedef struct ds3231_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} ds3231_info_t;



#define DRIVER_DS3231_LINK_INIT(HANDLE, STRUCTURE)         memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_DS3231_LINK_IIC_INIT(HANDLE, FUC)          (HANDLE)->iic_init = FUC

#define DRIVER_DS3231_LINK_IIC_DEINIT(HANDLE, FUC)        (HANDLE)->iic_deinit = FUC

#define DRIVER_DS3231_LINK_IIC_READ(HANDLE, FUC)          (HANDLE)->iic_read = FUC

#define DRIVER_DS3231_LINK_IIC_WRITE(HANDLE, FUC)         (HANDLE)->iic_write = FUC

#define DRIVER_DS3231_LINK_DELAY_MS(HANDLE, FUC)          (HANDLE)->delay_ms = FUC

#define DRIVER_DS3231_LINK_DEBUG_PRINT(HANDLE, FUC)       (HANDLE)->debug_print = FUC

#define DRIVER_DS3231_LINK_RECEIVE_CALLBACK(HANDLE, FUC)  (HANDLE)->receive_callback = FUC



uint8_t ds3231_info(ds3231_info_t *info);

uint8_t ds3231_init(ds3231_handle_t *handle);

uint8_t ds3231_deinit(ds3231_handle_t *handle);

uint8_t ds3231_irq_handler(ds3231_handle_t *handle);

uint8_t ds3231_set_time(ds3231_handle_t *handle, ds3231_time_t *t);

uint8_t ds3231_get_time(ds3231_handle_t *handle, ds3231_time_t *t);

uint8_t ds3231_set_oscillator(ds3231_handle_t *handle, ds3231_bool_t enable);

uint8_t ds3231_get_oscillator(ds3231_handle_t *handle, ds3231_bool_t *enable);

uint8_t ds3231_get_status(ds3231_handle_t *handle, uint8_t *status);



uint8_t ds3231_set_pin(ds3231_handle_t *handle, ds3231_pin_t pin);

uint8_t ds3231_get_pin(ds3231_handle_t *handle, ds3231_pin_t *pin);

uint8_t ds3231_set_square_wave(ds3231_handle_t *handle, ds3231_bool_t enable);

uint8_t ds3231_get_square_wave(ds3231_handle_t *handle, ds3231_bool_t *enable);

uint8_t ds3231_set_32khz_output(ds3231_handle_t *handle, ds3231_bool_t enable);

uint8_t ds3231_get_32khz_output(ds3231_handle_t *handle, ds3231_bool_t *enable);

uint8_t ds3231_get_temperature(ds3231_handle_t *handle, int16_t *raw, float *s);

uint8_t ds3231_set_aging_offset(ds3231_handle_t *handle, int8_t offset);

uint8_t ds3231_get_aging_offset(ds3231_handle_t *handle, int8_t *offset);

uint8_t ds3231_aging_offset_convert_to_register(ds3231_handle_t *handle, float offset, int8_t *reg);

uint8_t ds3231_aging_offset_convert_to_data(ds3231_handle_t *handle, int8_t reg, float *offset);



uint8_t ds3231_set_alarm_interrupt(ds3231_handle_t *handle, ds3231_alarm_t alarm, ds3231_bool_t enable);

uint8_t ds3231_get_alarm_interrupt(ds3231_handle_t *handle, ds3231_alarm_t alarm, ds3231_bool_t *enable);

uint8_t ds3231_set_alarm1(ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm1_mode_t mode);

uint8_t ds3231_get_alarm1(ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm1_mode_t *mode);

uint8_t ds3231_set_alarm2(ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm2_mode_t mode);

uint8_t ds3231_get_alarm2(ds3231_handle_t *handle, ds3231_time_t *t, ds3231_alarm2_mode_t *mode);

uint8_t ds3231_alarm_clear(ds3231_handle_t *handle, ds3231_alarm_t alarm);



uint8_t ds3231_set_reg(ds3231_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t ds3231_get_reg(ds3231_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif