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
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/*
* FreeRTOS V202107.00
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* http://www.FreeRTOS.org
* http://aws.amazon.com/freertos
*/
#ifndef COMMON_DEMO_INCLUDE_H
#define COMMON_DEMO_INCLUDE_H
#include "demo_config.h"
/**
* @brief Utility macro to convert milliseconds to the fractions value of an SNTP timestamp.
* @note The fractions value MUST be less than 1000 as duration of seconds is not represented
* as fractions part of SNTP timestamp.
*/
#define MILLISECONDS_TO_SNTP_FRACTIONS( ms ) ( ms * 1000 * SNTP_FRACTION_VALUE_PER_MICROSECOND )
/**
* @brief Type representing system time in Coordinated Universal Time (UTC)
* zone as time since 1st January 1970 00h:00m:00s.
*
* @note This demo uses RAM-based mathematical model to represent UTC time
* in system.
*/
typedef struct UTCTime
{
uint32_t secs;
uint32_t msecs;
} UTCTime_t;
/**
* @brief Utility function to print the system time as both UNIX time (i.e.
* time since 1st January 1970 00h:00m:00s) and human-readable time (in the
* YYYY-MM-DD dd:mm:ss format).
*
* @param[in] pTime The system time to be printed.
*/
void printTime( const UTCTime_t * pTime );
/**
* @brief Initializes the system clock with the first second of the year (i.e. at midnight
* of 1st January) that is configured in the democonfigSYSTEM_START_YEAR config of
* demo_config.h file.
*/
void initializeSystemClock( void );
/**
* @brief The demo function for an application to query wall-clock
* time as Coordinated Universal Time (UTC) from the system.
*
* @note This demo showcases a RAM-based mathematical model for
* representing current UTC time in the system.
*
* @param[out] pTime This will be populated with the current time
* in the system as total time since 1st January 1900 00h:00m:00s.
*/
void systemGetWallClockTime( UTCTime_t * pTime );
/**
* @brief The task function for a sample application that queries
* system time periodically.
*/
void sampleAppTask( void * pvParameters );
/**
* @brief The task function that represents a daemon SNTP client task
* that is responsible for periodically synchronizing system time with
* time servers from the list of configured time servers in
* democonfigLIST_OF_TIME_SERVERS.
*
* @note The usage of the coreSNTP library API is encapsulated within
* this task. The rest of the FreeRTOS tasks/application does not need
* to be aware of the SNTP client as they can query time from the
* @ref systemGetWallClockTime() function.
*/
void sntpTask( void * parameters );
#endif /* ifndef COMMON_DEMO_INCLUDE_H */
|
