Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

rtc_time.h@2:e9a661555b58, 2012-10-10 (annotated)

Committer:
emilmont
Date:
Wed Oct 10 14:14:12 2012 +0000
Revision:
2:e9a661555b58
Parent:
0:8024c367e29f
Child:
8:c14af7958ef5
Add PWM and I2C implementation;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 2:e9a661555b58 1 /* Title: time
emilmont 2:e9a661555b58 2 * Implementation of the C time.h functions
emilmont 2:e9a661555b58 3 *
emilmont 2:e9a661555b58 4 * Provides mechanisms to set and read the current time, based
emilmont 2:e9a661555b58 5 * on the microcontroller Real-Time Clock (RTC), plus some
emilmont 2:e9a661555b58 6 * standard C manipulation and formating functions.
emilmont 2:e9a661555b58 7 *
emilmont 2:e9a661555b58 8 * Example:
emilmont 2:e9a661555b58 9 * > #include "mbed.h"
emilmont 2:e9a661555b58 10 * >
emilmont 2:e9a661555b58 11 * > int main() {
emilmont 2:e9a661555b58 12 * > set_time(1256729737); // Set RTC time to Wed, 28 Oct 2009 11:35:37
emilmont 2:e9a661555b58 13 * >
emilmont 2:e9a661555b58 14 * > while(1) {
emilmont 2:e9a661555b58 15 * > time_t seconds = time(NULL);
emilmont 2:e9a661555b58 16 * >
emilmont 2:e9a661555b58 17 * > printf("Time as seconds since January 1, 1970 = %d\n", seconds);
emilmont 2:e9a661555b58 18 * >
emilmont 2:e9a661555b58 19 * > printf("Time as a basic string = %s", ctime(&seconds));
emilmont 2:e9a661555b58 20 * >
emilmont 2:e9a661555b58 21 * > char buffer[32];
emilmont 2:e9a661555b58 22 * > strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
emilmont 2:e9a661555b58 23 * > printf("Time as a custom formatted string = %s", buffer);
emilmont 2:e9a661555b58 24 * >
emilmont 2:e9a661555b58 25 * > wait(1);
emilmont 2:e9a661555b58 26 * > }
emilmont 2:e9a661555b58 27 * > }
emilmont 2:e9a661555b58 28 */
emilmont 2:e9a661555b58 29
emilmont 2:e9a661555b58 30 /* mbed Microcontroller Library - rtc_time
emilmont 2:e9a661555b58 31 * Copyright (c) 2009 ARM Limited. All rights reserved.
emilmont 2:e9a661555b58 32 */
emilmont 2:e9a661555b58 33
emilmont 2:e9a661555b58 34 #include <time.h>
emilmont 2:e9a661555b58 35
emilmont 2:e9a661555b58 36 #ifdef __cplusplus
emilmont 2:e9a661555b58 37 extern "C" {
emilmont 2:e9a661555b58 38 #endif
emilmont 2:e9a661555b58 39
emilmont 2:e9a661555b58 40 #if 0 // for documentation only
emilmont 2:e9a661555b58 41 /* Function: time
emilmont 2:e9a661555b58 42 * Get the current time
emilmont 2:e9a661555b58 43 *
emilmont 2:e9a661555b58 44 * Returns the current timestamp as the number of seconds since January 1, 1970
emilmont 2:e9a661555b58 45 * (the UNIX timestamp). The value is based on the current value of the
emilmont 2:e9a661555b58 46 * microcontroller Real-Time Clock (RTC), which can be set using <set_time>.
emilmont 2:e9a661555b58 47 *
emilmont 2:e9a661555b58 48 * Example:
emilmont 2:e9a661555b58 49 * > #include "mbed.h"
emilmont 2:e9a661555b58 50 * >
emilmont 2:e9a661555b58 51 * > int main() {
emilmont 2:e9a661555b58 52 * > time_t seconds = time(NULL);
emilmont 2:e9a661555b58 53 * > printf("It is %d seconds since January 1, 1970\n", seconds);
emilmont 2:e9a661555b58 54 * > }
emilmont 2:e9a661555b58 55 *
emilmont 2:e9a661555b58 56 * Variables:
emilmont 2:e9a661555b58 57 * t - Pointer to a time_t to be set, or NULL if not used
emilmont 2:e9a661555b58 58 * returns - Number of seconds since January 1, 1970 (the UNIX timestamp)
emilmont 2:e9a661555b58 59 */
emilmont 2:e9a661555b58 60 time_t time(time_t *t);
emilmont 2:e9a661555b58 61 #endif
emilmont 2:e9a661555b58 62
emilmont 2:e9a661555b58 63 /* Function: set_time
emilmont 2:e9a661555b58 64 * Set the current time
emilmont 2:e9a661555b58 65 *
emilmont 2:e9a661555b58 66 * Initialises and sets the time of the microcontroller Real-Time Clock (RTC)
emilmont 2:e9a661555b58 67 * to the time represented by the number of seconds since January 1, 1970
emilmont 2:e9a661555b58 68 * (the UNIX timestamp).
emilmont 2:e9a661555b58 69 *
emilmont 2:e9a661555b58 70 * Example:
emilmont 2:e9a661555b58 71 * > #include "mbed.h"
emilmont 2:e9a661555b58 72 * >
emilmont 2:e9a661555b58 73 * > int main() {
emilmont 2:e9a661555b58 74 * > set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37
emilmont 2:e9a661555b58 75 * > }
emilmont 2:e9a661555b58 76 *
emilmont 2:e9a661555b58 77 * Variables:
emilmont 2:e9a661555b58 78 * t - Number of seconds since January 1, 1970 (the UNIX timestamp)
emilmont 2:e9a661555b58 79 */
emilmont 2:e9a661555b58 80 void set_time(time_t t);
emilmont 2:e9a661555b58 81
emilmont 2:e9a661555b58 82 #if 0 // for documentation only
emilmont 2:e9a661555b58 83 /* Function: mktime
emilmont 2:e9a661555b58 84 * Converts a tm structure in to a timestamp
emilmont 2:e9a661555b58 85 *
emilmont 2:e9a661555b58 86 * Converts the tm structure in to a timestamp in seconds since January 1, 1970
emilmont 2:e9a661555b58 87 * (the UNIX timestamp). The values of tm_wday and tm_yday of the tm structure
emilmont 2:e9a661555b58 88 * are also updated to their appropriate values.
emilmont 2:e9a661555b58 89 *
emilmont 2:e9a661555b58 90 * Example:
emilmont 2:e9a661555b58 91 * > #include "mbed.h"
emilmont 2:e9a661555b58 92 * >
emilmont 2:e9a661555b58 93 * > int main() {
emilmont 2:e9a661555b58 94 * > // setup time structure for Wed, 28 Oct 2009 11:35:37
emilmont 2:e9a661555b58 95 * > struct tm t;
emilmont 2:e9a661555b58 96 * > t.tm_sec = 37; // 0-59
emilmont 2:e9a661555b58 97 * > t.tm_min = 35; // 0-59
emilmont 2:e9a661555b58 98 * > t.tm_hour = 11; // 0-23
emilmont 2:e9a661555b58 99 * > t.tm_mday = 28; // 1-31
emilmont 2:e9a661555b58 100 * > t.tm_mon = 9; // 0-11
emilmont 2:e9a661555b58 101 * > t.tm_year = 109; // year since 1900
emilmont 2:e9a661555b58 102 * >
emilmont 2:e9a661555b58 103 * > // convert to timestamp and display (1256729737)
emilmont 2:e9a661555b58 104 * > time_t seconds = mktime(&t);
emilmont 2:e9a661555b58 105 * > printf("Time as seconds since January 1, 1970 = %d\n", seconds);
emilmont 2:e9a661555b58 106 * > }
emilmont 2:e9a661555b58 107 *
emilmont 2:e9a661555b58 108 * Variables:
emilmont 2:e9a661555b58 109 * t - The tm structure to convert
emilmont 2:e9a661555b58 110 * returns - The converted timestamp
emilmont 2:e9a661555b58 111 */
emilmont 2:e9a661555b58 112 time_t mktime(struct tm *t);
emilmont 2:e9a661555b58 113 #endif
emilmont 2:e9a661555b58 114
emilmont 2:e9a661555b58 115 #if 0 // for documentation only
emilmont 2:e9a661555b58 116 /* Function: localtime
emilmont 2:e9a661555b58 117 * Converts a timestamp in to a tm structure
emilmont 2:e9a661555b58 118 *
emilmont 2:e9a661555b58 119 * Converts the timestamp pointed to by t to a (statically allocated)
emilmont 2:e9a661555b58 120 * tm structure.
emilmont 2:e9a661555b58 121 *
emilmont 2:e9a661555b58 122 * Example:
emilmont 2:e9a661555b58 123 * > #include "mbed.h"
emilmont 2:e9a661555b58 124 * >
emilmont 2:e9a661555b58 125 * > int main() {
emilmont 2:e9a661555b58 126 * > time_t seconds = 1256729737;
emilmont 2:e9a661555b58 127 * > struct tm *t = localtime(&seconds);
emilmont 2:e9a661555b58 128 * > }
emilmont 2:e9a661555b58 129 *
emilmont 2:e9a661555b58 130 * Variables:
emilmont 2:e9a661555b58 131 * t - Pointer to the timestamp
emilmont 2:e9a661555b58 132 * returns - Pointer to the (statically allocated) tm structure
emilmont 2:e9a661555b58 133 */
emilmont 2:e9a661555b58 134 struct tm *localtime(const time_t *t);
emilmont 2:e9a661555b58 135 #endif
emilmont 2:e9a661555b58 136
emilmont 2:e9a661555b58 137 #if 0 // for documentation only
emilmont 2:e9a661555b58 138 /* Function: ctime
emilmont 2:e9a661555b58 139 * Converts a timestamp to a human-readable string
emilmont 2:e9a661555b58 140 *
emilmont 2:e9a661555b58 141 * Converts a time_t timestamp in seconds since January 1, 1970 (the UNIX
emilmont 2:e9a661555b58 142 * timestamp) to a human readable string format. The result is of the
emilmont 2:e9a661555b58 143 * format: "Wed Oct 28 11:35:37 2009\n"
emilmont 2:e9a661555b58 144 *
emilmont 2:e9a661555b58 145 * Example:
emilmont 2:e9a661555b58 146 * > #include "mbed.h"
emilmont 2:e9a661555b58 147 * >
emilmont 2:e9a661555b58 148 * > int main() {
emilmont 2:e9a661555b58 149 * > time_t seconds = time(NULL);
emilmont 2:e9a661555b58 150 * > printf("Time as a string = %s", ctime(&seconds));
emilmont 2:e9a661555b58 151 * > }
emilmont 2:e9a661555b58 152 *
emilmont 2:e9a661555b58 153 * Variables:
emilmont 2:e9a661555b58 154 * t - The timestamp to convert
emilmont 2:e9a661555b58 155 * returns - Pointer to a (statically allocated) string containing the
emilmont 2:e9a661555b58 156 * human readable representation, including a '\n' character
emilmont 2:e9a661555b58 157 */
emilmont 2:e9a661555b58 158 char *ctime(const time_t *t);
emilmont 2:e9a661555b58 159 #endif
emilmont 2:e9a661555b58 160
emilmont 2:e9a661555b58 161 #if 0 // for documentation only
emilmont 2:e9a661555b58 162 /* Function: strftime
emilmont 2:e9a661555b58 163 * Converts a tm structure to a custom format human-readable string
emilmont 2:e9a661555b58 164 *
emilmont 2:e9a661555b58 165 * Creates a formated string from a tm structure, based on a string format
emilmont 2:e9a661555b58 166 * specifier provided.
emilmont 2:e9a661555b58 167 *
emilmont 2:e9a661555b58 168 * Format Specifiers:
emilmont 2:e9a661555b58 169 * %S - Second (00-59)
emilmont 2:e9a661555b58 170 * %M - Minute (00-59)
emilmont 2:e9a661555b58 171 * %H - Hour (00-23)
emilmont 2:e9a661555b58 172 * %d - Day (01-31)
emilmont 2:e9a661555b58 173 * %m - Month (01-12)
emilmont 2:e9a661555b58 174 * %Y/%y - Year (2009/09)
emilmont 2:e9a661555b58 175 *
emilmont 2:e9a661555b58 176 * %A/%a - Weekday Name (Monday/Mon)
emilmont 2:e9a661555b58 177 * %B/%b - Month Name (January/Jan)
emilmont 2:e9a661555b58 178 * %I - 12 Hour Format (01-12)
emilmont 2:e9a661555b58 179 * %p - "AM" or "PM"
emilmont 2:e9a661555b58 180 * %X - Time (14:55:02)
emilmont 2:e9a661555b58 181 * %x - Date (08/23/01)
emilmont 2:e9a661555b58 182 *
emilmont 2:e9a661555b58 183 * Example:
emilmont 2:e9a661555b58 184 * > #include "mbed.h"
emilmont 2:e9a661555b58 185 * >
emilmont 2:e9a661555b58 186 * > int main() {
emilmont 2:e9a661555b58 187 * > time_t seconds = time(NULL);
emilmont 2:e9a661555b58 188 * >
emilmont 2:e9a661555b58 189 * > char buffer[32];
emilmont 2:e9a661555b58 190 * > strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
emilmont 2:e9a661555b58 191 * > printf("Time as a formatted string = %s", buffer);
emilmont 2:e9a661555b58 192 * > }
emilmont 2:e9a661555b58 193 *
emilmont 2:e9a661555b58 194 * Variables:
emilmont 2:e9a661555b58 195 * buffer - String buffer to store the result
emilmont 2:e9a661555b58 196 * max - Maximum number of characters to store in the buffer
emilmont 2:e9a661555b58 197 * format - Format specifier string
emilmont 2:e9a661555b58 198 * t - Pointer to the tm structure to convert
emilmont 2:e9a661555b58 199 * returns - Number of characters copied
emilmont 2:e9a661555b58 200 */
emilmont 2:e9a661555b58 201 size_t strftime(char *buffer, size_t max, const char *format, const struct tm *t);
emilmont 2:e9a661555b58 202 #endif
emilmont 2:e9a661555b58 203
emilmont 2:e9a661555b58 204 #ifdef __cplusplus
emilmont 2:e9a661555b58 205 }
emilmont 2:e9a661555b58 206 #endif