From: Keith Packard Date: Sat, 14 Jun 2014 05:36:00 +0000 (-0700) Subject: doc: TeleGPS docs are complete X-Git-Tag: 1.4~37 X-Git-Url: https://git.gag.com/?p=fw%2Faltos;a=commitdiff_plain;h=ae7084f5199318dc6582e212492a50cfda1cebb8 doc: TeleGPS docs are complete All TeleGPS features should now be documented to some degree Signed-off-by: Keith Packard --- diff --git a/doc/telegps-configure.png b/doc/telegps-configure.png index 234723f3..56cb2031 100644 Binary files a/doc/telegps-configure.png and b/doc/telegps-configure.png differ diff --git a/doc/telegps-preferences.png b/doc/telegps-preferences.png index ca638825..ad14fd8d 100644 Binary files a/doc/telegps-preferences.png and b/doc/telegps-preferences.png differ diff --git a/doc/telegps-scan.png b/doc/telegps-scan.png new file mode 100644 index 00000000..9b19e685 Binary files /dev/null and b/doc/telegps-scan.png differ diff --git a/doc/telegps.xsl b/doc/telegps.xsl index 4165065c..4b6d8cae 100644 --- a/doc/telegps.xsl +++ b/doc/telegps.xsl @@ -936,26 +936,323 @@ NAR #88757, TRA #12200
Scan Channels + Scans the configured set of frequencies looking for + telemetry signals. A list of all of the discovered signals + is show; selecting one of those and clicking on 'Monitor' + will select that frequency in the associated TeleGPS + application window. + + + + + + +
Download Data - + TeleGPS records data to its internal flash memory. + On-board data is recorded at the same rate as telemetry + but is not subject to radio drop-outs. As + such, it generally provides a more complete and precise record. + The 'Download Data' menu entry allows you to read the + flash memory and write it to disk. + + + Select the 'Download Data' menu entry to bring up a list of + connected TeleGPS devices. After the device has been + selected, a dialog showing the data stored in the + device will be shown allowing you to select which entries to + download and which to delete. You must erase flights in order for the space they + consume to be reused by another track. This prevents + accidentally losing data if you neglect to download + data before starting TeleGPS again. Note that if there is no more + space available in the device, then no data will be recorded. + + + The file name for each data log is computed automatically + from the recorded date, altimeter serial number and flight + number information.
Configure Device + + + + + + + + + Select this button and then select any connected TeleGPS + device from the list provided. + + + The first few lines of the dialog provide information about the + connected device, including the product name, + software version and hardware serial number. Below that are the + individual configuration entries. + + + At the bottom of the dialog, there are four buttons: + + + + Save + + + This writes any changes to the + configuration parameter block in flash memory. If you don't + press this button, any changes you make will be lost. + + + + + Reset + + + This resets the dialog to the most recently saved values, + erasing any changes you have made. + + + + + Reboot + + + This reboots the device. This will restart logging for + a new flight number, if any log information has been + saved for the current flight. + + + + + Close + + + This closes the dialog. Any unsaved changes will be + lost. + + + + - + The rest of the dialog contains the parameters to be configured. +
+ Frequency + + This configures which of the frequencies to use for both + telemetry and packet command mode. Note that if you set this + value via packet command mode, the TeleDongle frequency will + also be automatically reconfigured to match so that + communication will continue afterwards. + +
+
+ RF Calibration + + The radios in every Altus Metrum device are calibrated at the + factory to ensure that they transmit and receive on the + specified frequency. If you need to you can adjust the calibration + by changing this value. Do not do this without understanding what + the value means, read the appendix on calibration and/or the source + code for more information. To change a TeleDongle's calibration, + you must reprogram the unit completely. + +
+
+ Telemetry/RDF/APRS Enable + + Enables the radio for transmission during flight. When + disabled, the radio will not transmit anything during flight + at all. + +
+
+ APRS Interval + + How often to transmit GPS information via APRS (in + seconds). When set to zero, APRS transmission is + disabled. This option is available on TeleMetrum v2 and + TeleMega boards. TeleMetrum v1 boards cannot transmit APRS + packets. Note that a single APRS packet takes nearly a full + second to transmit, so enabling this option will prevent + sending any other telemetry during that time. + +
+
+ Callsign + + This sets the call sign included in each telemetry packet. Set this + as needed to conform to your local radio regulations. + +
+
+ Maximum Log Size + + This sets the space (in kilobytes) allocated for each data + log. The available space will be divided into chunks of this + size. A smaller value will allow more logs to be stored, + a larger value will record data for longer times. + +
+
+ Logging Trigger Motion + + If TeleGPS moves less than this distance over a long period + of time, it will not log that location, saving storage space. + +
+
+ Position Reporting Interval + + This sets how often TeleGPS reports position information via + telemetry and to the on-board log. Reducing this value will + save power and logging memory consumption. + +
Flash Device - + This reprograms TeleGPS devices with new firmware. Please + read the directions for flashing devices in the Updating + Device Firmware chapter below. + +
+ + + + Updating Device Firmware + + TeleGPS is programmed directly over its USB connectors. + + + You may wish to begin by ensuring you have current firmware images. + These are distributed as part of the TeleGPS software bundle that + also includes the TeleGPS ground station program. Newer ground + station versions typically work fine with older firmware versions, + so you don't need to update your devices just to try out new + software features. You can always download the most recent + version from . + +
+ + Updating TeleGPS Firmware + + + + + Attach a battery and power switch to the target + device. Power up the device. + + + + + Using a Micro USB cable, connect the target device to your + computer's USB socket. + + + + + Run TeleGPS, and select 'Flash Device' from the Device menu. + + + + + Select the target device in the Device Selection dialog. + + + + + Select the image you want to flash to the device, which + should have a name in the form + <product>-v<product-version>-<software-version>.ihx, such + as TeleGPS-v1.0-1.4.0.ihx. + + + + + Make sure the configuration parameters are reasonable + looking. If the serial number and/or RF configuration + values aren't right, you'll need to change them. + + + + + Hit the 'OK' button and the software should proceed to flash + the device with new firmware, showing a progress bar. + + + + + Verify that the device is working by using the 'Configure + Altimeter' item to check over the configuration. + + + +