rtc9  2.0.0.0
Main Page

RTC 9 Click

RTC 9 Click is a real-time clock module that has an extremely low power consumption, allowing it to be used with a single button cell battery, for an extended period of time. This board features the M41T82, real-time clock (RTC) with battery switchover, from ST Microelectronics.

Click Product page


Click library

  • Author : MikroE Team
  • Date : Jul 2020.
  • Type : I2C type

Software Support

We provide a library for the Rtc9 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 Rtc9 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void rtc9_cfg_setup ( rtc9_cfg_t *cfg );

  • Initialization function.

    RTC9_RETVAL rtc9_init ( rtc9_t *ctx, rtc9_cfg_t *cfg );

Example key functions :

Examples Description

This example demonstrates the use of RTC 9 Click board.

The demo application is composed of two sections :

Application Init

Initializes the driver, wakes up the module, and sets the time and date.

void application_init ( void )
{
log_cfg_t log_cfg;
rtc9_set_data_t set_data;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
rtc9_cfg_setup( &cfg );
RTC9_MAP_MIKROBUS( cfg, MIKROBUS_1 );
rtc9_init( &rtc9, &cfg );
Delay_ms ( 500 );
rtc9_wakeup( &rtc9 );
rtc9_set_time( &rtc9, 23, 59, 50 );
set_data.day = 22;
set_data.month = RTC9_MONTH_MARCH;
set_data.year = 21;
rtc9_set_date ( &rtc9, &set_data );
rtc9_wakeup( &rtc9 );
}

Application Task

Reads the current time and date and displays the results on the USB UART each second.

void application_task ( void )
{
rtc9_get_time_t get_time;
rtc9_get_date_t get_date;
char *week_string;
char *month_string;
rtc9_get_time( &rtc9, &get_time );
rtc9_get_date( &rtc9, &get_date );
if ( get_time.sec != seconds_old )
{
seconds_old = get_time.sec;
log_printf( &logger, "- Time [ %.2u:%.2u:%.2u ] \r\n", ( uint16_t ) get_time.hour,
( uint16_t ) get_time.min,
( uint16_t ) get_time.sec );
week_string = rtc9_current_day_of_week( get_date.day_of_week );
month_string = rtc9_current_month( get_date.month );
log_printf( &logger, "- Date [ %s, %s %.2u, %u ] \r\n", week_string, month_string,
( uint16_t ) get_date.day,
( uint16_t ) get_date.year + 2000 );
log_printf( &logger, "---------------------------------------- \r\n" );
}
Delay_ms ( 10 );
}

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.Rtc9

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.


rtc9_get_time_t
Definition: rtc9.h:265
RTC9_DAY_MONDAY
#define RTC9_DAY_MONDAY
Definition: rtc9.h:240
rtc9_set_date
void rtc9_set_date(rtc9_t *ctx, rtc9_set_data_t *set_data)
Set new date.
rtc9_get_time_t::min
uint8_t min
Definition: rtc9.h:267
rtc9_set_data_t::day_of_week
uint8_t day_of_week
Definition: rtc9.h:258
rtc9_wakeup
void rtc9_wakeup(rtc9_t *ctx)
Wake-up process.
rtc9_current_month
char * rtc9_current_month(uint8_t month)
Month in the String format.
rtc9_init
RTC9_RETVAL rtc9_init(rtc9_t *ctx, rtc9_cfg_t *cfg)
Initialization function.
rtc9_get_date_t::day_of_week
uint8_t day_of_week
Definition: rtc9.h:276
rtc9_set_data_t::month
uint8_t month
Definition: rtc9.h:259
rtc9_get_date_t
Definition: rtc9.h:274
rtc9_set_data_t::year
uint8_t year
Definition: rtc9.h:260
rtc9_set_data_t
Definition: rtc9.h:256
application_task
void application_task(void)
Definition: main.c:73
rtc9_get_date_t::month
uint8_t month
Definition: rtc9.h:277
rtc9_cfg_setup
void rtc9_cfg_setup(rtc9_cfg_t *cfg)
Config Object Initialization function.
rtc9_get_date_t::day
uint8_t day
Definition: rtc9.h:275
rtc9_current_day_of_week
char * rtc9_current_day_of_week(uint8_t day_of_week)
Day of Week in the String format.
rtc9_cfg_t
Click configuration structure definition.
Definition: rtc9.h:309
rtc9_get_time
void rtc9_get_time(rtc9_t *ctx, rtc9_get_time_t *get_time)
Get new time - 24 hour format.
rtc9_get_date
void rtc9_get_date(rtc9_t *ctx, rtc9_get_date_t *get_data)
Get new date.
rtc9_get_date_t::year
uint8_t year
Definition: rtc9.h:278
rtc9_set_time
void rtc9_set_time(rtc9_t *ctx, uint8_t hour, uint8_t min, uint8_t sec)
Set new time - 24 hour format.
application_init
void application_init(void)
Definition: main.c:33
rtc9_get_time_t::hour
uint8_t hour
Definition: rtc9.h:266
rtc9_get_time_t::sec
uint8_t sec
Definition: rtc9.h:268
rtc9_set_data_t::day
uint8_t day
Definition: rtc9.h:257
RTC9_MONTH_MARCH
#define RTC9_MONTH_MARCH
Definition: rtc9.h:223
RTC9_MAP_MIKROBUS
#define RTC9_MAP_MIKROBUS(cfg, mikrobus)
Definition: rtc9.h:66