TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141292 times)
  2. FAT32 Library (74089 times)
  3. Network Ethernet Library (58715 times)
  4. USB Device Library (48826 times)
  5. Network WiFi Library (44525 times)
  6. FT800 Library (44074 times)
  7. GSM click (30805 times)
  8. mikroSDK (29659 times)
  9. PID Library (27355 times)
  10. microSD click (27251 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

RTC 4 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.10

mikroSDK Library: 2.0.0.0

Category: RTC

Downloaded: 266 times

Not followed.

License: MIT license  

RTC4 Click carries DS2417, a real time clock/calendar with a 1-Wire MicroLAN interface and a programmable interrupt for system output.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "RTC 4 Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "RTC 4 Click" changes.

Do you want to report abuse regarding "RTC 4 Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


RTC 4 Click

RTC 4 Click carries DS2417, a real time clock/calendar with a 1-Wire MicroLAN interface and a programmable interrupt for system output.

rtc4_click.png

Click Product page


Click library

  • Author : Aleksandra Cvjeticanin
  • Date : Mar 2022.
  • Type : One Wire type

Software Support

We provide a library for the RTC 4 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for RTC 4 Click driver.

Standard key functions :

  • rtc4_cfg_setup Config Object Initialization function.

    void rtc4_cfg_setup ( rtc4_cfg_t *cfg );
  • rtc4_init Initialization function.

    err_t rtc4_init ( rtc4_t *ctx, rtc4_cfg_t *cfg );

Example key functions :

  • rtc4_get_interrupt This function checks the interrupt state of the DS2417 Real time clock/calendar.

    uint8_t rtc4_get_interrupt ( rtc4_t *ctx );
  • rtc4_set_date_time This function sets date and time structure along with interrupt interval.

    err_t rtc4_set_date_time ( rtc4_t *ctx, rtc4_date_t *date, rtc4_time_t *time, uint8_t int_interval );
  • rtc4_get_date_time This function gets RTC4 time and date structure.

    err_t rtc4_get_date_time ( rtc4_t *ctx, rtc4_date_t *date, rtc4_time_t *time );

Example Description

This example demonstrates the use of the RTC 4 Click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger and then sets the starting time to 23:59:50 and date to 31.12.2022.


void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    rtc4_cfg_t rtc4_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    rtc4_cfg_setup( &rtc4_cfg );
    RTC4_MAP_MIKROBUS( rtc4_cfg, MIKROBUS_1 );
    if ( ONE_WIRE_ERROR == rtc4_init( &rtc4, &rtc4_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( RTC4_ERROR == rtc4_check_communication ( &rtc4 ) )
    {
        log_error( &logger, " Check communication." );
        for ( ; ; );
    }

    time.hours = 23;
    time.min = 59; 
    time.sec = 50; 

    date.day = 31;
    date.month = 12; 
    date.year = 2022; 

    rtc4_set_date_time ( &rtc4, &date, &time, RTC4_DCB_INTERVAL_1S ); 

    log_info( &logger, " Application Task " );
}    

Application Task

With the usage of rtc4_get_date_time we get the time and date from the register and display them on the UART Terminal. The counter increments once per second.

void application_task ( void ) 
{
    while ( rtc4_get_interrupt ( &rtc4 ) ); 

    if ( RTC4_OK == rtc4_get_date_time ( &rtc4, &date, &time ) ) 
    {
        log_printf( &logger, "Time: %.2u:%.2u:%.2u\r\n", 
                    ( uint16_t ) time.hours, ( uint16_t ) time.min, ( uint16_t ) time.sec ); 
        log_printf( &logger, "Date: %.2u/%.2u/%u\r\n", 
                    ( uint16_t ) date.day, ( uint16_t ) date.month, ( uint16_t ) date.year ); 
        log_printf( &logger, "------------------------\r\n\n"); 
    }
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.RTC4

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. UART terminal is available in all MikroElektronika compilers.


ALSO FROM THIS AUTHOR

IrDA 2 Click

0

IrDA2 Click features the TFDU4101 infrared transceiver module as well as MCP2120 infrared encoder/decoder from Microchip connected with the 7.3728 MHz external crystal. The Click is designed to run on either 3.3V or 5V power supply. It communicates with the target board via UART interface and the following mikroBUS™ pins: AN, RST, CS.

[Learn More]

Temp Probe click

5

Temp Probe Click is a compact add-on board used as thermocouple temperature monitoring system. This board features the LTC2986, a high accuracy digital temperature measurement system used to directly digitize thermocouples with 0.1°C accuracy and 0.001°C resolution from Analog Devices.

[Learn More]

TempHum 8 Click

0

Temp&Hum 8 Click is based on a sensor from the popular SHT family, designed to measure temperature and humidity.

[Learn More]