anyThing Connected Team / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   BREAK_SENSOR_LED

Fork of mbed-dev by mbed official

platform/rtc_time.h@149:156823d33999, 2016-10-28 (annotated)

Committer:
<>
Date:
Fri Oct 28 11:17:30 2016 +0100
Revision:
149:156823d33999
Child:
160:d5399cc887bb
This updates the lib to the mbed lib v128



NOTE: This release includes a restructuring of the file and directory locations and thus some

include paths in your code may need updating accordingly.

Who changed what in which revision?

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