mikroe_rtc10_ds3231m

DS3231M - RTC 10 Click (Mikroe)

Summary

This example project shows an example of Mikroe RTC 10 Click board driver integration with the Silicon Labs Platform.

RTC 10 Click is a real-time clock module which has an extremely low power consumption, allowing it to be used with a single button cell battery, for an extended period of time. It features the DS3231M, a low-cost, extremely accurate, I2C real-time clock (RTC) from Analog Devices. The device incorporates a battery input and maintains accurate timekeeping when main power to the device is interrupted. The integration of the microelectromechanical systems (MEMS) resonator enhances the long-term accuracy of the device and reduces the piecepart count in a manufacturing line.

This example can be used to demonstrate the capability of maintaining timekeeping of the Mikroe RTC 10 Click board.

Table Of Contents

• Required Hardware
• Hardware Connection
• Setup
  • Create a project based on an example project
  • Start with an empty example project
• How It Works
• Report Bugs & Get Support

Required Hardware

• 1x Silicon Labs BLE Explorer Kit based on the EFR32 SoC, such as:

  • BGM220-EK4314A
  • BG22-EK4108A
  • xG24-EK2703A
  • xG22-EK2710A

  or

  1x Silicon Labs Wi-Fi Development Kit based on SiWG917, such as:

  • SIWX917-DK2605A
  • SIWX917-RB4338A + Si-MB4002A
  • SiW917Y-EK2708A

• 1x RTC 10 Click board based on the DS3231M

Hardware Connection

The Silicon Labs Explorer Kit boards feature a mikroBUS™ socket, allowing the RTC 10 Click board to connect easily via the mikroBUS header. Ensure that the 45-degree corner of the RTC 10 Click board aligns with the 45-degree white line on the Explorer Kit. The hardware connection is illustrated in the image below.

For the Silicon Labs boards that do not have a mikroBUS™ socket, consider using the Wire Jumpers.

The tables below provide an overview of the pin connections.

Silicon Labs BLE Development Kit:

Description	BRD4314A	BRD4108A	BRD2703A	BRD2710A	↔	RTC 10 Click
I2C_SDA	PD3	PD3	PB5	PD3	↔	SDA
I2C_SCL	PD2	PD2	PB4	PD2	↔	SCL
Reset Out	PB3	PB3	PC8	PB3	↔	RST
Analog ECG signal OUT	PB0	PB0	PB0	PB0	↔	AN
Interrupt OUT	PB3	PB3	PB1	PB3	↔	INT

Silicon Labs Wi-Fi Development Kit:

Description	BRD4338A + BRD4002A	BRD2605A	BRD2708A	↔	RTC 10 Click
I2C_SDA	ULP_GPIO_6 [EXP_16]	ULP_GPIO_6 [P16]	GPIO_6	↔	SDA
I2C_SCL	ULP_GPIO_7 [EXP_15]	ULP_GPIO_7 [P15]	GPIO_7	↔	SCL
Reset Out	GPIO_46 [P24]	GPIO_10 [P23]	GPIO_30	↔	RST
Analog ECG signal OUT	GPIO_47 [P26]	GPIO_11 [P22]	GPIO_29	↔	AN
Interrupt OUT	GPIO_48 [P28]	GPIO_12 [P25]	UULP_VBAT_GPIO_2	↔	INT

Setup

You can either create a project based on an example project or start with an empty example project.

Important

• Make sure that the Third Party Hardware Drivers extension is installed as part of the SiSDK. If not, follow this documentation.
• Third Party Hardware Drivers extension must be enabled for the project to install the required components from this extension.

Tip

To show all components in the Third Party Hardware Drivers extension, the Evaluation quality must be enabled in the Software Component view.

Create a project based on an example project

1. From the Launcher Home, add your device to My Products, click on it, and click on the EXAMPLE PROJECTS & DEMOS tab. Find the example project filtering by rtc.

2. Click Create button on the Third Party Hardware Drivers - DS3231M - RTC10 Click (Mikroe) example. Example project creation dialog pops up -> click Create and Finish and Project should be generated.

   

3. Build and flash this example to the board.

Start with an empty example project

1. Create an "Empty C Project" for the your board using Simplicity Studio v5. Use the default project settings.

2. Copy the app.c file (located in the app/example/mikroe_rtc10_ds3231m folder) into the project root folder (overwriting existing file).

3. Open the .slcp file. Select the SOFTWARE COMPONENTS tab and install the following components:

   • If the BLE Explorer Kit is used:

     • [Services] → [Timers] → [Sleep Timer]
     • [Services] → [IO Stream] → [IO Stream: USART] → default instance name: vcom
     • [Application] → [Utility] → [Log]
     • [Third Party Hardware Drivers] → [Clock & Timing] → [DS3231M - RTC 10 Click (Mikroe)] → use default configuration

   • If the Wi-Fi Development Kit is used:

     • [WiSeConnect 3 SDK] → [Device] → [Si91x] → [MCU] → [Service] → [Sleep Timer for Si91x]
     • [WiSeConnect 3 SDK] → [Device] → [Si91x] → [MCU] → [Peripheral] → [I2C] → [i2c2] → Select the corresponding pins according to the table provided in Hardware Connection
     • [Third Party Hardware Drivers] → [Clock & Timing] → [DS3231M - RTC 10 Click (Mikroe)] → use default configuration

4. Enable Printf float

   • Open Properties of the project.
   • Select C/C++ Build → Settings → Tool Settings → GNU ARM C Linker → General → Check Printf float.

5. Build and flash this example to the board.

How It Works

Driver Layer Diagram

Testing

This example sets time and date for the RTC Click in the initialization step. And then it starts tracking the time and display it every one second. The temperature is displayed every 60 seconds.

You can launch Console that's integrated into Simplicity Studio or use a third-party terminal tool like Tera Term to receive the data from the USB. A screenshot of the console output is shown in the figure below.

Report Bugs & Get Support

To report bugs in the Application Examples projects, please create a new "Issue" in the "Issues" section of third_party_hw_drivers_extension repo. Please reference the board, project, and source files associated with the bug, and reference line numbers. If you are proposing a fix, also include information on the proposed fix. Since these examples are provided as-is, there is no guarantee that these examples will be updated to fix these issues.

Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of third_party_hw_drivers_extension repo.