ds3231.h

Go to the documentation of this file.

// Copyright 2021 IOsetting <iosetting(at)outlook.com>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef __FW_DS3231_H__
#define __FW_DS3231_H__
 
 
#include "fw_hal.h"
 
#define DS3231_I2C_ADDR                 0xD0        
#define DS3231_REG_SECOND               0x00        
#define DS3231_REG_MINUTE               0x01        
#define DS3231_REG_HOUR                 0x02        
#define DS3231_REG_WEEK                 0x03        
#define DS3231_REG_DATE                 0x04        
#define DS3231_REG_MONTH                0x05        
#define DS3231_REG_YEAR                 0x06        
#define DS3231_REG_ALARM1_SECOND        0x07        
#define DS3231_REG_ALARM1_MINUTE        0x08        
#define DS3231_REG_ALARM1_HOUR          0x09        
#define DS3231_REG_ALARM1_WEEK          0x0A        
#define DS3231_REG_ALARM2_MINUTE        0x0B        
#define DS3231_REG_ALARM2_HOUR          0x0C        
#define DS3231_REG_ALARM2_WEEK          0x0D        
#define DS3231_REG_CONTROL              0x0E        
#define DS3231_REG_STATUS               0x0F        
#define DS3231_REG_XTAL                 0x10        
#define DS3231_REG_TEMPERATUREH         0x11        
#define DS3231_REG_TEMPERATUREL         0x12        
typedef enum
{
    DS3231_ALARM_1 = 0x00,        
    DS3231_ALARM_2 = 0x01,        
} DS3231_Alarm_t;
 
typedef enum
{
    DS3231_AM = 0x00,        
    DS3231_PM = 0x01,        
} DS3231_AmPm_t;
 
typedef enum
{
    DS3231_PIN_SQUARE_WAVE = 0x00,        
    DS3231_PIN_INTERRUPT   = 0x01,        
} DS3231_PinType_t;
 
typedef enum
{
    DS3231_FORMAT_12H = 0x01,        
    DS3231_FORMAT_24H = 0x00,        
} DS3231_HourFormat_t;
 
typedef enum
{
    DS3231_STATUS_ALARM_2 = (1 << 1),        
    DS3231_STATUS_ALARM_1 = (1 << 0),        
} DS3231_AlarmStatus_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_Alarm1Mode_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_Alarm2Mode_t;
 
 
uint8_t DS3231_GetStatus(void);
 
uint8_t DS3231_GetTime(uint8_t *t);
uint8_t DS3231_SetTime(uint8_t *t);
uint8_t DS3231_GetPin(DS3231_PinType_t *pin);
uint8_t DS3231_SetPin(DS3231_PinType_t *pin);
 
uint8_t ds3231_GetSquareOutputState(HAL_State_t *state);
uint8_t DS3231_SetSquareOutputState(HAL_State_t state);
uint8_t DS3231_GetAlarmInterrupt(DS3231_Alarm_t alarm, HAL_State_t *state);
uint8_t DS3231_SetAlarmInterrupt(DS3231_Alarm_t alarm, HAL_State_t state);
 
uint8_t DS3231_GetAlarm1(uint8_t *t, DS3231_Alarm1Mode_t *mode);
uint8_t DS3231_SetAlarm1(uint8_t *t, DS3231_Alarm1Mode_t mode);
uint8_t DS3231_GetAlarm2(uint8_t *t, DS3231_Alarm2Mode_t *mode);
uint8_t DS3231_SetAlarm2(uint8_t *t, DS3231_Alarm2Mode_t mode);
uint8_t DS3231_ClearAlarm(DS3231_Alarm_t alarm);
 
#endif