acassis commented on code in PR #16406:
URL: https://github.com/apache/nuttx/pull/16406#discussion_r2094108291


##########
Documentation/applications/examples/gps/index.rst:
##########
@@ -2,4 +2,26 @@
 ``gps`` GPS example
 ===================
 
-GPS example.
+This example can be used to interact with GPS devices in NuttX. It uses the 
`MINMEA <https://github.com/kosma/minmea>`_
+library to parse standard NMEA messages and print out GPS data to the console.
+
+To use the program, provide the character device path for the GPS serial 
connection as the only argument. If no path is
+provided, the program will default to ``/dev/ttyS1``.
+
+.. code:: console
+
+   nsh> gps /dev/ttyS3
+   Fixed-point Latitude...........: 0
+   Fixed-point Longitude..........: 0
+   Fixed-point Speed..............: 0
+   Floating point degree latitude.: nan
+   Floating point degree longitude: nan
+   Floating point speed...........: nan
+   Fix quality....................: 0
+   Altitude.......................: 0
+   Tracked satellites.............: 0
+
+The output will show ``nan`` and ``0`` for values while waiting to obtain a 
fix, at which point real values will begin
+to appear.

Review Comment:
   Maybe you can show the results after getting position, it will be more 
complete as shows both cases



##########
Documentation/applications/examples/gps/index.rst:
##########
@@ -2,4 +2,26 @@
 ``gps`` GPS example
 ===================
 
-GPS example.
+This example can be used to interact with GPS devices in NuttX. It uses the 
`MINMEA <https://github.com/kosma/minmea>`_
+library to parse standard NMEA messages and print out GPS data to the console.
+
+To use the program, provide the character device path for the GPS serial 
connection as the only argument. If no path is
+provided, the program will default to ``/dev/ttyS1``.
+
+.. code:: console
+
+   nsh> gps /dev/ttyS3
+   Fixed-point Latitude...........: 0
+   Fixed-point Longitude..........: 0

Review Comment:
   I suggest showing some real position, just change the number of your 
position for privacy.



##########
Documentation/applications/examples/gps/index.rst:
##########
@@ -2,4 +2,26 @@
 ``gps`` GPS example
 ===================
 
-GPS example.
+This example can be used to interact with GPS devices in NuttX. It uses the 
`MINMEA <https://github.com/kosma/minmea>`_
+library to parse standard NMEA messages and print out GPS data to the console.
+
+To use the program, provide the character device path for the GPS serial 
connection as the only argument. If no path is
+provided, the program will default to ``/dev/ttyS1``.
+
+.. code:: console
+
+   nsh> gps /dev/ttyS3
+   Fixed-point Latitude...........: 0
+   Fixed-point Longitude..........: 0
+   Fixed-point Speed..............: 0
+   Floating point degree latitude.: nan
+   Floating point degree longitude: nan
+   Floating point speed...........: nan

Review Comment:
   why is it returning Not A Number? Maybe float support is not enable, is it 
the case here?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to