Greg Steiert / maxim_dev

Maxim mbed development library

Dependents:   sensomed

platform/rtc_time.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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