Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/mbed_rtc_time.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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