Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

rtc_time.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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