RTCC.getAlarmTime
From Pinguino-Wiki
Contents |
Name
- RTCC.getAlarmTime
Description
Gets the alarm time of the Real Time Clock and Calendar (RTCC) by reading the value from the Alarm Time Value Register (ALRMTIME).
Note: that the behaviour of the RTCC Alarm is dependent not only on the values in the Alarm Time Value Register (ALRMTIME) and in the Alarm Date Value Register (ALRMDATE) but also the values in the RTC Alarm Control Register (RTCALRM) which are determined by other settings including the various RTCC.AlarmRepeat~ functions.
Only works for 32-bit Pinguinos with a 32,768 kHz quartz crystal which allows the use of the built-in RTCC functionality of the PIC32, such as the Olimex PIC32 Pinguino OTG.
Syntax
rtccTime RTCC.getAlarmTime(void)
- Parameters
- [None]
- Returns/Output
- the current alarm time value read from the Alarm Time Value Register (ALRMTIME) in bcd format in data type rtccTime, which is defined as :-
typedef union
{
struct
{
unsigned char rsvd; // reserved for future use. should be 0
unsigned char sec; // BCD codification for seconds, 00-59
unsigned char min; // BCD codification for minutes, 00-59
unsigned char hour; // BCD codification for hours, 00-24
}; // field access
unsigned char b[4]; // byte access
unsigned short w[2]; // 16 bits access
unsigned long l; // 32 bits access
}rtccTime;
To be used the returned value will probably need to be converted from BCD to a decimal format using RTCC.convertTime.
Example
Bugs
See also
Details of the RTCC functionality can be found in the Microchip PIC32 Family Reference Manual, Section 29. Real-Time Clock and Calendar (RTCC) which can be downloaded from Resources and Support on the Microship website for their 32-bit microcontrollers.
