cc y / mbed

ads1115 only

Fork of mbed by mbed official

platform/rtc_time.h@135:fce8a9387ed1, 2017-01-17 (annotated)

Committer:
kaoshen
Date:
Tue Jan 17 23:27:32 2017 +0000
Revision:
135:fce8a9387ed1
Parent:
128:9bcdf88f62b0 
333 ADS1115 ADC1

Who changed what in which revision?

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