Rtc Class Reference

Class for RTC tibbit control (Tibbit #42) More...

#include <rtc.h>

Public Member Functions
void	getTemperature (const char *socket, RtcTemp &temp)
	Get current temperature in Celsius degrees. More...
void	setTime (const char *socket, RtcClock &time)
	Set current time. More...
void	getTime (const char *socket, RtcClock &time)
	Get current time. More...
void	setAlarm1 (const char *socket, RtcAlarm &alarm, RtcAlarmFlags &flags)
	Set time for Alarm 1. More...
void	setAlarm2 (const char *socket, RtcAlarm &alarm, RtcAlarmFlags &flags)
	Set time for Alarm 2. More...
void	getAlarm1 (const char *socket, RtcAlarm &alarm, RtcAlarmFlags &flags)
	Get time for Alarm 1. More...
void	getAlarm2 (const char *socket, RtcAlarm &alarm, RtcAlarmFlags &flags)
	Get time for Alarm 2. More...
void	enableAlarms (const char *socket, bool alarm1, bool alarm2, RtcResult &result)
	Activate alarms pin (if slot activated, INT/MISO pin will be set to LOW when alarms triggered) More...
void	stopAlarm1 (const char *socket, RtcResult &result)
	Clear Alarm 1 triggered status. More...
void	stopAlarm2 (const char *socket, RtcResult &result)
	Clear Alarm 2 triggered status. More...
void	isAlarm1Triggered (const char *socket, RtcAlarmsStatus &status)
	Check Alarm 1 triggered status. More...
void	isAlarm2Triggered (const char *socket, RtcAlarmsStatus &status)
	Check Alarm 2 triggered status. More...
void	setSramValue (const char *socket, RtcSram &sram)
	Write value to SRAM memory. More...
void	getSramValue (const char *socket, RtcSram &sram)
	Get value from SRAM memory. More...

Detailed Description

Class for RTC tibbit control (Tibbit #42)

Examples:

tibbit42.cpp.

Member Function Documentation

void Rtc::enableAlarms	(	const char *	socket,
		bool	alarm1,
		bool	alarm2,
		RtcResult &	result
	)

Activate alarms pin (if slot activated, INT/MISO pin will be set to LOW when alarms triggered)

Parameters

socket	SPI bus name (eg: s1, s15)
alarm1	Alarm 1 activate slot
alarm2	Alarm 2 activate slot
result	Function execution result

Examples:

tibbit42.cpp.

void Rtc::getAlarm1	(	const char *	socket,
		RtcAlarm &	alarm,
		RtcAlarmFlags &	flags
	)

Get time for Alarm 1.

Parameters

socket	SPI bus name (eg: s1, s15)
alarm	Alarm time in RtcAlarm struct
flags	RtcResult struct result

Examples:

tibbit42.cpp.

void Rtc::getAlarm2	(	const char *	socket,
		RtcAlarm &	alarm,
		RtcAlarmFlags &	flags
	)

Get time for Alarm 2.

Parameters

socket	SPI bus name (eg: s1, s15)
alarm	Alarm time in RtcAlarm struct
flags	RtcResult struct result

Examples:

tibbit42.cpp.

void Rtc::getSramValue	(	const char *	socket,
		RtcSram &	sram
	)

Get value from SRAM memory.

Parameters

socket	SPI bus name (eg: s1, s15)
sram	RtcSram data struct

Examples:

tibbit42.cpp.

void Rtc::getTemperature	(	const char *	socket,
		RtcTemp &	temp
	)

Get current temperature in Celsius degrees.

Parameters

socket	SPI bus name (eg: s1, s15)
temp	RtcTemp data struct

Examples:

tibbit42.cpp.

void Rtc::getTime	(	const char *	socket,
		RtcClock &	time
	)

Get current time.

Parameters

socket	SPI bus name (eg: s1, s15)
time	RtcClock data struct

Examples:

tibbit42.cpp.

void Rtc::isAlarm1Triggered	(	const char *	socket,
		RtcAlarmsStatus &	status
	)

Check Alarm 1 triggered status.

Parameters

socket	SPI bus name (eg: s1, s15)
status	RtcAlarmsStatus data struct

Examples:

tibbit42.cpp.

void Rtc::isAlarm2Triggered	(	const char *	socket,
		RtcAlarmsStatus &	status
	)

Check Alarm 2 triggered status.

Parameters

socket	SPI bus name (eg: s1, s15)
status	RtcAlarmsStatus data struct

Examples:

tibbit42.cpp.

void Rtc::setAlarm1	(	const char *	socket,
		RtcAlarm &	alarm,
		RtcAlarmFlags &	flags
	)

Set time for Alarm 1.

Parameters

socket	SPI bus name (eg: s1, s15)
alarm	Alarm time in RtcAlarm struct
flags	Component to be checked to trigger the alarm

Examples:

tibbit42.cpp.

void Rtc::setAlarm2	(	const char *	socket,
		RtcAlarm &	alarm,
		RtcAlarmFlags &	flags
	)

Set time for Alarm 2.

Parameters

socket	SPI bus name (eg: s1, s15)
alarm	Alarm time in RtcAlarm struct
flags	Component to be checked to trigger the alarm

Examples:

tibbit42.cpp.

void Rtc::setSramValue	(	const char *	socket,
		RtcSram &	sram
	)

Write value to SRAM memory.

Parameters

socket	SPI bus name (eg: s1, s15)
sram	RtcSram data struct

Examples:

tibbit42.cpp.

void Rtc::setTime	(	const char *	socket,
		RtcClock &	time
	)

Set current time.

Parameters

socket	SPI bus name (eg: s1, s15)
time	RtcClock data struct

Examples:

tibbit42.cpp.

void Rtc::stopAlarm1	(	const char *	socket,
		RtcResult &	result
	)

Clear Alarm 1 triggered status.

Parameters

socket	SPI bus name (eg: s1, s15)
result	Function execution result

Examples:

tibbit42.cpp.

void Rtc::stopAlarm2	(	const char *	socket,
		RtcResult &	result
	)

Clear Alarm 2 triggered status.

Parameters

socket	SPI bus name (eg: s1, s15)
result	Function execution result

Examples:

tibbit42.cpp.

---

The documentation for this class was generated from the following file:

• rtc.h