Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
sntp_helper.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021, Cascoda
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
44 #ifndef WALL_TIME_H
45 #define WALL_TIME_H
46 
47 #include "ca821x_error.h"
48 
50 {
51  NO_TIME = 0,
56 };
57 
62 void SNTP_Init();
63 
83 
94 
95 #endif // WALL_TIME_H
96 
Global error declarations for use across the Cascoda SDK.
ca_error
Cascoda error type.
Definition: ca821x_error.h:51
void SNTP_Init()
Initialise the SNTP library.
Definition: sntp_helper.c:65
ca_error SNTP_Update()
Start the process for updating the RTC using an SNTP request.
Definition: sntp_helper.c:70
enum sntp_query_state SNTP_GetState()
Get the status of the library, which indicates whether the RTC has been updated using SNTP.
Definition: sntp_helper.c:186
sntp_query_state
Definition: sntp_helper.h:50
@ WAITING_FOR_SNTP
Definition: sntp_helper.h:53
@ NO_TIME
Definition: sntp_helper.h:51
@ RETRYING
Definition: sntp_helper.h:55
@ WAITING_FOR_DNS
Definition: sntp_helper.h:52
@ HAVE_TIME
Definition: sntp_helper.h:54