Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/rtc_time.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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