Vladimir Vana / mbed

pro vyuku PSS v Jecne

rtc_time.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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