Real-time clock peripheral interface and DS3231 (I²C) backend

Repository: github.com/dekiengine/deki-rtc · Latest release: 1.1.0 · Needs engine 1.2.0+ · Requires: deki-i2c

Install: DekiEditor --packages-add deki-rtc <project>, or add it in the Package Manager. Part of Deki; the engine's own components and the C++ API are documented there.

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

Compile-time features the package exposes (package.json):

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 GUID: 3e9b172c-4a5d-4c08-b5e7-91f3a0c2d74b

Property	Type	Default	Constraints	Description
i2cPort	int32	0	0 to 3

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 GUID: 2c7d4e83-1f5a-4b29-9e6d-3c8b0f1a4d72

No reflected properties.

Generated from the package's reflection metadata by the Deki documentation build (engine 1.3.0). Reflected property names are the keys scene files use; a rename ships with an alias, see COMPATIBILITY.md.