Break out common pieces from TeleGPS and AltusMetrum
[fw/altos] / doc / config-device.inc
1 ifdef::altusmetrum[]
2
3         ==== Main Deploy Altitude
4
5                 This sets the altitude (above the recorded pad
6                 altitude) at which the 'main' igniter will fire. The
7                 drop-down menu shows some common values, but you can
8                 edit the text directly and choose whatever you
9                 like. If the apogee charge fires below this altitude,
10                 then the main charge will fire two seconds after the
11                 apogee charge fires.
12
13         ==== Apogee Delay
14
15                 When flying redundant electronics, it's often
16                 important to ensure that multiple apogee charges don't
17                 fire at precisely the same time, as that can over
18                 pressurize the apogee deployment bay and cause a
19                 structural failure of the air-frame. The Apogee Delay
20                 parameter tells the flight computer to fire the apogee
21                 charge a certain number of seconds after apogee has
22                 been detected.
23
24         ==== Apogee Lockout
25
26                 Apogee lockout is the number of seconds after boost
27                 where the flight computer will not fire the apogee
28                 charge, even if the rocket appears to be at
29                 apogee. This is often called 'Mach Delay', as it is
30                 intended to prevent a flight computer from
31                 unintentionally firing apogee charges due to the
32                 pressure spike that occurrs across a mach
33                 transition. Altus Metrum flight computers include a
34                 Kalman filter which is not fooled by this sharp
35                 pressure increase, and so this setting should be left
36                 at the default value of zero to disable it.
37
38 endif::altusmetrum[]
39
40 ==== Frequency
41
42         This configures which of the frequencies to use for
43         both telemetry and packet command mode. Note that if
44         you set this value via packet command mode, the
45         TeleDongle frequency will also be automatically
46         reconfigured to match so that communication will
47         continue afterwards.
48
49 ==== RF Calibration
50
51         The radios in every Altus Metrum device are calibrated
52         at the factory to ensure that they transmit and
53         receive on the specified frequency.  If you need to
54         you can adjust the calibration by changing this value.
55         Do not do this without understanding what the value
56         means, read the appendix on calibration and/or the
57         source code for more information.  To change a
58         TeleDongle's calibration, you must reprogram the unit
59         completely.
60
61 ==== Telemetry/RDF/APRS Enable
62
63         Enables the radio for transmission during
64         flight. When disabled, the radio will not
65         transmit anything during flight at all.
66
67 ==== Telemetry baud rate
68
69         This sets the modulation bit rate for data
70         transmission for both telemetry and packet
71         link mode. Lower bit rates will increase range
72         while reducing the amount of data that can be
73         sent and increasing battery consumption. All
74         telemetry is done using a rate 1/2 constraint
75         4 convolution code, so the actual data
76         transmission rate is 1/2 of the modulation bit
77         rate specified here.
78
79 ==== APRS Interval
80
81         How often to transmit GPS information via APRS
82         (in seconds). When set to zero, APRS
83         transmission is disabled.
84         ifdef::altusmetrum[]
85         This option is
86         available on TeleMetrum v2 and TeleMega
87         boards. TeleMetrum v1 boards cannot transmit
88         APRS packets.
89         endif::altusmetrum[]
90         Note that a single APRS packet
91         takes nearly a full second to transmit, so
92         enabling this option will prevent sending any
93         other telemetry during that time.
94
95 ==== APRS SSID
96
97         Which SSID to report in APRS packets. By
98         default, this is set to the last digit of the
99         serial number, but can be configured to any
100         value from 0 to 9.
101
102 ==== APRS Format
103
104         Whether to send APRS data in Compressed or
105         Uncompressed format. Compressed format is
106         smaller and more precise. Uncompressed
107         format is older, but may work better with your
108         device. The Kenwood TH-D72 only displays
109         altitude information with Uncompressed
110         format, while the Yaesu FT1D only displays
111         altitude with Compressed format. Test before
112         you fly to see which to use.
113
114 ==== Callsign
115
116         This sets the call sign included in each
117         telemetry packet. Set this as needed to
118         conform to your local radio regulations.
119
120 ifdef::altusmetrum[]
121
122         ==== Maximum Flight Log Size
123
124                 This sets the space (in kilobytes) allocated
125                 for each flight log. The available space will
126                 be divided into chunks of this size. A smaller
127                 value will allow more flights to be stored, a
128                 larger value will record data from longer
129                 flights.
130
131         ==== Ignitor Firing Mode
132
133                 This configuration parameter allows the two standard ignitor
134                 channels (Apogee and Main) to be used in different
135                 configurations.
136
137                 Dual Deploy::
138                 This is the usual mode of operation; the
139                 'apogee' channel is fired at apogee and the
140                 'main' channel at the height above ground
141                 specified by the 'Main Deploy Altitude' during
142                 descent.
143
144                 Redundant Apogee::
145                 This fires both channels at apogee, the
146                 'apogee' channel first followed after a two
147                 second delay by the 'main' channel.
148
149                 Redundant Main::
150                 This fires both channels at the height above
151                 ground specified by the Main Deploy Altitude
152                 setting during descent. The 'apogee' channel
153                 is fired first, followed after a two second
154                 delay by the 'main' channel.
155
156         ==== Pad Orientation
157
158                 Because they include accelerometers,
159                 TeleMetrum, TeleMega and EasyMega are
160                 sensitive to the orientation of the board. By
161                 default, they expect the antenna end to point
162                 forward. This parameter allows that default to
163                 be changed, permitting the board to be mounted
164                 with the antenna pointing aft instead.
165
166                 Antenna Up::
167                 In this mode, the antenna end of the flight
168                 computer must point forward, in line with the
169                 expected flight path.
170
171                 Antenna Down::
172                 In this mode, the antenna end of the flight
173                 computer must point aft, in line with the
174                 expected flight path.
175
176         ==== Beeper Frequency
177
178                 The beeper on all Altus Metrum flight
179                 computers works best at 4000Hz, however if you
180                 have more than one flight computer in a single
181                 airframe, having all of them sound at the same
182                 frequency can be confusing. This parameter
183                 lets you adjust the base beeper frequency
184                 value.
185
186 endif::altusmetrum[]
187
188 ==== Logging Trigger Motion
189
190         This sets the amount of motion that TeleGPS
191         needs to see before logging the new
192         position. Motions smaller than this are
193         skipped, which saves storage space.
194
195 ==== Position Reporting Interval
196
197         The interval between TeleGPS position reports,
198         both over the air and in the log. Increase
199         this to reduce the frequency of radio
200         transmissions and the length of time available
201         in the log.
202
203
204 ifdef::altusmetrum[]
205
206         ==== Configure Pyro Channels
207
208                 .Additional Pyro Channel Configuration
209                 image::configure-pyro.png[width="5.5in"]
210
211                 This opens a separate window to configure the
212                 additional pyro channels available on TeleMega
213                 and EasyMega.  One column is presented for
214                 each channel. Each row represents a single
215                 parameter, if enabled the parameter must meet
216                 the specified test for the pyro channel to be
217                 fired.
218
219                 Select conditions and set the related value;
220                 the pyro channel will be activated when *all*
221                 of the conditions are met. Each pyro channel
222                 has a separate set of configuration values, so
223                 you can use different values for the same
224                 condition with different channels.
225
226                 At the bottom of the window, the 'Pyro Firing
227                 Time' configuration sets the length of time
228                 (in seconds) which each of these pyro channels
229                 will fire for.
230
231                 Once you have selected the appropriate
232                 configuration for all of the necessary pyro
233                 channels, you can save the pyro configuration
234                 along with the rest of the flight computer
235                 configuration by pressing the 'Save' button in
236                 the main Configure Flight Computer window.
237
238                 include::pyro-channels.raw[]
239
240 endif::altusmetrum[]