altos: remove teleterra-v0.1, also an ancient cc1111 project
[fw/altos] / doc / telegps-using.inc
1 == Using TeleGPS Hardware
2
3         === Hooking Up Lithium Polymer Batteries
4
5                 TeleGPS has a two pin JST PH series connector to connect up
6                 a single-cell Lithium Polymer cell (3.7V nominal). You can
7                 purchase matching batteries from the Altus Metrum store, or
8                 other vendors, or you can make your own. Pin 1 of the
9                 connector is positive, pin 2 is negative. Spark Fun sells a
10                 cable with the connector attached, which they call a
11                 link:https://www.sparkfun.com/products/9914[JST Jumper 2 Wire Assembly]
12
13
14                 [WARNING]
15                 Many RC vendors also sell lithium polymer batteries with
16                 this same connector. All that we have found use the opposite
17                 polarity, and if you use them that way, you will damage or
18                 destroy TeleGPS.
19
20         === On-board Data Recording
21
22                 TeleGPS logs GPS data at a user-configurable
23                 rate. Data are logged to a 2MB on-board flash memory
24                 part, which can be partitioned into several
25                 equal-sized blocks, one for each flight. 64kB of this
26                 storage are reserved to hold configuration data,
27                 leaving 1984kB for flight data.
28
29                 The on-board flash is partitioned into separate flight
30                 logs, each of a fixed maximum size. Increase the
31                 maximum size of each log and you reduce the number of
32                 flights that can be stored. Decrease the size and you
33                 can store more flights.
34
35                 To compute the amount of space needed for a single
36                 log, you can divide the expected time (in seconds) by
37                 the sample period (by default, 1 second per sample)
38                 and then multiply the result by 32 bytes per
39                 sample. For instance, a sample period of 1 second and
40                 a flight lasting one hour will take 32 * 3600 = 115200
41                 bytes. TeleGPS does try to reduce log space used by
42                 not recording position information when it isn't
43                 moving, so actual space consumed may be less than
44                 this.
45
46                 The default size allows for four flights of 496kB
47                 each, which provides over four hours of logging at 1
48                 sample per second.
49
50                 TeleGPS will not overwrite existing flight data, so be
51                 sure to download flight data and erase it from the
52                 onboard flash before it fills up. TeleGPS will still
53                 report telemetry even if memory is full, so the only
54                 thing you will lose is the on-board data log.
55       
56         === Installation
57
58                 The battery connectors are a standard 2-pin JST
59                 connector and match batteries sold by Spark Fun. These
60                 batteries are single-cell Lithium Polymer batteries
61                 that nominally provide 3.7 volts.  Other vendors sell
62                 similar batteries for RC aircraft using mating
63                 connectors, however the polarity for those is
64                 generally reversed from the batteries used by Altus
65                 Metrum products. In particular, the Tenergy batteries
66                 supplied for use in Featherweight flight computers are
67                 not compatible with Altus Metrum flight computers or
68                 battery chargers.
69
70                 [WARNING]
71                 Check polarity and voltage before connecting any
72                 battery not purchased from Altus Metrum or Spark
73                 Fun.
74
75                 TeleGPS uses an integrate GPS patch antenna and won't
76                 receive GPS signals if installed inside a metal or
77                 carbon fiber compartment. Test GPS reception and
78                 telemetry transmission with the system installed and
79                 all other electronics powered up to verify signal
80                 reception and make sure there isn't any interference
81                 from other systems.