CRAC Team / CRAC-Strat_2017-19-05-2017

strat des robots

Fork of CRAC-Strat_2017 by CRAC Team

mbed/rtc_time.h@17:d1594579eec6, 2017-05-19 (annotated)

Committer:
ClementBreteau
Date:
Fri May 19 17:14:07 2017 +0000
Revision:
17:d1594579eec6
Parent:
0:ad97421fb1fb 
strat du robot, 19-05-2017, 19h

Who changed what in which revision?

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