Joris Aerts / mbed-src

mbed library sources

Dependents:   Marvino mbot

Fork of mbed-src by mbed official

capi/rtc_time.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22
mbed_official 0:fd0d7bdfcdc2 23 #include <time.h>
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 26 extern "C" {
mbed_official 0:fd0d7bdfcdc2 27 #endif
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 /** Implementation of the C time.h functions
mbed_official 0:fd0d7bdfcdc2 30 *
mbed_official 0:fd0d7bdfcdc2 31 * Provides mechanisms to set and read the current time, based
mbed_official 0:fd0d7bdfcdc2 32 * on the microcontroller Real-Time Clock (RTC), plus some
mbed_official 0:fd0d7bdfcdc2 33 * standard C manipulation and formating functions.
mbed_official 0:fd0d7bdfcdc2 34 *
mbed_official 0:fd0d7bdfcdc2 35 * Example:
mbed_official 0:fd0d7bdfcdc2 36 * @code
mbed_official 0:fd0d7bdfcdc2 37 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * int main() {
mbed_official 0:fd0d7bdfcdc2 40 * set_time(1256729737); // Set RTC time to Wed, 28 Oct 2009 11:35:37
mbed_official 0:fd0d7bdfcdc2 41 *
mbed_official 0:fd0d7bdfcdc2 42 * while(1) {
mbed_official 0:fd0d7bdfcdc2 43 * time_t seconds = time(NULL);
mbed_official 0:fd0d7bdfcdc2 44 *
mbed_official 0:fd0d7bdfcdc2 45 * printf("Time as seconds since January 1, 1970 = %d\n", seconds);
mbed_official 0:fd0d7bdfcdc2 46 *
mbed_official 0:fd0d7bdfcdc2 47 * printf("Time as a basic string = %s", ctime(&seconds));
mbed_official 0:fd0d7bdfcdc2 48 *
mbed_official 0:fd0d7bdfcdc2 49 * char buffer[32];
mbed_official 0:fd0d7bdfcdc2 50 * strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
mbed_official 0:fd0d7bdfcdc2 51 * printf("Time as a custom formatted string = %s", buffer);
mbed_official 0:fd0d7bdfcdc2 52 *
mbed_official 0:fd0d7bdfcdc2 53 * wait(1);
mbed_official 0:fd0d7bdfcdc2 54 * }
mbed_official 0:fd0d7bdfcdc2 55 * }
mbed_official 0:fd0d7bdfcdc2 56 * @endcode
mbed_official 0:fd0d7bdfcdc2 57 */
mbed_official 0:fd0d7bdfcdc2 58
mbed_official 0:fd0d7bdfcdc2 59 /** Set the current time
mbed_official 0:fd0d7bdfcdc2 60 *
mbed_official 0:fd0d7bdfcdc2 61 * Initialises and sets the time of the microcontroller Real-Time Clock (RTC)
mbed_official 0:fd0d7bdfcdc2 62 * to the time represented by the number of seconds since January 1, 1970
mbed_official 0:fd0d7bdfcdc2 63 * (the UNIX timestamp).
mbed_official 0:fd0d7bdfcdc2 64 *
mbed_official 0:fd0d7bdfcdc2 65 * @param t Number of seconds since January 1, 1970 (the UNIX timestamp)
mbed_official 0:fd0d7bdfcdc2 66 *
mbed_official 0:fd0d7bdfcdc2 67 * Example:
mbed_official 0:fd0d7bdfcdc2 68 * @code
mbed_official 0:fd0d7bdfcdc2 69 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 70 *
mbed_official 0:fd0d7bdfcdc2 71 * int main() {
mbed_official 0:fd0d7bdfcdc2 72 * set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37
mbed_official 0:fd0d7bdfcdc2 73 * }
mbed_official 0:fd0d7bdfcdc2 74 * @endcode
mbed_official 0:fd0d7bdfcdc2 75 */
mbed_official 0:fd0d7bdfcdc2 76 void set_time(time_t t);
mbed_official 0:fd0d7bdfcdc2 77
mbed_official 0:fd0d7bdfcdc2 78 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 79 }
mbed_official 0:fd0d7bdfcdc2 80 #endif