rtc21.h File Reference

This file contains API for RTC 21 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	rtc21_t
	RTC 21 Click context object. More...
struct	rtc21_cfg_t
	RTC 21 Click configuration object. More...
struct	rtc21_time_t
	RTC 21 Click time object. More...
struct	rtc21_date_t
	RTC 21 Click date object. More...

Macros
#define	RTC21_REG_SECOND   0x00
	RTC 21 RTC register list.
#define	RTC21_REG_MINUTE   0x01
#define	RTC21_REG_HOUR   0x02
#define	RTC21_REG_DAY_OF_WEEK   0x03
#define	RTC21_REG_DATE   0x04
#define	RTC21_REG_MONTH   0x05
#define	RTC21_REG_YEAR   0x06
#define	RTC21_REG_CONTROL   0x07
#define	RTC21_REG_RAM_BOTTOM   0x08
#define	RTC21_REG_RAM_TOP   0x3F
#define	RTC21_MONDAY   0x01
	RTC 21 day of week values.
#define	RTC21_TUESDAY   0x02
#define	RTC21_WEDNESDAY   0x03
#define	RTC21_THURSDAY   0x04
#define	RTC21_FRIDAY   0x05
#define	RTC21_SATURDAY   0x06
#define	RTC21_SUNDAY   0x07
#define	RTC21_DEVICE_ADDRESS   0x68
	RTC 21 device address setting.
#define	RTC21_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	rtc21_return_value_t { RTC21_OK = 0 , RTC21_ERROR = -1 }
	RTC 21 Click return value data. More...

Functions
void	rtc21_cfg_setup (rtc21_cfg_t *cfg)
	RTC 21 configuration object setup function.
err_t	rtc21_init (rtc21_t *ctx, rtc21_cfg_t *cfg)
	RTC 21 initialization function.
err_t	rtc21_generic_write (rtc21_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	RTC 21 I2C writing function.
err_t	rtc21_generic_read (rtc21_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	RTC 21 I2C reading function.
err_t	rtc21_write_register (rtc21_t *ctx, uint8_t reg, uint8_t data_in)
	RTC 21 write register function.
err_t	rtc21_read_register (rtc21_t *ctx, uint8_t reg, uint8_t *data_out)
	RTC 21 read register function.
uint8_t	rtc21_get_ft_pin (rtc21_t *ctx)
	RTC 21 get ft pin function.
err_t	rtc21_set_time (rtc21_t *ctx, rtc21_time_t *time)
	RTC 21 set time function.
err_t	rtc21_read_time (rtc21_t *ctx, rtc21_time_t *time)
	RTC 21 read time function.
err_t	rtc21_set_date (rtc21_t *ctx, rtc21_date_t *date)
	RTC 21 set date function.
err_t	rtc21_read_date (rtc21_t *ctx, rtc21_date_t *date)
	RTC 21 read date function.

Detailed Description

This file contains API for RTC 21 Click Driver.

Enumeration Type Documentation

rtc21_return_value_t

enum rtc21_return_value_t

RTC 21 Click return value data.

Predefined enum values for driver return values.

Enumerator
RTC21_OK
RTC21_ERROR