Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

rtc_time.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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