rtc4.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 RTC4_H
#define RTC4_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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_one_wire.h"
 
#define RTC4_CMD_READ_CLOCK             0x66
#define RTC4_CMD_WRITE_CLOCK            0x99
 
 // rtc4_cmd
 
#define RTC4_SEC_PER_MINUTE             60
#define RTC4_SEC_PER_HOUR               3600
#define RTC4_SEC_PER_DAY                86400 
#define RTC4_START_YEAR                 1970
#define RTC4_DAYS_PER_LEAP_YEAR         366      
#define RTC4_DAYS_PER_YEAR              365 
#define RTC4_DAYS_IN_FEB                29 
 
 // rtc4_time
 
#define RTC4_DCB_INT_ENABLE             0x80
#define RTC4_DCB_OSC_ENABLE             0x0C
#define RTC4_DCB_INTERVAL_1S            0x00
#define RTC4_DCB_INTERVAL_4S            0x10
#define RTC4_DCB_INTERVAL_32S           0x20
#define RTC4_DCB_INTERVAL_64S           0x30
#define RTC4_DCB_INTERVAL_2048S         0x40
#define RTC4_DCB_INTERVAL_4096S         0x50
#define RTC4_DCB_INTERVAL_65536S        0x60  
#define RTC4_DCB_INTERVAL_131072S       0x70
 
#define RTC4_FAMILY_CODE                0x27
 
 // rtc4_set
 
#define RTC4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc4_map
 
 // rtc4
 
typedef struct 
{
    uint32_t hours; 
    uint32_t min;
    uint32_t sec; 
    
} rtc4_time_t;
 
typedef struct 
{
    uint32_t year;
    uint32_t month;
    uint32_t day;
 
} rtc4_date_t;
 
typedef enum
{
    RTC4_GPIO_0,                        
    RTC4_GPIO_1                         
} rtc4_gpio_sel_t;
 
typedef struct
{
    //Input pins
    digital_in_t int_pin;               
    //Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t address;                    
} rtc4_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t gp1;                     
    // Additional gpio pins
    pin_name_t int_pin;                 
    rtc4_gpio_sel_t gpio_sel;           
} rtc4_cfg_t;
 
typedef enum
{
    RTC4_OK = 0,
    RTC4_ERROR = -1
 
} rtc4_return_value_t;
 
void rtc4_cfg_setup ( rtc4_cfg_t *cfg );
 
void rtc4_gpio_selection ( rtc4_cfg_t *cfg, rtc4_gpio_sel_t gpio_sel );
 
err_t rtc4_init ( rtc4_t *ctx, rtc4_cfg_t *cfg );
 
err_t rtc4_check_communication ( rtc4_t *ctx );
 
uint8_t rtc4_get_interrupt ( rtc4_t *ctx ); 
 
err_t rtc4_set_unix_and_int ( rtc4_t *ctx, uint32_t unix_time, uint8_t int_interval ); 
 
err_t rtc4_get_unix_time ( rtc4_t *ctx, uint32_t *unix_time ); 
 
void rtc4_unix_to_date_time ( uint32_t unix_time, rtc4_time_t *time, rtc4_date_t *date ); 
 
void rtc4_date_time_to_unix ( rtc4_date_t *date, rtc4_time_t *time, uint32_t *unix_time );
 
err_t rtc4_set_date_time ( rtc4_t *ctx, rtc4_date_t *date, rtc4_time_t *time, uint8_t int_interval );
 
err_t rtc4_get_date_time ( rtc4_t *ctx, rtc4_date_t *date, rtc4_time_t *time );
 
#ifdef __cplusplus
}
#endif
#endif // RTC4_H
 
 // rtc4
 
// ------------------------------------------------------------------------ END