altos/test: Adjust CRC error rate after FEC fix
[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 launch
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                 [WARNING]
39                 Firmware versions older than 1.8.6 have a
40                 bug which resets the time since launch to zero each
41                 time a motor starts burning. Update firmware to get
42                 the correct behavior.
43
44 endif::altusmetrum[]
45
46 ifdef::radio[]
47         ==== Frequency
48
49                 This configures which of the frequencies to use for
50                 both telemetry and packet command mode. Note that if
51                 you set this value via packet command mode, the
52                 TeleDongle frequency will also be automatically
53                 reconfigured to match so that communication will
54                 continue afterwards.
55
56         ==== RF Calibration
57
58                 The radios in every Altus Metrum device are calibrated
59                 at the factory to ensure that they transmit and
60                 receive on the specified frequency.  If you need to
61                 you can adjust the calibration by changing this value.
62                 Do not do this without understanding what the value
63                 means, read the appendix on calibration and/or the
64                 source code for more information.  To change a
65                 TeleDongle's calibration, you must reprogram the unit
66                 completely.
67
68         ==== Telemetry/RDF/APRS Enable
69
70                 Enables the radio for transmission during
71                 flight. When disabled, the radio will not
72                 transmit anything during flight at all.
73
74         ==== Telemetry baud rate
75
76                 This sets the modulation bit rate for data
77                 transmission for both telemetry and packet
78                 link mode. Lower bit rates will increase range
79                 while reducing the amount of data that can be
80                 sent and increasing battery consumption. All
81                 telemetry is done using a rate 1/2 constraint
82                 4 convolution code, so the actual data
83                 transmission rate is 1/2 of the modulation bit
84                 rate specified here.
85
86         ==== APRS Interval
87
88                 How often to transmit GPS information via APRS
89                 (in seconds). When set to zero, APRS
90                 transmission is disabled.
91                 ifdef::altusmetrum[]
92                 This option is
93                 available on TeleMetrum v2 or newer and TeleMega
94                 boards. TeleMetrum v1 boards cannot transmit
95                 APRS packets.
96                 endif::altusmetrum[]
97                 Note that a single APRS packet
98                 takes nearly a full second to transmit, so
99                 enabling this option will prevent sending any
100                 other telemetry during that time.
101
102         ==== APRS SSID
103
104                 Which SSID to report in APRS packets. By
105                 default, this is set to the last digit of the
106                 serial number, but can be configured to any
107                 value from 0 to 9.
108
109         ==== APRS Format
110
111                 Whether to send APRS data in Compressed or
112                 Uncompressed format. Compressed format is
113                 smaller and more precise. Uncompressed
114                 format is older, but may work better with your
115                 device. The Kenwood TH-D72 only displays
116                 altitude information with Uncompressed
117                 format, while the Yaesu FT1D only displays
118                 altitude with Compressed format. Test before
119                 you fly to see which to use.
120
121         ==== APRS Offset
122         
123                 The delay from the top of the minute before sending
124                 the first APRS packet of the minute. Coordinating
125                 values for this parameter between multiple devices can
126                 allow a single receiver to reliably receive APRS
127                 packets from multiple devices. Note that this offset only
128                 takes effect while the GPS signal is locked so that the
129                 transmitting device knows the current time.
130                 
131         ==== Callsign
132
133                 This sets the call sign included in each
134                 telemetry packet. Set this as needed to
135                 conform to your local radio regulations.
136 endif::radio[]
137
138 ifdef::altusmetrum[]
139
140         ==== Maximum Flight Log Size
141
142                 This sets the space (in kilobytes) allocated
143                 for each flight log. The available space will
144                 be divided into chunks of this size. A smaller
145                 value will allow more flights to be stored, a
146                 larger value will record data from longer
147                 flights.
148
149         ==== Ignitor Firing Mode
150
151                 This configuration parameter allows the two standard ignitor
152                 channels (Apogee and Main) to be used in different
153                 configurations.
154
155                 Dual Deploy::
156                 This is the usual mode of operation; the
157                 'apogee' channel is fired at apogee and the
158                 'main' channel at the height above ground
159                 specified by the 'Main Deploy Altitude' during
160                 descent.
161
162                 Redundant Apogee::
163                 This fires both channels at apogee, the
164                 'apogee' channel first followed after a two
165                 second delay by the 'main' channel.
166
167                 Redundant Main::
168                 This fires both channels at the height above
169                 ground specified by the Main Deploy Altitude
170                 setting during descent. The 'apogee' channel
171                 is fired first, followed after a two second
172                 delay by the 'main' channel.
173
174         ifdef::telemetrum,telemega,easymega[]
175         ==== Pad Orientation
176
177                 Because they include accelerometers,
178                 TeleMetrum, TeleMega and EasyMega are
179                 sensitive to the orientation of the board. By
180                 default, they expect the antenna end to point
181                 forward. This parameter allows that default to
182                 be changed, permitting the board to be mounted
183                 with the antenna pointing aft instead.
184
185                 Antenna Up::
186                 In this mode, the antenna end of the flight
187                 computer must point forward, in line with the
188                 expected flight path.
189
190                 Antenna Down::
191                 In this mode, the antenna end of the flight
192                 computer must point aft, in line with the
193                 expected flight path.
194         endif::telemetrum,telemega,easymega[]
195
196         ==== Beeper Frequency
197
198                 The beeper on all Altus Metrum flight
199                 computers works best at 4000Hz, however if you
200                 have more than one flight computer in a single
201                 airframe, having all of them sound at the same
202                 frequency can be confusing. This parameter
203                 lets you adjust the base beeper frequency
204                 value.
205
206 endif::altusmetrum[]
207
208 ifdef::telegps[]
209         ==== Logging Trigger Motion
210
211                 This sets the amount of motion that TeleGPS
212                 needs to see before logging the new
213                 position. Motions smaller than this are
214                 skipped, which saves storage space.
215
216         ==== Position Reporting Interval
217
218                 The interval between TeleGPS position reports,
219                 both over the air and in the log. Increase
220                 this to reduce the frequency of radio
221                 transmissions and the length of time available
222                 in the log.
223 endif::telegps[]
224
225 ifdef::telemega,easymega,telemetrum[]
226
227         ==== Calibrate Accelerometer
228
229                 This opens a separate window to recalibrate the
230                 accelerometers. Follow the instructions, orienting the
231                 flight computer with the antenna end, or end opposite
232                 the screw terminals, in the case of EasyMega, first up
233                 and then down.
234
235                 When the calibration is complete, return to the
236                 Configure Altimeter window and save the new
237                 calibration values.
238
239 endif::telemega,easymega,telemetrum[]
240
241 ifdef::telemega,easymega[]
242
243         ==== Configure Pyro Channels
244
245                 .Additional Pyro Channel Configuration
246                 image::configure-pyro.png[width=400]
247
248                 This opens a separate window to configure the
249                 additional pyro channels available on TeleMega
250                 and EasyMega.  One column is presented for
251                 each channel. Each row represents a single
252                 parameter, if enabled the parameter must meet
253                 the specified test for the pyro channel to be
254                 fired.
255
256                 Select conditions and set the related value;
257                 the pyro channel will be activated when *all*
258                 of the conditions are met. Each pyro channel
259                 has a separate set of configuration values, so
260                 you can use different values for the same
261                 condition with different channels.
262
263                 At the bottom of the window, the 'Pyro Firing
264                 Time' configuration sets the length of time
265                 (in seconds) which each of these pyro channels
266                 will fire for.
267
268                 Once you have selected the appropriate
269                 configuration for all of the necessary pyro
270                 channels, you can save the pyro configuration
271                 along with the rest of the flight computer
272                 configuration by pressing the 'Save' button in
273                 the main Configure Flight Computer window.
274
275                 include::pyro-channels.adoc[]
276
277 endif::telemega,easymega[]