Alessandro Angelino / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/rtc_time.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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