rtc2 2.0.0.0
Main Page

RTC2 click

< RTC2 Click is an accessory board in mikroBus™ form factor. It features the DS1307 serial real-time clock (RTC). It is a low-power, full binary-coded decimal (BCD) clock/calendar with programmable square-wave output signal. >

click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Rtc2 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

‍This library contains API for Rtc2 Click driver.

Standard key functions :

  • Config Object Initialization function.

    ‍void rtc2_cfg_setup ( rtc2_cfg_t *cfg );

    - Initialization function.

    ‍RTC2_RETVAL rtc2_init ( rtc2_t *ctx, rtc2_cfg_t *cfg );

    Example key functions :

  • Generic read byte of data function.

    ‍uint8_t rtc2_read_byte ( rtc2_t *ctx, uint8_t reg_address );

    - Generic write byte of data function.

    ‍void rtc2_write_byte ( rtc2_t *ctx, uint8_t reg_address, uint8_t write_data );

  • Enable counting function.

    ‍void rtc2_enable_counting ( rtc2_t *ctx );

    Examples Description

‍This application give time and day information.

The demo application is composed of two sections :

Application Init

‍Initialization driver enable's - I2C,set start time and date, enable counting and start write log.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
rtc2_cfg_setup( &cfg );
RTC2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
rtc2_init( &rtc2, &cfg );
rtc2_set_time( &rtc2, 23, 59, 50 );
rtc2_set_date( &rtc2, 1, 31, 12, 2018 );
}
#define RTC2_MAP_MIKROBUS(cfg, mikrobus)
Definition rtc2.h:66
void rtc2_set_time(rtc2_t *ctx, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds)
Set time hours, minutes and seconds function.
void rtc2_enable_counting(rtc2_t *ctx)
Enable counting function.
void rtc2_set_date(rtc2_t *ctx, rtc2_data_t *date)
Generic read function.
void rtc2_cfg_setup(rtc2_cfg_t *cfg)
Config Object Initialization function.
RTC2_RETVAL rtc2_init(rtc2_t *ctx, rtc2_cfg_t *cfg)
Initialization function.
void application_init(void)
Definition main.c:92
Click configuration structure definition.
Definition rtc2.h:154

Application Task

‍This is a example which demonstrates the use of RTC 2 Click board. RTC 2 Click communicates with register via I2C by write to register and read from register, set time and date, get time and date, enable and disable counting and set frequency by write configuration register. Results are being sent to the Usart Terminal where you can track their changes. All data logs write on usb uart changes for every 1 sec.

void application_task ( void )
{
{
log_printf( &logger, " Time : " );
log_printf( &logger, ":" );
log_printf( &logger, ":" );
log_printf( &logger, "" );
log_printf( &logger, " Date: " );
log_printf( &logger, "." );
log_printf( &logger, "." );
log_printf( &logger, "20" );
log_printf( &logger, "." );
log_printf( &logger, "-------------------" );
}
}
void rtc2_get_time(rtc2_t *ctx, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds)
Get time hours, minutes and seconds function.
void rtc2_get_date(rtc2_t *ctx, rtc2_data_t *date)
Generic read function.
uint8_t date_month
Definition main.c:47
void display_day_of_the_week(uint8_t day_of_the_week)
Definition main.c:51
uint16_t date_year
Definition main.c:48
void application_task(void)
Definition main.c:126
uint8_t day_of_the_week
Definition main.c:45
uint8_t time_hours
Definition main.c:42
uint8_t time_minutes
Definition main.c:43
uint8_t date_day
Definition main.c:46
void display_log_uart(uint8_t value)
Definition main.c:83
uint8_t time_seconds_new
Definition main.c:49
uint8_t time_seconds
Definition main.c:44

Note

‍Additional Functions :

  • void displayDayOfTheWeek( uint8_t dayOfTheWeek ) - Write day of the week log on USART terminal.
  • void displayLogUart( uint8_t value ) - Write the value ( time or date ) of a two-digit number.

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Rtc2

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.