Skip to content

Commit 73bcc99

Browse files
committed
Documenting parsed NMEA sentences and timeout behavior
1 parent 3e4883c commit 73bcc99

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# dbus_gps
22

3-
Daemon on Venus OS that reads info from a usb/serial gps in NMEA0183 format and
4-
publishes it on dbus. More information on Venus OS [here](
5-
https://github.com/victronenergy/venus/wiki).
3+
Venus OS daemon that reads [NMEA0183](https://en.wikipedia.org/wiki/NMEA_0183) GGA, GNS and RMC sentences from a usb/serial gps and publishes it on dbus.
4+
More information on Venus OS [here](https://github.com/victronenergy/venus/wiki).
65

76
Building depends on:
87
- python
@@ -90,9 +89,11 @@ right commandline arguments, ie. as a minimum the right serial port:
9089
./gps-dbus/gps_dbus
9190
9291
-t, --timeout
93-
The time in seconds the program waits untill a device is connected. 0 is disabled.
94-
If no device is found the program will stop if the timeout is expired.
95-
92+
The maximum time in seconds to wait for a device first connection before exiting (error 129).
93+
0 deactivates the timeout. Default is 0.
94+
Only used for initial connection. Once connected, the device is declared disconnected
95+
after 5 seconds without incoming data (error 130).
96+
9697
-b, --baud
9798
The baud rate of the serial port.
9899
When omitted the baud rate is set to 4800.
@@ -126,7 +127,7 @@ COMMON OPTIONS:
126127
The serial port to use (default /dev/ttyS0).
127128
128129
-v --verbose
129-
Enable log messages. Specifying multiple times increases verbosity.
130+
Enable log messages. Specifying multiple times increases verbosity: for INFO level, use -vv.
130131
131132
-V --version
132133
Print the version number.

software/src/platform/pc/console.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ void consoleUsage(char* program)
3030
printf("%s\n", program);
3131
printf("\n");
3232
printf(" -t, --timeout\n");
33-
printf(" The time in seconds the program waits untill a device is connected. 0 is disabled.\n");
34-
printf(" If no device is found the program will stop if the timeout is expired.\n");
33+
printf(" The maximum time in seconds to wait for a device first connection before exiting (error 129).\n");
34+
printf(" 0 deactivates the timeout. Default is 0.\n");
35+
printf(" Only used for initial connection. Once connected, the device is declared disconnected after 5 seconds without incoming data (error 130).\n");
3536
printf("\n");
3637
printf(" -b, --baud\n");
3738
printf(" The baud rate of the serial port.\n");

0 commit comments

Comments
 (0)