rtc3 2.0.0.0
rtc3.h File Reference

This file contains API for RTC 3 Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  date_data_t
 Date data structure. More...
 
struct  time_data_t
 Time data structure. More...
 
struct  rtc3_t
 Click ctx object definition. More...
 
struct  rtc3_cfg_t
 Click configuration structure definition. More...
 

Macros

#define RTC3_MAP_MIKROBUS(cfg, mikrobus)
 
#define RTC3_I2C_ADDRESS   0x68
 
#define RTC3_REG_TIME_SEC   0x00
 
#define RTC3_REG_TIME_MIN   0x01
 
#define RTC3_REG_TIME_HOUR   0x02
 
#define RTC3_REG_TIME_DAY_OF_THE_WEEK   0x03
 
#define RTC3_REG_TIME_DATE_DAY   0x04
 
#define RTC3_REG_TIME_DATE_MONTH   0x05
 
#define RTC3_REG_TIME_DATE_YEAR   0x06
 
#define RTC3_REG_CONFIG1   0x07
 
#define RTC3_REG_TRICKLE_CHARGE2   0x08
 
#define RTC3_REG_CONFIG2   0x09
 
#define RTC3_REG_SF_KEY1   0x20
 
#define RTC3_REG_SF_KEY2   0x21
 
#define RTC3_REG_SFR   0x22
 
#define RTC3_ENABLE_COUNTING   0x7F
 
#define RTC3_DISABLE_COUNTING   0x80
 
#define RTC3_CONFIG1_INITIAL   0x80
 
#define RTC3_TCH2_OPEN   0x00
 
#define RTC3_TCH2_CLOSED   0x20
 
#define RTC3_TCFE_OPEN   0x00
 
#define RTC3_TCFE_CLOSED   0x20
 
#define RTC3_FTF_NORMAL_512_HZ   0x00
 
#define RTC3_FTF_1_HZ   0x01
 
#define RTC3_OK   0
 
#define RTC3_ERROR   -1
 

Functions

void rtc3_cfg_setup (rtc3_cfg_t *cfg)
 Config Object Initialization function.
 
err_t rtc3_init (rtc3_t *ctx, rtc3_cfg_t *cfg)
 Initialization function.
 
void rtc3_generic_write (rtc3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void rtc3_generic_read (rtc3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
void rtc3_set_counting (rtc3_t *ctx, uint8_t en_dis)
 Enable/Disable counting function.
 
void rtc3_set_time (rtc3_t *ctx)
 Set time hours, minutes, seconds function.
 
void rtc3_get_time (rtc3_t *ctx)
 Get time hours, minutes, seconds function.
 
void rtc3_set_date (rtc3_t *ctx)
 Set day of the week, day, month and year function.
 
void rtc3_get_date (rtc3_t *ctx)
 Get day of the week, day, month and year function.
 
void rtc3_set_calibration (rtc3_t *ctx, uint8_t cal_sign, uint8_t cal_mumber)
 Set calibration function.
 
void rtc3_set_trickle_charge (rtc3_t *ctx, uint8_t tch2)
 Set trickle charge control function.
 
void rtc3_set_trickle_charge_bypass (rtc3_t *ctx, uint8_t tcfe)
 Set trickle charge bypass control function.
 
void rtc3_set_special_function_key1 (rtc3_t *ctx, uint8_t sfkey1)
 Set special function key byte 1 function.
 
void rtc3_set_special_function_key2 (rtc3_t *ctx, uint8_t sfkey2)
 Set special function key byte 2 function.
 
void rtc3_set_frequency_calibration (rtc3_t *ctx, uint8_t ftf)
 Set frequency calibration control function.
 
uint8_t rtc3_get_interrupt (rtc3_t *ctx)
 Get state of interrupt pin function.
 

Detailed Description

This file contains API for RTC 3 Click driver.