Joseph Radford / Mbed 2 deprecated Seeed_Arch_GPRS_V2_Humidty_Alert Featured

A simple WIP that logs data from a Grove sensor, and can send and receive information over USB and SMS.

Dependencies:   DHT DS_1337 SDFileSystem USBDevice mbed

rtc.h@0:2df78a4443cd, 2016-04-10 (annotated)

Committer:
Joseph Radford
Date:
Sun Apr 10 15:47:33 2016 +1000
Revision:
0:2df78a4443cd
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Joseph Radford 0:2df78a4443cd 1 #ifndef __RTC_H__
Joseph Radford 0:2df78a4443cd 2 #define __RTC_H__
Joseph Radford 0:2df78a4443cd 3
Joseph Radford 0:2df78a4443cd 4 #include "mbed.h"
Joseph Radford 0:2df78a4443cd 5
Joseph Radford 0:2df78a4443cd 6 //! The functions needed to configure time in the micro, used in \sa attach_rtc, using the on board DS_1337
Joseph Radford 0:2df78a4443cd 7 /*!
Joseph Radford 0:2df78a4443cd 8 As there is no on-chip RTC, connecting the time functionality to the DS_1337 enables more convenient use of time
Joseph Radford 0:2df78a4443cd 9
Joseph Radford 0:2df78a4443cd 10 The function which is called to configure is as such:
Joseph Radford 0:2df78a4443cd 11 void attach_rtc(time_t (*read_rtc)(void), void (*write_rtc)(time_t), void (*init_rtc)(void), int (*isenabled_rtc)(void))
Joseph Radford 0:2df78a4443cd 12
Joseph Radford 0:2df78a4443cd 13 read_rtc is assigned \sa my_rtc_read
Joseph Radford 0:2df78a4443cd 14
Joseph Radford 0:2df78a4443cd 15 write_rtc is assigned \sa my_rtc_write
Joseph Radford 0:2df78a4443cd 16
Joseph Radford 0:2df78a4443cd 17 init_rtc is assigned \sa my_rtc_init
Joseph Radford 0:2df78a4443cd 18
Joseph Radford 0:2df78a4443cd 19 isenabled_rtc is assigned \sa my_rtc_enabled
Joseph Radford 0:2df78a4443cd 20 */
Joseph Radford 0:2df78a4443cd 21
Joseph Radford 0:2df78a4443cd 22
Joseph Radford 0:2df78a4443cd 23 /*!
Joseph Radford 0:2df78a4443cd 24 * \brief my_rtc_read Interfaces to the on board RTC DS1337 and converts read values to time_t
Joseph Radford 0:2df78a4443cd 25 * \return the value read from the on board RTC converted to system struct time_t
Joseph Radford 0:2df78a4443cd 26 */
Joseph Radford 0:2df78a4443cd 27 time_t my_rtc_read();
Joseph Radford 0:2df78a4443cd 28
Joseph Radford 0:2df78a4443cd 29
Joseph Radford 0:2df78a4443cd 30 /*!
Joseph Radford 0:2df78a4443cd 31 * \brief my_rtc_write Interfaces to the on board RTC DS1337 and converts and writes the time given as time_t
Joseph Radford 0:2df78a4443cd 32 * \param _time is the time in system time_t format which will be written to DS1337
Joseph Radford 0:2df78a4443cd 33 */
Joseph Radford 0:2df78a4443cd 34 void my_rtc_write(time_t _time);
Joseph Radford 0:2df78a4443cd 35
Joseph Radford 0:2df78a4443cd 36
Joseph Radford 0:2df78a4443cd 37 /*!
Joseph Radford 0:2df78a4443cd 38 * \brief my_rtc_init Initialises the RTC DS1337
Joseph Radford 0:2df78a4443cd 39 */
Joseph Radford 0:2df78a4443cd 40 void my_rtc_init();
Joseph Radford 0:2df78a4443cd 41
Joseph Radford 0:2df78a4443cd 42
Joseph Radford 0:2df78a4443cd 43 /*!
Joseph Radford 0:2df78a4443cd 44 * \brief my_rtc_enabled Checks if RTC DS1337 is enabled
Joseph Radford 0:2df78a4443cd 45 * \return 1 if enabled, 0 if not enabled (i.e. \sa my_rtc_init never called)
Joseph Radford 0:2df78a4443cd 46 */
Joseph Radford 0:2df78a4443cd 47 int my_rtc_enabled();
Joseph Radford 0:2df78a4443cd 48
Joseph Radford 0:2df78a4443cd 49
Joseph Radford 0:2df78a4443cd 50 #endif // __RTC_H__