Jan Wolfsberger / mbed-src-no-hal

mbed library sources that still uses the stm standard peripheral library

Fork of mbed-src by Reinhold Schaefer

api/rtc_time.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 10:3bc89ef62ce7 1 /* mbed Microcontroller Library
emilmont 10:3bc89ef62ce7 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 10:3bc89ef62ce7 3 *
emilmont 10:3bc89ef62ce7 4 * Licensed under the Apache License, Version 2.0 (the "License");
emilmont 10:3bc89ef62ce7 5 * you may not use this file except in compliance with the License.
emilmont 10:3bc89ef62ce7 6 * You may obtain a copy of the License at
emilmont 10:3bc89ef62ce7 7 *
emilmont 10:3bc89ef62ce7 8 * http://www.apache.org/licenses/LICENSE-2.0
emilmont 10:3bc89ef62ce7 9 *
emilmont 10:3bc89ef62ce7 10 * Unless required by applicable law or agreed to in writing, software
emilmont 10:3bc89ef62ce7 11 * distributed under the License is distributed on an "AS IS" BASIS,
emilmont 10:3bc89ef62ce7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
emilmont 10:3bc89ef62ce7 13 * See the License for the specific language governing permissions and
emilmont 10:3bc89ef62ce7 14 * limitations under the License.
emilmont 10:3bc89ef62ce7 15 */
emilmont 10:3bc89ef62ce7 16
emilmont 10:3bc89ef62ce7 17 #include <time.h>
emilmont 10:3bc89ef62ce7 18
emilmont 10:3bc89ef62ce7 19 #ifdef __cplusplus
emilmont 10:3bc89ef62ce7 20 extern "C" {
emilmont 10:3bc89ef62ce7 21 #endif
emilmont 10:3bc89ef62ce7 22
emilmont 10:3bc89ef62ce7 23 /** Implementation of the C time.h functions
emilmont 10:3bc89ef62ce7 24 *
emilmont 10:3bc89ef62ce7 25 * Provides mechanisms to set and read the current time, based
emilmont 10:3bc89ef62ce7 26 * on the microcontroller Real-Time Clock (RTC), plus some
emilmont 10:3bc89ef62ce7 27 * standard C manipulation and formating functions.
emilmont 10:3bc89ef62ce7 28 *
emilmont 10:3bc89ef62ce7 29 * Example:
emilmont 10:3bc89ef62ce7 30 * @code
emilmont 10:3bc89ef62ce7 31 * #include "mbed.h"
emilmont 10:3bc89ef62ce7 32 *
emilmont 10:3bc89ef62ce7 33 * int main() {
emilmont 10:3bc89ef62ce7 34 * set_time(1256729737); // Set RTC time to Wed, 28 Oct 2009 11:35:37
emilmont 10:3bc89ef62ce7 35 *
emilmont 10:3bc89ef62ce7 36 * while(1) {
emilmont 10:3bc89ef62ce7 37 * time_t seconds = time(NULL);
emilmont 10:3bc89ef62ce7 38 *
emilmont 10:3bc89ef62ce7 39 * printf("Time as seconds since January 1, 1970 = %d\n", seconds);
emilmont 10:3bc89ef62ce7 40 *
emilmont 10:3bc89ef62ce7 41 * printf("Time as a basic string = %s", ctime(&seconds));
emilmont 10:3bc89ef62ce7 42 *
emilmont 10:3bc89ef62ce7 43 * char buffer[32];
emilmont 10:3bc89ef62ce7 44 * strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
emilmont 10:3bc89ef62ce7 45 * printf("Time as a custom formatted string = %s", buffer);
emilmont 10:3bc89ef62ce7 46 *
emilmont 10:3bc89ef62ce7 47 * wait(1);
emilmont 10:3bc89ef62ce7 48 * }
emilmont 10:3bc89ef62ce7 49 * }
emilmont 10:3bc89ef62ce7 50 * @endcode
emilmont 10:3bc89ef62ce7 51 */
emilmont 10:3bc89ef62ce7 52
emilmont 10:3bc89ef62ce7 53 /** Set the current time
emilmont 10:3bc89ef62ce7 54 *
emilmont 10:3bc89ef62ce7 55 * Initialises and sets the time of the microcontroller Real-Time Clock (RTC)
emilmont 10:3bc89ef62ce7 56 * to the time represented by the number of seconds since January 1, 1970
emilmont 10:3bc89ef62ce7 57 * (the UNIX timestamp).
emilmont 10:3bc89ef62ce7 58 *
emilmont 10:3bc89ef62ce7 59 * @param t Number of seconds since January 1, 1970 (the UNIX timestamp)
emilmont 10:3bc89ef62ce7 60 *
emilmont 10:3bc89ef62ce7 61 * Example:
emilmont 10:3bc89ef62ce7 62 * @code
emilmont 10:3bc89ef62ce7 63 * #include "mbed.h"
emilmont 10:3bc89ef62ce7 64 *
emilmont 10:3bc89ef62ce7 65 * int main() {
emilmont 10:3bc89ef62ce7 66 * set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37
emilmont 10:3bc89ef62ce7 67 * }
emilmont 10:3bc89ef62ce7 68 * @endcode
emilmont 10:3bc89ef62ce7 69 */
emilmont 10:3bc89ef62ce7 70 void set_time(time_t t);
emilmont 10:3bc89ef62ce7 71
emilmont 10:3bc89ef62ce7 72 #ifdef __cplusplus
emilmont 10:3bc89ef62ce7 73 }
emilmont 10:3bc89ef62ce7 74 #endif