Generate LED icons on the fly. Include SVG versions.
[fw/altos] / doc / aprs-operation.inc
1         === APRS
2
3                 {aprsdevices} can send APRS if desired, and the
4                 interval between APRS packets can be configured. As each APRS
5                 packet takes a full second to transmit, we recommend an
6                 interval of at least 5 seconds to avoid consuming too much
7                 battery power or radio channel bandwidth. You can configure
8                 the APRS interval using {application}; that process is described in
9                 <<{configure_section}>>.
10
11                 AltOS supports both compressed and uncompressed APRS
12                 position report data formats. The compressed format
13                 provides for higher position precision and shorter
14                 packets than the uncompressed APRS format. We've found
15                 some older APRS receivers that do not handle the
16                 compressed format. The Kenwood TH-72A requires the use
17                 of uncompressed format to display altitude information
18                 correctly. The Yaesu FT1D requires the use of
19                 compressed format to display altitude information.
20
21                 APRS packets include an SSID (Secondary Station Identifier)
22                 field that allows one operator to have multiple
23                 transmitters. AltOS allows you to set this to a single digit
24                 from 0 to 9, allowing you to fly multiple transmitters at the
25                 same time while keeping the identify of each one separate in
26                 the receiver. By default, the SSID is set to the last digit of
27                 the device serial number.
28
29                 The APRS packet format includes a comment field that
30                 can have arbitrary text in it. AltOS uses this to send
31                 status information as shown in the following table.
32
33                 .Altus Metrum APRS Comments
34                 [options="header",cols="1,1,3"]
35                 |====
36                 |Field        |Example        |Description
37
38                 |1
39                 |L
40                 |GPS Status U for unlocked, L for locked
41
42                 |2
43                 |6
44                 |Number of Satellites in View
45
46                 |3
47                 |B4.0
48                 |Altimeter Battery Voltage
49
50         ifdef::altusmetrum[]
51
52                 |4
53                 |A3.7
54                 |Apogee Igniter Voltage
55
56                 |5
57                 |M3.7
58                 |Main Igniter Voltage
59
60                 |6
61                 |1286
62                 |Device Serial Number
63
64         endif::altusmetrum[]
65         ifdef::telegps[]
66
67                 |4
68                 |1286
69                 |Device Serial Number
70
71         endif::telegps[]
72
73                 |====
74
75                 ifdef::altusmetrum[]
76                 Here's an example of an APRS comment showing GPS lock with 6
77                 satellites in view, a primary battery at 4.0V, and
78                 apogee and main igniters both at 3.7V from device 1286.
79
80                 ....
81                 L6 B4.0 A3.7 M3.7 1286
82                 ....
83                 endif::altusmetrum[]
84
85                 ifdef::telegps[]
86                 Here's an example of an APRS comment showing GPS lock with 6
87                 satellites in view and a primary battery at 4.0V from device 1876.
88
89                 ....
90                 L6 B4.0 1876
91                 ....
92                 endif::telegps[]
93
94                 Make sure your primary battery is above 3.8V
95         ifdef::altusmetrum[]
96                 any connected igniters are above 3.5V
97         endif::altusmetrum[]
98                 and GPS is locked with at least 5 or 6 satellites in
99                 view before flying. If GPS is switching between L and
100                 U regularly, then it doesn't have a good lock and you
101                 should wait until it becomes stable.
102
103                 If the GPS receiver loses lock, the APRS data
104                 transmitted will contain the last position for which
105                 GPS lock was available. You can tell that this has
106                 happened by noticing that the GPS status character
107                 switches from 'L' to 'U'. Before GPS has locked, APRS
108                 will transmit zero for latitude, longitude and
109                 altitude.