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