Skip to content

Commit 3c7441c

Browse files
committed
docs: Update documentation for GPS module
Change-Id: Iba80ca3197ec0b8529b8b34a7e9626de25fa184d Signed-off-by: Ajay Bhargav <[email protected]>
1 parent f89fd62 commit 3c7441c

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

docs/Doxyfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -851,6 +851,7 @@ INPUT = ../include/arpa/inet.h \
851851
../include/driver/dht.h \
852852
../include/driver/ds18b20.h \
853853
../include/driver/onewire.h \
854+
../include/gpslib.h \
854855
../include/hw/adc.h \
855856
../include/hw/bluetooth.h \
856857
../include/hw/gpio.h \

docs/book/api/peri/gps.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1-
GPS
2-
===
1+
GPS Libaray
2+
===========
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
MT2503 SoC has on-chip GNSS module supports GPS + GLONASS, Galileo, Beidou
8+
constellations. SIWISDK gps library does all the heavy lifting and make
9+
it easy to use the full capabilities of GNSS module. Some features of gps
10+
library are:
11+
12+
* Most accurate software odometer
13+
* Motion detection based on GPS data
14+
* No postion drift after vehicle stops
15+
* Critical events based on user configuration:
16+
17+
1. Harsh Acceleration
18+
2. Harsh Breaking
19+
3. Harsh turning/cornering
20+
4. Over speed
21+
22+
* Vehicle turn notification
23+
* GPS status notification
324

425
API Reference
526
-------------
627

7-
.. .. include:: /inc/gpslib.inc
8-
28+
.. include:: /inc/gpslib.inc

0 commit comments

Comments
 (0)