Skip to content

Commit 682a159

Browse files
committed
Add NTP Client service documentation
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent d0f951a commit 682a159

File tree

4 files changed

+31
-3
lines changed

4 files changed

+31
-3
lines changed

docs/Doxyfile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -851,9 +851,9 @@ INPUT = ../include/arpa/inet.h \
851851
../include/driver/dht.h \
852852
../include/driver/ds18b20.h \
853853
../include/driver/onewire.h \
854-
../include/gpslib.h \
854+
../include/gpslib.h \
855855
../include/hw/adc.h \
856-
../include/hw/bluetooth.h \
856+
../include/hw/bluetooth.h \
857857
../include/hw/gpio.h \
858858
../include/hw/i2c.h \
859859
../include/hw/pwm.h \
@@ -870,6 +870,7 @@ INPUT = ../include/arpa/inet.h \
870870
../include/proto/ftpc.h \
871871
../include/proto/httpc.h \
872872
../include/proto/modbus.h \
873+
../include/proto/ntpc.h \
873874
../include/remotedbg.h \
874875
../include/ril/ril.h \
875876
../include/ril/ril_alarm.h \
@@ -888,7 +889,7 @@ INPUT = ../include/arpa/inet.h \
888889
../include/ril/ril_telephony.h \
889890
../include/ril/ril_util.h \
890891
../include/siwi/sockets.h \
891-
../include/spifs.h \
892+
../include/spifs.h \
892893
../include/sys/dirent.h \
893894
../include/sys/ioctl.h \
894895
../include/sys/socket.h \

docs/book/api/proto/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ Protocols
66

77
HTTP Client <httpc>
88
FTP Client <ftpc>
9+
NTP Client <ntpc>
910
Modbus Slave <modbus>

docs/book/api/proto/ntpc.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
NTP Client
2+
==========
3+
4+
Library provide NTP client service which can be enabled during
5+
system initialization. Once enabled service will automatically
6+
take care of setting system time when device is ready and GPRS
7+
service is active. The NTP sync interval is 60 minutes.
8+
9+
API Reference
10+
-------------
11+
12+
.. include:: /inc/ntpc.inc

include/proto/ntpc.h

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/*
2+
* ntpc.h
3+
*
4+
*/
5+
#ifndef INC_PROTO_NTPC_H
6+
#define INC_PROTO_NTPC_H
7+
8+
/**
9+
* Initialize NTP client service
10+
* @return 0 on success, negative value on failure
11+
*/
12+
int ntpclient_init(void);
13+
14+
#endif /* INC_PROTO_NTPC_H */

0 commit comments

Comments
 (0)