Real-time clock peripheral interface and DS3231 (I²C) backend
Repository: github.com/dekiengine/deki-rtc · Latest release: 0.19.0 · Needs engine 0.19.0+ · Requires: deki-i2c
Install with DekiEditor --packages-add deki-rtc <project>, or from the Package Manager. The engine's own components and C++ API are in the Deki docs.
Shown in the editor as RTC (Real-Time Clock).
Components
| Component | Category | Description |
|---|---|---|
| DS3231RTCComponent | Sensors | Reads and sets the DS3231 real-time clock over I2C. |
| SystemClockRTCComponent | System | Uses the computer's own clock as the real-time clock, for editor and desktop runs. |
Feature flags
Parts you can leave out of a build. A feature with a define is switched there; the rest are stripped with their components.
| Feature | Define | Default |
|---|---|---|
| DS3231 (I²C) | DEKI_FEATURE_RTC_DS3231 | on |
Component reference
DS3231RTCComponent
Reads and sets the DS3231 real-time clock over I2C.
Inspector name: DS3231 RTC · Category: Sensors · Type: DekiRtc::DS3231RTCComponent
| Property | Type | Default | Constraints | Description |
|---|---|---|---|---|
| i2cPort | int32 | 0 | 0 to 3 | Which I2C bus the clock chip is on. Must match the I2C Bus component that set that port up. |
SystemClockRTCComponent
Uses the computer's own clock as the real-time clock, for editor and desktop runs.
Inspector name: System Clock RTC · Category: System · Type: DekiRtc::SystemClockRTCComponent
No reflected properties.
Changelog
0.19.0
Changed
- minEngine 0.19.0: built against engine 0.19.0, whose component metadata records the package each class is in. A build of this package from before does not load and is rebuilt.
Added
- Japanese, Simplified Chinese and Korean: editor/lang/ja.json, zh.json and ko.json translate the names, tooltips and enum values this package's components show in the Inspector.
0.18.0
Changed
- minEngine 0.18.0. Reflection ABI 21: the package must be rebuilt.
- Names follow the code style (deki-engine/docs/codestyle): types, functions and enum values are PascalCase, constants kPascalCase, members m_PascalCase, locals and parameters camelCase. The code is formatted with clang-format 22.
- The functions the editor finds by name are PascalCase: DekiRTCRegisterComponents, DekiRTCGetAutoComponentCount, DekiRTCEnsureRegistered and the rest. Built against engine ABI 21; a build of this package from before does not load and is rebuilt.
Removed
- The former names from before 0.16.0 (bare class names, and deki-gpio's DekiEsp32::ESP32PinSetup). A scene that old is upgraded with 0.17 first.
Earlier releases: CHANGELOG.md.
Generated from the package's reflection data (engine 0.19.0). Property names are the keys used in scene files. Renames keep an alias (compatibility).
