rtc13.h File Reference

This file contains API for RTC 13 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures
struct	rtc13_time_t
	RTC 13 Click time object. More...
struct	rtc13_date_t
	RTC 13 Click date object. More...
struct	rtc13_alarm_t
	RTC 13 Click alarm object. More...
struct	rtc13_t
	RTC 13 Click context object. More...
struct	rtc13_cfg_t
	RTC 13 Click configuration object. More...

Macros
#define	RTC13_REG_CTRL1_ADDR   0x00
	RTC 13 description register.
#define	RTC13_REG_CTRL2_ADDR   0x01
#define	RTC13_REG_TIME_SECONDS   0x02
#define	RTC13_REG_TIME_MINUTES   0x03
#define	RTC13_REG_TIME_HOUR   0x04
#define	RTC13_REG_DATE_DAY   0x05
#define	RTC13_REG_DATE_WEEKDAYS   0x06
#define	RTC13_REG_DATE_MONTHS   0x07
#define	RTC13_REG_DATE_YEARS   0x08
#define	RTC13_REG_ALARM_MINUTE   0x09
#define	RTC13_REG_ALARM_HOUR   0x0A
#define	RTC13_REG_ALARM_DAY   0x0B
#define	RTC13_REG_ALARM_WEEKDAY   0x0C
#define	RTC13_REG_OFFSET_ADDR   0x0D
#define	RTC13_REG_TIMER_CLKOUT_ADDR   0x0E
#define	RTC13_REG_COUNTDOWN_TIMER_ADDR   0x0F
#define	RTC13_SOFT_RESET   0x58
	RTC 13 description setting.
#define	RTC13_BLOCK_CLKOUT_DISABLE   0x00
#define	RTC13_BLOCK_CLKOUT_ENABLE   0x01
#define	RTC13_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	RTC13_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	RTC13_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	rtc13_return_value_t { RTC13_OK = 0 , RTC13_ERROR = -1 }
	RTC 13 Click return value data. More...

Functions
void	rtc13_cfg_setup (rtc13_cfg_t *cfg)
	RTC 13 configuration object setup function.
err_t	rtc13_init (rtc13_t *ctx, rtc13_cfg_t *cfg)
	RTC 13 initialization function.
err_t	rtc13_default_cfg (rtc13_t *ctx)
	RTC 13 default configuration function.
uint8_t	rtc13_get_interrupt (rtc13_t *ctx)
	RTC 13 get interrupt function.
err_t	rtc13_block_clkout (rtc13_t *ctx, uint8_t en_clkout)
	RTC 13 block CLKOUT function.
err_t	rtc13_generic_write (rtc13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	RTC 13 data writing function.
err_t	rtc13_generic_read (rtc13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	RTC 13 data reading function.
err_t	rtc13_soft_reset (rtc13_t *ctx)
	RTC 13 soft reset function.
err_t	rtc13_get_time (rtc13_t *ctx, rtc13_time_t *rtc_time)
	RTC 13 get time function.
err_t	rtc13_set_time (rtc13_t *ctx, rtc13_time_t rtc_time)
	RTC 13 set time function.
err_t	rtc13_get_date (rtc13_t *ctx, rtc13_date_t *rtc_date)
	RTC 13 get date function.
err_t	rtc13_set_date (rtc13_t *ctx, rtc13_date_t rtc_date)
	RTC 13 set date function.
err_t	rtc13_get_alarm (rtc13_t *ctx, rtc13_alarm_t *rtc_alarm)
	RTC 13 get alarm function.
err_t	rtc13_set_alarm (rtc13_t *ctx, rtc13_alarm_t rtc_alarm)
	RTC 13 set alarm function.

Detailed Description

This file contains API for RTC 13 Click Driver.

Enumeration Type Documentation

rtc13_return_value_t

enum rtc13_return_value_t

RTC 13 Click return value data.

Predefined enum values for driver return values.

Enumerator
RTC13_OK
RTC13_ERROR