MD_DS1307.h File Reference

Main header file for the MD_DS1307 library. More...

#include <Arduino.h>

Include dependency graph for MD_DS1307.h:

Classes
class	MD_DS1307

Macros
#define	DS1307_CLOCK_HALT   0
	Controls the clock halt (CH) bit. When set OFF the oscillator/clock is disabled. CH is disabled on power up. More...
#define	DS1307_SQW_RUN   1
	Controls the Square Wave Enable (SQWE) bit. SQWE is OFF when power is first applied.
#define	DS1307_SQW_TYPE_ON   2
	Controls the two RS bits that set the frequency of the square wave when the square wave output is enabled.
#define	DS1307_SQW_TYPE_OFF   3
	Controls the OUT bit that sets the output level of the SQW/OUT pin when the square wave output is disabled. On power up this hardware bit set to LOW.
#define	DS1307_12H   4
	Controls whether the library is using 24 hour time or AM/PM designation. Setting ON enables 12 hour time and AM/PM.
#define	DS1307_ERROR   0
	An error occurred executing the requested action. More...
#define	DS1307_ON   1
	Represents an ON status to set or returned from a get.
#define	DS1307_OFF   2
	Represents an OFF status to set or returned from a get.
#define	DS1307_SQW_1HZ   3
	Set or get 1Hz square wave specifier for SQW_TYPE parameter.
#define	DS1307_SQW_4KHZ   4
	Set or get 4kHz square wave specifier for SQW_TYPE parameter.
#define	DS1307_SQW_8KHZ   5
	Set or get 8kHz square wave specifier for SQW_TYPE parameter.
#define	DS1307_SQW_32KHZ   6
	Set or get 32kHz square wave specifier for SQW_TYPE parameter.
#define	DS1307_SQW_HIGH   7
	Represents a HIGH status to set or returned from a get.
#define	DS1307_SQW_LOW   8
	Represents an LOW status to set or returned from a get.
#define	DS1307_RAM_MAX   64
	Total number of RAM registers that can be read from the device.

Variables
MD_DS1307	RTC
	Library created instance of the RTC class.

Detailed Description

Main header file for the MD_DS1307 library.

Macro Definition Documentation

DS1307_CLOCK_HALT

#define DS1307_CLOCK_HALT   0

Controls the clock halt (CH) bit. When set OFF the oscillator/clock is disabled. CH is disabled on power up.

Control and Status Request.

These definitions are used with the control() and status() methods to identify the control action request.

DS1307_ERROR

#define DS1307_ERROR   0

An error occurred executing the requested action.

Control and Status Request return values.

These values are used as the return status from the control() and status() methods.