DS1307 Class Reference

API for the DS1307 Real-Time CLock. More...

Detailed Description

• ID: ds1307
• Name: Grove RTC (Real-Time Clock)
• Other Names: DS1307 RTC
• Category: time
• Manufacturer: seeed
• Connection: i2c

UPM module for the DS1307-based real-time clock. The clock can provide information about seconds, minutes, hours, day of the week, day of the month, month, and year. It can operate in either a 24-hour or a 12-hour format. This device can also output a square wave at 1Khz, 4Khz, 8Khz, and 32Khz. However, this capability is not implemented in this module.

  // Instantiate a DS1037 on I2C bus 0
  upm::DS1307 *rtc = new upm::DS1307(0);
  
  // always do this first
  cout << "Loading the current time... " << endl;
  if (!rtc->loadTime())
    {
      cerr << "rtc->loadTime() failed." << endl;
      return 0;
    }
  
  printTime(rtc);

  // set the year as an example
  cout << "setting the year to 50" << endl;
  rtc->year = 50;

  rtc->setTime();

  // reload the time and print it
  rtc->loadTime();
  printTime(rtc);

Public Member Functions
	DS1307 (int bus)
	~DS1307 ()
bool	loadTime ()
bool	setTime ()
mraa_result_t	enableClock ()
mraa_result_t	disableClock ()
mraa_result_t	writeBytes (uint8_t reg, uint8_t *buffer, unsigned int len)
uint8_t	readBytes (uint8_t reg, uint8_t *buffer, unsigned int len)
unsigned int	bcdToDec (uint8_t val)
uint8_t	decToBcd (unsigned int val)

Data Fields
unsigned int	seconds
unsigned int	minutes
unsigned int	hours
unsigned int	dayOfWeek
unsigned int	dayOfMonth
unsigned int	month
unsigned int	year
bool	amPmMode
bool	pm

Constructor & Destructor Documentation

DS1307

(

int

bus

)

DS1307 constructor

Parameters

bus	I2C bus to use

~DS1307

(

)

DS1307 destructor

Member Function Documentation

bool loadTime

(

)

Loads all the time values

Returns

True if time data loaded successfully

bool setTime

(

)

Sets the time. You should call loadTime() beforehand to maintain consistency

Returns

True if time is set successfully

mraa_result_t enableClock

(

)

Enables an oscillator on the clock.

Returns

0 (MRAA_SUCCESS) if successful; non-zero otherwise

mraa_result_t disableClock

(

)

Disables the oscillator on the clock. This prevents the clock from updating any time/date values

Returns

0 (MRAA_SUCCESS) if successful; non-zero otherwise

mraa_result_t writeBytes	(	uint8_t	reg,
		uint8_t *	buffer,
		unsigned int	len
	)

Writes value(s) into registers

Parameters

reg	Register location to start writing into
buffer	Buffer for data storage
len	Number of bytes to write

Returns

0 (MRAA_SUCCESS) if successful; non-zero otherwise

uint8_t readBytes	(	uint8_t	reg,
		uint8_t *	buffer,
		unsigned int	len
	)

Reads value(s) from registers

Parameters

reg	Register location to start reading from
buffer	Buffer for data storage
len	Number of bytes to read

Returns

Number of bytes read

unsigned int bcdToDec

(

uint8_t

val

)

Converts a BCD value into decimal

Parameters

val	BCD value to convert

Returns

Converted decimal value

uint8_t decToBcd

(

unsigned int

val

)

Converts a decimal value into BCD

Parameters

val	Decimal value to convert

Returns

Converted BCD value

Field Documentation

unsigned int seconds

Holds seconds

unsigned int minutes

Holds minutes

unsigned int hours

Holds hours; 1-12 in the am/pm format, 0-23 otherwise

unsigned int dayOfWeek

Holds a day of the week; 1-7, where 1 is Sunday

unsigned int dayOfMonth

Holds a day of the month, 1-31

unsigned int month

Holds a month, 1-12

unsigned int year

Holds a year, 0-99

bool amPmMode

True if the am/pm format is used, false otherwise

bool pm

For the am/pm format, it is true if it's pm, false otherwise

---

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

• /var/lib/jenkins/workspace/upm-doc-stable/src/ds1307/ds1307.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/ds1307/ds1307.cxx