Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/rtc_time.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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