Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/rtc_time.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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