rtc14.h File Reference

This file contains API for RTC 14 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	rtc14_t
	RTC 14 Click context object. More...
struct	rtc14_cfg_t
	RTC 14 Click configuration object. More...
struct	rtc14_time_t
	RTC 14 Click time object. More...
struct	rtc14_date_t
	RTC 14 Click date object. More...
struct	rtc14_alarm_t
	RTC 14 Click alarm object. More...
struct	rtc14_time_stamp_t
	RTC 14 Click time stamp object. More...

Macros
#define	RTC14_REG_SC   0x00
	RTC 14 description register.
#define	RTC14_REG_MN   0x01
#define	RTC14_REG_HR   0x02
#define	RTC14_REG_DT   0x03
#define	RTC14_REG_MO   0x04
#define	RTC14_REG_YR   0x05
#define	RTC14_REG_DW   0x06
#define	RTC14_REG_SR   0x07
#define	RTC14_REG_INT   0x08
#define	RTC14_REG_ATR   0x0A
#define	RTC14_REG_DTR   0x0B
#define	RTC14_REG_SCA   0x0C
#define	RTC14_REG_MNA   0x0D
#define	RTC14_REG_HRA   0x0E
#define	RTC14_REG_DTA   0x0F
#define	RTC14_REG_MOA   0x10
#define	RTC14_REG_DWA   0x11
#define	RTC14_REG_USR1   0x12
#define	RTC14_REG_USR2   0x13
#define	RTC14_REG_SCT   0x14
#define	RTC14_REG_MNT   0x15
#define	RTC14_REG_HRT   0x16
#define	RTC14_REG_DTT   0x17
#define	RTC14_REG_MOT   0x18
#define	RTC14_REG_YRT   0x19
#define	RTC14_SET_HOURS_FORMAT_12   0x00
	RTC 14 description setting.
#define	RTC14_SET_HOURS_FORMAT_24   0x80
#define	RTC14_SET_HOURS_FORMAT_12_AM   0x00
#define	RTC14_SET_HOURS_FORMAT_12_PM   0x20
#define	RTC14_SET_ALARM_ENABLE   0x80
#define	RTC14_SET_INT_ENABLE   0x40
#define	RTC14_SET_SOFT_RESET   0x80
#define	RTC14_SET_ENABLE_WRTC   0x10
#define	RTC14_DW_SUNDAY   0x00
	RTC 14 Days of the Week.
#define	RTC14_DW_MONDAY   0x01
#define	RTC14_DW_TUESDAY   0x02
#define	RTC14_DW_WEDNESDAY   0x03
#define	RTC14_DW_THURSDAY   0x04
#define	RTC14_DW_FRIDAY   0x05
#define	RTC14_DW_SATURDAY   0x06
#define	RTC14_SET_DEV_ADDR   0x6F
	RTC 14 device address setting.
#define	RTC14_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	rtc14_return_value_t { RTC14_OK = 0 , RTC14_ERROR = -1 }
	RTC 14 Click return value data. More...

Functions
void	rtc14_cfg_setup (rtc14_cfg_t *cfg)
	RTC 14 configuration object setup function.
err_t	rtc14_init (rtc14_t *ctx, rtc14_cfg_t *cfg)
	RTC 14 initialization function.
err_t	rtc14_default_cfg (rtc14_t *ctx)
	RTC 14 default configuration function.
err_t	rtc14_generic_write (rtc14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
	RTC 14 I2C writing function.
err_t	rtc14_generic_read (rtc14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
	RTC 14 I2C reading function.
err_t	rtc14_write_sram (rtc14_t *ctx, uint16_t sram_data_in)
	RTC 14 write SRAM function.
err_t	rtc14_read_sram (rtc14_t *ctx, uint16_t *sram_data_out)
	RTC 14 I2C reading SRAM function.
uint8_t	rtc14_get_interrupt (rtc14_t *ctx)
	RTC 14 get interrupt function.
uint8_t	rtc14_get_fout (rtc14_t *ctx)
	RTC 14 get fout function.
err_t	rtc14_enable_rtc (rtc14_t *ctx)
	RTC 14 enable RTC function.
err_t	rtc14_soft_reset (rtc14_t *ctx)
	RTC 14 soft reset function.
err_t	rtc14_get_time (rtc14_t *ctx, rtc14_time_t *rtc_time)
	RTC 14 get time function.
err_t	rtc14_set_time (rtc14_t *ctx, rtc14_time_t rtc_time)
	RTC 14 set time function.
err_t	rtc14_get_date (rtc14_t *ctx, rtc14_date_t *rtc_date)
	RTC 14 get date function.
err_t	rtc14_set_date (rtc14_t *ctx, rtc14_date_t rtc_date)
	RTC 14 set date function.
err_t	rtc14_get_alarm (rtc14_t *ctx, rtc14_alarm_t *rtc_alarm)
	RTC 14 get alarm function.
err_t	rtc14_set_alarm (rtc14_t *ctx, rtc14_alarm_t rtc_alarm)
	RTC 14 set alarm function.
void	rtc14_trigger_time_stamp (rtc14_t *ctx)
	RTC 14 trigger time stamp function.
err_t	rtc14_get_time_stamp (rtc14_t *ctx, rtc14_time_stamp_t *rtc_time_stamp)
	RTC 14 get time stamp function.

Detailed Description

This file contains API for RTC 14 Click Driver.

Enumeration Type Documentation

rtc14_return_value_t

enum rtc14_return_value_t

RTC 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
RTC14_OK
RTC14_ERROR