driver_ds3231_alarm.c

Go to the documentation of this file.

 
#include "driver_ds3231_alarm.h"
 
static ds3231_handle_t gs_handle;        
static int8_t gs_time_zone = 0;          

uint8_t ds3231_alarm_irq_handler(void)
{
    /* irq handler */
    if (ds3231_irq_handler(&gs_handle) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_init(void (*alarm_receive_callback)(uint8_t type))
{
    uint8_t res;
    int8_t reg;
    
    /* link functions */
    DRIVER_DS3231_LINK_INIT(&gs_handle, ds3231_handle_t);
    DRIVER_DS3231_LINK_IIC_INIT(&gs_handle, ds3231_interface_iic_init);
    DRIVER_DS3231_LINK_IIC_DEINIT(&gs_handle, ds3231_interface_iic_deinit);
    DRIVER_DS3231_LINK_IIC_READ(&gs_handle, ds3231_interface_iic_read);
    DRIVER_DS3231_LINK_IIC_WRITE(&gs_handle, ds3231_interface_iic_write);
    DRIVER_DS3231_LINK_DELAY_MS(&gs_handle, ds3231_interface_delay_ms);
    DRIVER_DS3231_LINK_DEBUG_PRINT(&gs_handle, ds3231_interface_debug_print);
    DRIVER_DS3231_LINK_RECEIVE_CALLBACK(&gs_handle, alarm_receive_callback);
 
    /* init ds3231 */
    res = ds3231_init(&gs_handle);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: init failed.\n");
        
        return 1;
    }
    
    /* set oscillator */
    res = ds3231_set_oscillator(&gs_handle, DS3231_BOOL_TRUE);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: set oscillator failed.\n");
        (void)ds3231_deinit(&gs_handle);
        
        return 1;
    }
    
    /* set interrupt */
    res = ds3231_set_pin(&gs_handle, DS3231_PIN_INTERRUPT);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: set pin failed.\n");
        (void)ds3231_deinit(&gs_handle);
        
        return 1;
    }
    
    /* disable square wave */
    res = ds3231_set_square_wave(&gs_handle, DS3231_BOOL_FALSE);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: set square wave failed.\n");
        (void)ds3231_deinit(&gs_handle);
        
        return 1;
    }
    
    /* disable 32khz output */
    res = ds3231_set_32khz_output(&gs_handle, DS3231_BOOL_FALSE);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: set 32khz output failed.\n");
        (void)ds3231_deinit(&gs_handle);
        
        return 1;
    }
    
    /* convert to register */
    res = ds3231_aging_offset_convert_to_register(&gs_handle, DS3231_ALARM_DEFAULT_AGING_OFFSET, (int8_t *)&reg);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: convert to register failed.\n");
        (void)ds3231_deinit(&gs_handle);
        
        return 1;
    }
    
    /* set aging offset */
    res = ds3231_set_aging_offset(&gs_handle, reg);
    if (res != 0)
    {
        ds3231_interface_debug_print("ds3231: set aging offset failed.\n");
        (void)ds3231_deinit(&gs_handle);
        
        return 1;
    }
    
    return 0;
}

