Blame view

mbed/rtc_time.h 2.62 KB
f7c9a8e1   jdenecha   Feat : Firt dump
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
  /* mbed Microcontroller Library

   * Copyright (c) 2006-2013 ARM Limited

   *

   * Licensed under the Apache License, Version 2.0 (the "License");

   * you may not use this file except in compliance with the License.

   * You may obtain a copy of the License at

   *

   *     http://www.apache.org/licenses/LICENSE-2.0

   *

   * Unless required by applicable law or agreed to in writing, software

   * distributed under the License is distributed on an "AS IS" BASIS,

   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   * See the License for the specific language governing permissions and

   * limitations under the License.

   */

  

  #include <time.h>

  

  #ifdef __cplusplus

  extern "C" {

  #endif

  

  /** Implementation of the C time.h functions

   *

   * Provides mechanisms to set and read the current time, based

   * on the microcontroller Real-Time Clock (RTC), plus some

   * standard C manipulation and formating functions.

   *

   * Example:

   * @code

   * #include "mbed.h"

   *

   * int main() {

   *     set_time(1256729737);  // Set RTC time to Wed, 28 Oct 2009 11:35:37

   *

   *     while(1) {

   *         time_t seconds = time(NULL);

   *

   *         printf("Time as seconds since January 1, 1970 = %d\n", seconds);

   *

   *         printf("Time as a basic string = %s", ctime(&seconds));

   *

   *         char buffer[32];

   *         strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));

   *         printf("Time as a custom formatted string = %s", buffer);

   *

   *         wait(1);

   *     }

   * }

   * @endcode

   */

  

  /** Set the current time

   *

   * Initialises and sets the time of the microcontroller Real-Time Clock (RTC)

   * to the time represented by the number of seconds since January 1, 1970

   * (the UNIX timestamp).

   *

   * @param t Number of seconds since January 1, 1970 (the UNIX timestamp)

   *

   * Example:

   * @code

   * #include "mbed.h"

   *

   * int main() {

   *     set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37

   * }

   * @endcode

   */

  void set_time(time_t t);

  

  /** Attach an external RTC to be used for the C time functions

   *

   * Do not call this function from an interrupt while an RTC read/write operation may be occurring 

   *

   * @param read_rtc pointer to function which returns current UNIX timestamp

   * @param write_rtc pointer to function which sets current UNIX timestamp, can be NULL

   * @param init_rtc pointer to funtion which initializes RTC, can be NULL

   * @param isenabled_rtc pointer to function wich returns if the rtc is enabled, can be NULL

   */

  void attach_rtc(time_t (*read_rtc)(void), void (*write_rtc)(time_t), void (*init_rtc)(void), int (*isenabled_rtc)(void));

  

  #ifdef __cplusplus

  }

  #endif