R L / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/rtc_time.h@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
capi/rtc_time.h@2:143cac498751
Child:
10:3bc89ef62ce7
Refactoring of the mbed SDK:

- Provide a well defined HAL and API

- Keep separated the HAL implementations for the different targets

Who changed what in which revision?

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