mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_rtc_time.h@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Parent:
138:093f2bd7b9eb 
Release 145 of the mbed library.

Who changed what in which revision?

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