rtc_time.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 
00023 #include <time.h>
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /** Implementation of the C time.h functions
00030  *
00031  * Provides mechanisms to set and read the current time, based
00032  * on the microcontroller Real-Time Clock (RTC), plus some
00033  * standard C manipulation and formating functions.
00034  *
00035  * Example:
00036  * @code
00037  * #include "mbed.h"
00038  *
00039  * int main() {
00040  *     set_time(1256729737);  // Set RTC time to Wed, 28 Oct 2009 11:35:37
00041  *
00042  *     while(1) {
00043  *         time_t seconds = time(NULL);
00044  *
00045  *         printf("Time as seconds since January 1, 1970 = %d\n", seconds);
00046  *
00047  *         printf("Time as a basic string = %s", ctime(&seconds));
00048  *
00049  *         char buffer[32];
00050  *         strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
00051  *         printf("Time as a custom formatted string = %s", buffer);
00052  *
00053  *         wait(1);
00054  *     }
00055  * }
00056  * @endcode
00057  */
00058 
00059 /** Set the current time
00060  *
00061  * Initialises and sets the time of the microcontroller Real-Time Clock (RTC)
00062  * to the time represented by the number of seconds since January 1, 1970
00063  * (the UNIX timestamp).
00064  *
00065  * @param t Number of seconds since January 1, 1970 (the UNIX timestamp)
00066  *
00067  * Example:
00068  * @code
00069  * #include "mbed.h"
00070  *
00071  * int main() {
00072  *     set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37
00073  * }
00074  * @endcode
00075  */
00076 void set_time(time_t t);
00077 
00078 #ifdef __cplusplus
00079 }
00080 #endif
00081