← All modules

Alarm

BuiltSingleton

Next scheduled alarm clock information. No permissions required.

Module typealarm
Default expression IDalarm
Refresh rateOn alarm change

Declaration

<module type="alarm" id="alarm" />

Properties

Reference any of these from a template via{alarm:propertyName}.

NameDescriptionExampleFormat arg
isSetWhether an alarm is scheduledtrue—
timeNext alarm time07:00Yes
hourAlarm hour07Yes
minuteAlarm minute00—
dayAlarm day of weekMonYes
timeUntilDuration until alarm7h 23m—
timestampAlarm epoch millis1774569600000—

Events

TriggerDescription
On alarm scheduledA new alarm is set or changed