clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/rtc_time.h@0:c03cffe402df, 2016-02-03 (annotated)

Committer:
slowness
Date:
Wed Feb 03 14:01:53 2016 +0000
Revision:
0:c03cffe402df
Pour configurer les AX12 avec la carte NXP1768 sur les Pin 9 et 10

Who changed what in which revision?

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