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