rtc10.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
// ----------------------------------------------------------------------------
 
#ifndef RTC10_H
#define RTC10_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define RTC10_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define RTC10_RETVAL  uint8_t
 
#define RTC10_OK           0x00
#define RTC10_INIT_ERROR   0xFF
#define RTC10_I2C_SLAVE_ADDRESS                                  0x68
#define RTC10_RTCSEC                                             0x00
#define RTC10_RTCMIN                                             0x01
#define RTC10_RTCHOUR                                            0x02
#define RTC10_RTCWKDAY                                           0x03
#define RTC10_RTCDATE                                            0x04
#define RTC10_RTCMTH                                             0x05
#define RTC10_RTCYEAR                                            0x06
#define RTC10_ALM1SEC                                            0x07
#define RTC10_ALM1MIN                                            0x08
#define RTC10_ALM1HOUR                                           0x09
#define RTC10_ALM1DATE                                           0x0A
#define RTC10_ALM2MIN                                            0x0B
#define RTC10_ALM2HOUR                                           0x0C
#define RTC10_ALM2DATE                                           0x0D
#define RTC10_CONTROL                                            0x0E
#define RTC10_STATUS                                             0x0F
#define RTC10_AGING                                              0x10
#define RTC10_TEMPERATURE_MSB                                    0x11
#define RTC10_TEMPERATURE_LSB                                    0x12
#define RTC10_DISABLE_ALARMS                                     0x00
#define RTC10_ENABLE_ALARM_1                                     0x01
#define RTC10_ENABLE_ALARM_2                                     0x02
#define RTC10_ENABLE_INTERRUPT                                   0x04
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t an;
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} rtc10_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t an;
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} rtc10_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rtc10_cfg_setup ( rtc10_cfg_t *cfg );
 
RTC10_RETVAL rtc10_init ( rtc10_t *ctx, rtc10_cfg_t *cfg );
 
void rtc10_default_cfg ( rtc10_t *ctx );
 
void rtc10_generic_write ( rtc10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc10_generic_read ( rtc10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc10_hw_reset ( rtc10_t *ctx );
 
uint8_t rtc10_check_interrupt ( rtc10_t *ctx );
 
uint8_t rtc10_read_byte ( rtc10_t *ctx, uint8_t reg_address );
 
void rtc10_write_byte ( rtc10_t *ctx, uint8_t reg_address, uint8_t write_data );
 
uint8_t rtc10_get_time_seconds ( rtc10_t *ctx );
 
void rtc10_set_time_seconds ( rtc10_t *ctx, uint8_t seconds );
 
uint8_t rtc10_get_time_minutes ( rtc10_t *ctx );
 
void rtc10_set_time_minutes ( rtc10_t *ctx, uint8_t minutes );
 
uint8_t rtc10_get_century_flag ( rtc10_t *ctx );
 
void rtc10_set_century_flag ( rtc10_t *ctx );
 
uint8_t rtc10_get_time_hours ( rtc10_t *ctx );
 
void rtc10_set_time_hours( rtc10_t *ctx, uint8_t hours );
 
uint8_t rtc10_get_day_of_the_week ( rtc10_t *ctx );
 
void rtc10_set_day_of_the_week ( rtc10_t *ctx, uint8_t w_day );
 
uint8_t rtc10_get_date_day ( rtc10_t *ctx );
 
void rtc10_set_date_day ( rtc10_t *ctx, uint8_t date_day );
 
uint8_t rtc10_get_date_month ( rtc10_t *ctx );
 
void rtc10_set_date_month( rtc10_t *ctx, uint8_t date_month );
 
uint8_t rtc10_get_date_year ( rtc10_t *ctx );
 
void rtc10_set_date_year ( rtc10_t *ctx, uint16_t date_year );
 
void rtc10_set_time ( rtc10_t *ctx, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds );
 
void rtc10_get_time ( rtc10_t *ctx, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
 
void rtc10_set_date( rtc10_t *ctx, uint8_t day_of_the_week, uint8_t date_day, uint8_t date_month, uint16_t date_year );
 
void rtc10_get_date( rtc10_t *ctx, uint8_t *day_of_the_week, uint8_t *date_day, uint8_t *date_month, uint8_t *date_year );
 
uint8_t rtc10_get_alarm_time_seconds ( rtc10_t *ctx );
 
void rtc10_set_alarm_time_seconds ( rtc10_t *ctx, uint8_t seconds );
 
uint8_t rtc10_get_alarm_time_minutes ( rtc10_t *ctx );
 
void rtc10_set_alarm_time_minutes( rtc10_t *ctx, uint8_t minutes );
 
uint8_t rtc10_get_alarm_time_hours ( rtc10_t *ctx );
 
void rtc10_set_alarm_time_hours ( rtc10_t *ctx, uint8_t hours );
 
uint8_t rtc10_get_alarm_date_day ( rtc10_t *ctx );
 
void rtc10_set_alarm_date_day ( rtc10_t *ctx, uint8_t date_day );
 
void rtc10_set_first_alarm ( rtc10_t *ctx, uint8_t time_days, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds );
 
void rtc10_get_first_alarm ( rtc10_t *ctx, uint8_t *time_days, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
 
void rtc10_set_second_alarm( rtc10_t *ctx, uint8_t time_days, uint8_t time_hours, uint8_t time_minutes );
 
void rtc10_get_second_alarm ( rtc10_t *ctx, uint8_t *time_days, uint8_t *time_hours, uint8_t *time_minutes );
 
void rtc10_enable_counting ( rtc10_t *ctx );
 
void rtc10_set_config( rtc10_t *ctx, uint8_t config_data );
 
uint8_t rtc10_get_status ( rtc10_t *ctx );
 
float rtc10_get_temperature ( rtc10_t *ctx );
 
 
 
#ifdef __cplusplus
}
#endif
#endif  // _RTC10_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END