en-us_commands:reference:irtcalarmtriggered
Table of Contents
IrtcAlarmTriggered()
IrtcAlarmTriggered() checks whether an alarm has triggered and optionally clears its status.
bool IrtcAlarmTriggered(uint8_t alarm, bool& triggered, bool clear = true)
Commands
| Command | Arguments | Return Value | Operation |
|---|---|---|---|
IrtcAlarmTriggered(alarm, triggered, clear) | uint8_t alarmbool& triggeredbool clear = true | bool | Checks whether an alarm has triggered and optionally clears its status. |
Example
void setup() { Serial.begin(115200); if (!IrtcBegin()) return; // Check the DS3231 RTC connection and begin operation. IrtcSetAlarm1(IRTC_ALARM1_MATCH_HOUR_MINUTE_SECOND, 1, 8, 30, 0); // Set alarm 1, including seconds. IrtcSetAlarm2(IRTC_ALARM2_MATCH_HOUR_MINUTE, 1, 17, 30); // Set alarm 2 with minute resolution. IrtcAlarmEnable(1, true); // Enable or disable the specified alarm. IrtcAlarmEnable(2, true); // Enable or disable the specified alarm. } void loop() { bool alarm1Enabled = false; bool alarm1Triggered = false; IrtcAlarmEnabled(1, alarm1Enabled); // Check whether the specified alarm is enabled. if (alarm1Enabled && IrtcAlarmTriggered(1, alarm1Triggered, true) && alarm1Triggered) { // Check whether an alarm has triggered and optionally clear its status. Serial.println(F("alarm 1")); } delay(50); }
Precautions
Run each device's corresponding Begin command first. Check I²C addresses and pin sharing; if the bool return value is false, inspect wiring and power.
Built-in Commands in the Same Category
en-us_commands/reference/irtcalarmtriggered.txt · Last modified: by 127.0.0.1