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