enableAlarm()

Description

Enable the RTC alarm to be triggered on a chosen match type

Syntax


rtc.enableAlarm(rtc.AlarmMatch)

Parameters

AlarmMatch: the chosen match type that can be chosen between:

MATCH_SS: generate an alarm on seconds match;
MATCH_MMSS: generate an alarm on minutes and seconds match;
MATCH_HHMMSS: generate an alarm on hours, minutes and seconds match;
MATCH_DHHMMSS: generate an alarm on day, hours, minutes and seconds match;
MATCH_MMDDHHMMSS: generate an alarm on month, day, hours, minutes and seconds match;
MATCH_YYMMDDHHMMSS: generate an alarm on year, month, day, hours, minutes and seconds match;

Example

#include <RTCZero.h>

/* Create an rtc object */
RTCZero rtc;

/* Change these values to set the current initial time */
const byte seconds = 0;
const byte minutes = 0;
const byte hours = 16;

/* Change these values to set the current initial date */
const byte day = 25;
const byte month = 9;
const byte year = 15;

void setup()
{
  Serial.begin(9600);

  rtc.begin(); // initialize RTC 24H format

  rtc.setTime(hours, minutes, seconds);
  rtc.setDate(day, month, year);

  rtc.setAlarmTime(16, 0, 10);
  rtc.enableAlarm(rtc.MATCH_HHMMSS);
 
  rtc.attachInterrupt(alarmMatch);
}

void loop()
{

}

void alarmMatch()
{
  Serial.println("Alarm Match!");
}

See also

begin()
disableAlarm()


Libraries Reference Home

The text of the 86Duino reference is a modification of the Arduino reference, and is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.