[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gpsd-dev] [PATCH 6/6] add documentation

From: Beat Bolli
Subject: [gpsd-dev] [PATCH 6/6] add documentation
Date: Mon, 21 Oct 2013 20:35:01 +0200

 contrib/ | 39 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)

diff --git a/contrib/ b/contrib/
index 76e3553..a95fc84 100755
--- a/contrib/
+++ b/contrib/
@@ -1,11 +1,40 @@
 #!/usr/bin/env python
 # encoding: utf-8
-# This is a Python port of webgps.c from
-# by Beat Bolli <address@hidden>
+This is a Python port of webgps.c from
+by Beat Bolli <address@hidden>
+It creates a skyview of the currently visible GPS satellites and their tracks
+over a time period.
+    ./ [duration]
+    duration may be
+    - a number of seconds
+    - a number followed by a time unit ('s' for secinds, 'm' for minutes,
+      'h' for hours or 'd' for days, e.g. '4h' for a duration of four hours)
+    - the letter 'c' for continuous operation
+If duration is missing, the current skyview is generated and exits
+immediately. This is the same as giving a duration of 0.
+If a duration is given, runs for this duration and generates the
+tracks of the GPS satellites in view. If the duration is the letter 'c',
+the script never exits and continuously updates the skyview.
+ generates two files: a HTML5 file that can be browsed, and a
+JavaScript file that contains the drawing commands for the skyview. The HTML5
+file auto-refreshes every five minutes. The generated file names are
+"gpsd-<duration>.html" and "gpsd-<duration>.js".
+If is interrupted with Ctrl-C before the duration is over, it saves
+the current tracks into the file "tracks.p". This is a Python "pickle" file.
+If this file is present on start of, it is loaded. This allows to
+restart without losing accumulated satellite tracks.
 import time, calendar, math, socket, sys, os, select, pickle

reply via email to

[Prev in Thread] Current Thread [Next in Thread]