Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

rtc_time.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
96:487b796308b0 
.

Who changed what in which revision?

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