Jhon Plantikow / Dataloger

Dataloger

rtc_time.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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