mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

rtc_time.h

Committer:
emilmont
Date:
2012-11-09
Revision:
8:c14af7958ef5
Parent:
2:e9a661555b58
Child:
9:663789d7729f

File content as of revision 8:c14af7958ef5:

/** Implementation of the C time.h functions
 *
 * Provides mechanisms to set and read the current time, based
 * on the microcontroller Real-Time Clock (RTC), plus some 
 * standard C manipulation and formating functions. 
 *
 * Example:
 * @code
 * #include "mbed.h"
 *
 * int main() {
 *     set_time(1256729737);  // Set RTC time to Wed, 28 Oct 2009 11:35:37
 *      
 *     while(1) {    
 *         time_t seconds = time(NULL);
 *         
 *         printf("Time as seconds since January 1, 1970 = %d\n", seconds);
 *  
 *         printf("Time as a basic string = %s", ctime(&seconds));
 *
 *         char buffer[32];
 *         strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
 *         printf("Time as a custom formatted string = %s", buffer);
 *    
 *         wait(1);
 *     }
 * }
 * @endcode
 */
 
/* mbed Microcontroller Library - rtc_time
 * Copyright (c) 2009 ARM Limited. All rights reserved.
 */

#include <time.h>

#ifdef __cplusplus
extern "C" {
#endif

/** Set the current time
 *
 * Initialises and sets the time of the microcontroller Real-Time Clock (RTC)
 * to the time represented by the number of seconds since January 1, 1970 
 * (the UNIX timestamp). 
 * 
 * @param t Number of seconds since January 1, 1970 (the UNIX timestamp) 
 *
 * Example:
 * @code
 * #include "mbed.h"
 *
 * int main() {
 *     set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37
 * }
 * @endcode
 */ 
void set_time(time_t t);

#ifdef __cplusplus
}
#endif