Library Description

The library covers all the necessary functions to control the RTC 4 click board. Library performs the communication with the device via 1-Wire protocol by writing to registers and by reading from registers. A library has the function for reading sensor registration number: family code, serial number & CRC tester data, for a set and get Unix time data and for convert Unix time and date to human-readable format.

Key functions:

• uint8_t rtc4_getInterrupt() - Get state of interrupt pin function.

Examples description

The application is composed of three sections:

• System Initialization - Initializes GPIO and LOG structures set INT pin as input and start to write log.
• Application Initialization -  Initialization driver enables - GPIO, start One Wire communication and set Unix time data.
• Application Task - (code snippet) This is an example which demonstrates the use of RTC 4 click board. RTC 4 click communicates with register via One Wire by the write to register and read from the register, display RTC time and date which we received reading from the DS2471 chip. 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 applicationTask() 
{
    rtc4_getUnixTime();
    rtc4_convertDateTime();
    
    if ( timeSecondsNew != timeSeconds )
    {
        mikrobus_logWrite( " Time: ", _LOG_TEXT );
        rtc4_displayLogUart( timeHours );
        mikrobus_logWrite( ":", _LOG_TEXT );
        rtc4_displayLogUart( timeMinutes );
        mikrobus_logWrite( ":", _LOG_TEXT );
        rtc4_displayLogUart( timeSeconds );
        mikrobus_logWrite( "", _LOG_LINE );

        mikrobus_logWrite( " Date: ", _LOG_TEXT );
        rtc4_displayLogUart( dateDay );
        mikrobus_logWrite( ".", _LOG_TEXT );
        rtc4_displayLogUart( dateMonth );
        mikrobus_logWrite( ".", _LOG_TEXT );
        mikrobus_logWrite( "20", _LOG_TEXT );
        rtc4_displayLogUart( dateYear );
        mikrobus_logWrite( ".", _LOG_LINE );​

        mikrobus_logWrite( "-------------------", _LOG_LINE );
        timeSecondsNew = timeSeconds;​
    }
}    

Additional Functions :

• void displayLogUart( uint8_t value ) - Write the value of time or date as a two-digit number.
• void rtc4_start() - Start RTC 4 click.
• void rtc4_getSensorInfo() - Read sensor registration number: family code, serial number & CRC tester data.
• void rtc4_getUnixTime() - Get Unix time data.
• void rtc4_setUnixTime( uint32_t unixTime ) - Set Unix data.
• void rtc4_convertDateTime() - Convert Unix time & date to human readable format.

Other mikroE Libraries used in the example:

• One_Wire
• UART​
• Conversion

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