uint8_t ds3231_alarm_deinit(void)
{
    if (ds3231_deinit(&gs_handle) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_set_alarm1(ds3231_time_t *t, ds3231_alarm1_mode_t mode)
{
    /* set alarm1 */
    if (ds3231_set_alarm1(&gs_handle, t, mode) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_get_alarm1(ds3231_time_t *t, ds3231_alarm1_mode_t *mode)
{
    /* get alarm1 */
    if (ds3231_get_alarm1(&gs_handle, t, mode) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_set_alarm2(ds3231_time_t *t, ds3231_alarm2_mode_t mode)
{
    /* set alarm2 */
    if (ds3231_set_alarm2(&gs_handle, t, mode) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_get_alarm2(ds3231_time_t *t, ds3231_alarm2_mode_t *mode)
{
    /* get alarm2 */
    if (ds3231_get_alarm2(&gs_handle, t, mode) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_clear_flag(ds3231_alarm_t alarm)
{
    /* alarm clear */
    if (ds3231_alarm_clear(&gs_handle, alarm) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_enable(ds3231_alarm_t alarm)
{
    /* clear alarm flag */
    if (ds3231_alarm_clear(&gs_handle, alarm) != 0)
    {
        return 1;
    }
    
    /* enable alarm */
    if (ds3231_set_alarm_interrupt(&gs_handle, alarm, DS3231_BOOL_TRUE) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_disable(ds3231_alarm_t alarm)
{
    /* disable alarm */
    if (ds3231_set_alarm_interrupt(&gs_handle, alarm, DS3231_BOOL_FALSE) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_set_time(ds3231_time_t *t)
{
    /* set time */
    if (ds3231_set_time(&gs_handle, t) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_set_timestamp(time_t timestamp)
{
    ds3231_time_t t;
    struct tm *timeptr;
    
    /* convert times */
    timestamp += (time_t)(gs_time_zone * 3600);
    timeptr = localtime(&timestamp);
    t.am_pm = DS3231_AM;
    t.date = (uint8_t)timeptr->tm_mday;
    t.format = DS3231_FORMAT_24H;
    t.hour = (uint8_t)timeptr->tm_hour;
    t.minute = (uint8_t)timeptr->tm_min;
    t.month = (uint8_t)timeptr->tm_mon + 1;
    t.second = (uint8_t)timeptr->tm_sec;
    if (timeptr->tm_wday == 0)
    {
        t.week  = 7;
    }
    else
    {
        t.week = (uint8_t)timeptr->tm_wday;
    }
    t.year = (uint16_t)(timeptr->tm_year + 1900);
    
    /* set time */
    if (ds3231_set_time(&gs_handle, &t) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_set_timestamp_time_zone(int8_t zone)
{
    gs_time_zone = zone;
    
    return 0;
}

uint8_t ds3231_alarm_get_time(ds3231_time_t *t)
{
    /* get time */
    if (ds3231_get_time(&gs_handle, t) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_get_timestamp(time_t *timestamp)
{
    ds3231_time_t t;
    struct tm timeptr;
    
    /* get time */
    if (ds3231_get_time(&gs_handle, &t) != 0)
    {
        return 1;
    }
    timeptr.tm_year = t.year - 1900;
    timeptr.tm_mon = t.month - 1;
    timeptr.tm_wday = t.week; 
    timeptr.tm_mday = t.date;
    if (t.format == DS3231_FORMAT_24H)
    {
        timeptr.tm_hour = t.hour;
    }
    else
    {
        timeptr.tm_hour = t.hour % 12 + t.am_pm * 12;
    }
    timeptr.tm_min = t.minute;
    timeptr.tm_sec = t.second;
    
    /* make time */
    *timestamp = mktime(&timeptr) - gs_time_zone * 3600;
    
    return 0;
}

uint8_t ds3231_alarm_get_timestamp_time_zone(int8_t *zone)
{
    *zone = gs_time_zone;
    
    return 0;
}

uint8_t ds3231_alarm_get_temperature(int16_t *raw, float *s)
{
    /* get temperature */
    if (ds3231_get_temperature(&gs_handle, raw, s) != 0)
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

uint8_t ds3231_alarm_alarm_ascii_time(char *buf, uint8_t len)
{
    ds3231_time_t t;
    
    /* get time */
    if (ds3231_get_time(&gs_handle, &t) != 0)
    {
        return 1;
    }
    
    if (t.format == DS3231_FORMAT_24H)
    {
        (void)snprintf(buf, len, "%04d-%02d-%02d %02d:%02d:%02d %d.\n", t.year, t.month, t.date, t.hour, t.minute, t.second, t.week);
    }
    else
    {
        (void)snprintf(buf, len, "%04d-%02d-%02d %s %02d:%02d:%02d %d.\n", t.year, t.month, t.date, (t.am_pm == DS3231_AM) ? "AM" : "PM",
                       t.hour, t.minute, t.second, t.week
                      );
    }
    
    return 0;
}