alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-06-10 07:10:22 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

ds1307: header update

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-09 12:12:33 -07:00
parent b243290a36
commit 9b3befd6f2
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/ds1307/ds1307.h
View File

@ -42,18 +42,29 @@
#define DS1307_DAY_SUN 7 #define DS1307_DAY_SUN 7
namespace upm { namespace upm {
/**
* @brief DS1307 Real Time CLock library
* @defgroup ds1307 libupm-ds1307
* @ingroup seeed i2c time
*/
/** /**
* @library ds1307
* @sensor ds1307
* @comname Grove RTC (Real Time Clock)
* @altname DS1307
* @type time
* @man seeed
* @con i2c
*
* @brief C++ API for the DS1307 Real Time CLock * @brief C++ API for the DS1307 Real Time CLock
* *
* UPM module for the DS1307 based RTC. The clock can provide information * UPM module for the DS1307 based RTC. The clock can provide information
* about the seconds, minutes, hours, day of the week, day of the month, * about the seconds, minutes, hours, day of the week, day of the month,
* month, and year. It can operate in either 24-hour or 12-hour format. * month, and year. It can operate in either 24-hour or 12-hour format.
* * This device can also output a square wave at 1Khz, 4Khz, 8Khz, and 32Khz.
* This device can also output a square wave at 1Khz, 4Khz, 8Khz, and 32Khz.
* However, this capability is not implemented in this module. * However, this capability is not implemented in this module.
* *
* @ingroup i2c ds1307 RTC
* @snippet ds1307.cxx Interesting * @snippet ds1307.cxx Interesting
*/ */
class DS1307 { class DS1307 {
@ -86,7 +97,7 @@ namespace upm {
bool setTime(); bool setTime();
/** /**
* Enable the oscillator on the clock. * Enable the oscillator on the clock.
* *
* @return 0 (MRAA_SUCCESS) if successful; non-zero otherwise * @return 0 (MRAA_SUCCESS) if successful; non-zero otherwise
*/ */