Keeping time with DS1302: real-time clock on Arduino

[HB] Arduino Nano

Arduino IDE

[HB] DS-1302 Module

[HB] CR2032 Battery

[HB] Mini Breadboard

[HB] Dupont wires

<html><body>Main article: <a href="https://www.hibit.dev/posts/130/keeping-time-with-ds1302-real-time-clock-on-arduino">Keeping time with DS1302: real-time clock on Arduino</a>In the fascinating world of Arduino and microcontrollers, keeping time is key. You might need to build a digital clock, a timer, or something more complex like an automated plant watering system. That's where the DS1302 module steps in. It's a handy little device that can help you keep time accurately in your Arduino projects. In this article, we'll take a closer look at the DS1302 module, understand how it works, and explore its applications.<h3>The DS1302 module</h3>The DS1302 is a real-time clock (RTC) module. What does that mean? It's like a tiny digital wristwatch for your Arduino. It's good at keeping time, and it doesn't need winding or battery changes because it runs on very little power. The module connects with your Arduino through a simple interface, making it super user-friendly.The DS1302 uses a 32.768 kHz crystal oscillator to keep track of time very precisely. It even has a backup battery, so if your Arduino loses power, it won't forget what time it is. This makes it perfect for situations where accuracy is crucial.<h3>Wiring schema</h3>Connecting the DS1302 module with an Arduino is a breeze. You'll need to hook up a few wires, like the data, clock, and reset pins, to the right places on your Arduino. A power supply and a backup battery are essential for uninterrupted timekeeping.<figure><img src="https://www.hibit.dev/images/posts/2023/schemas/arduino_ds1302.png"/><figcaption>Arduino Nano wiring with DS1302 RTC module</figcaption></figure>The good news is that there are plenty of libraries and example codes out there that simplify this process. So, even if you're not an expert, you can get it up and running without too much fuss.<h3>Install library for DS1302</h3>To interact with the DS1302 sensor, we will use an existing library. This library, provides an interface that facilitates communication with the module, saving you significant time and providing a reliable and extensively tested code base. It can be downloaded from our <a href="https://github.com/hibit-dev/ds1302/raw/master/lib/DS1302.zip">official repository</a>.To import a library, open the Arduino IDE, go to Sketch &gt; Include Library &gt; Add .ZIP Library and select the library file downloaded from our GitHub repository.<figure><img src="https://www.hibit.dev/images/posts/2023/arduino_import_library.png"/><figcaption>Arduino IDE library import</figcaption></figure>Then you can simply use include statement:<pre>#include "virtuabotixRTC.h" </pre>It will include the library with predefined functions to interact with the module.<h3>Arduino code</h3>Let's kick things off by establishing the connection pins. After that, we'll configure the current time as the initial reference for the module. This initial setup is a one-time job because the module smartly retains this value in its memory, eliminating the need for a reset each time you upload new code.<pre>#include "virtuabotixRTC.h" </pre><pre>	 </pre><pre>#define DS1302_CLK_PIN A5 </pre><pre>#define DS1302_DAT_PIN A4 </pre><pre>#define DS1302_RST_PIN 13 </pre><pre>	 </pre><pre>#define CURRENT_SECONDS 45 </pre><pre>#define CURRENT_MINUTES 30 </pre><pre>#define CURRENT_HOURS 11 </pre><pre>#define CURRENT_DAY_OF_WEEK 1 </pre><pre>#define CURRENT_DAY_OF_MONTH 6 </pre><pre>#define CURRENT_MONTH 11 </pre><pre>#define CURRENT_YEAR 2023 </pre><pre>	 </pre><pre>virtuabotixRTC RTC(DS1302_CLK_PIN, DS1302_DAT_PIN, DS1302_RST_PIN); </pre><pre>	 </pre><pre>void setup() </pre><pre>{ </pre><pre>	 Serial.begin(115200); </pre><pre>	 </pre><pre>	 // Once the battery is installed, </pre><pre>	 // the module stores the value in memory </pre><pre>	 RTC.setDS1302Time( </pre><pre>	 CURRENT_SECONDS, </pre><pre>	 CURRENT_MINUTES, </pre><pre>	 CURRENT_HOURS, </pre><pre>	 CURRENT_DAY_OF_WEEK, </pre><pre>	 CURRENT_DAY_OF_MONTH, </pre><pre>	 CURRENT_MONTH, </pre><pre>	 CURRENT_YEAR </pre><pre>	 ); </pre><pre>} </pre><pre>	 </pre><pre>void loop() </pre><pre>{ </pre><pre>	 // Allow updates of variables </pre><pre>	 RTC.updateTime(); </pre><pre>	 </pre><pre>	 Serial.print("Current Date and time: "); </pre><pre>	 </pre><pre>	 Serial.print(RTC.year); </pre><pre>	 Serial.print("/"); </pre><pre>	 Serial.print(RTC.month); </pre><pre>	 Serial.print("/"); </pre><pre>	 Serial.print(RTC.dayofmonth); </pre><pre>	 </pre><pre>	 Serial.print(" "); </pre><pre>	 </pre><pre>	 Serial.print(RTC.hours); </pre><pre>	 Serial.print(":"); </pre><pre>	 Serial.print(RTC.minutes); </pre><pre>	 Serial.print(":"); </pre><pre>	 Serial.print(RTC.seconds); </pre><pre>	 </pre><pre>	 // New line </pre><pre>	 Serial.println(); </pre><pre>	 </pre><pre>	 // Add one second delay between iterations </pre><pre>	 delay(1000); </pre><pre>} </pre>Within the main loop, our task is straightforward - we simply print the module's values, ensuring that the date and time units are clearly separated.<h3>Automatic time detection</h3>To simplify the setup and enable easy usage, an automated version has been created for configuring the current time. This version uses the current compilation date as the initial time for the module clock.<pre>#include "virtuabotixRTC.h" </pre><pre> </pre><pre>#define DS1302_CLK_PIN A5 </pre><pre>#define DS1302_DAT_PIN A4 </pre><pre>#define DS1302_RST_PIN 13 </pre><pre> </pre><pre>virtuabotixRTC RTC(DS1302_CLK_PIN, DS1302_DAT_PIN, DS1302_RST_PIN); </pre><pre> </pre><pre>void setup() </pre><pre>{ </pre><pre>	 Serial.begin(115200); </pre><pre> </pre><pre>	 // Set sketch compiling time </pre><pre>	 setDateTime(RTC, __DATE__, __TIME__); </pre><pre>} </pre><pre> </pre><pre>void loop() </pre><pre>{ </pre><pre>	 // Allow updates of variables </pre><pre>	 RTC.updateTime(); </pre><pre>	 </pre><pre>	 Serial.print("Current Date and time: "); </pre><pre> </pre><pre>	 Serial.print(RTC.year); </pre><pre>	 Serial.print("/"); </pre><pre>	 Serial.print(RTC.month); </pre><pre>	 Serial.print("/"); </pre><pre>	 Serial.print(RTC.dayofmonth); </pre><pre> </pre><pre>	 Serial.print(" "); </pre><pre> </pre><pre>	 Serial.print(RTC.hours); </pre><pre>	 Serial.print(":"); </pre><pre>	 Serial.print(RTC.minutes); </pre><pre>	 Serial.print(":"); </pre><pre>	 Serial.print(RTC.seconds); </pre><pre> </pre><pre>	 // New line </pre><pre>	 Serial.println(); </pre><pre> </pre><pre>	 // Add one second delay between iterations </pre><pre>	 delay(1000); </pre><pre>} </pre>The library does not support automatic setup of the current time. Therefore, we've created an extension file, available in our <a href="https://github.com/hibit-dev/ds1302/tree/master/src/automatic">official repository</a>, that can autonomously detect and set the current time on the module.<h3>Testing</h3>To verify the proper functioning of our module, we use the serial monitor.<figure><img src="https://www.hibit.dev/images/posts/2023/ds1302_output_testing.png"/><figcaption>Serial monitor: DS1302 output testing</figcaption></figure>Your serial monitor should display values closely resembling those visible in the image above.<h3>Conclusion</h3>In a world where timing is everything, the DS1302 module and your Arduino can be a dynamic duo. It keeps your projects running like clockwork, and the best part is, it's not overly complicated to set up. It's straightforward to integrate and broadens the horizons for various time-oriented applications. So, don't wait! Embrace the precision and efficiency it offers, letting your Arduino projects seamlessly align with the rhythm of the world around them.</body></html>