Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/rtc_time.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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