Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/mbed_rtc_time.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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