forked from opentx/opentx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathOpenTX-User-Manual-en.html
2727 lines (2415 loc) · 118 KB
/
OpenTX-User-Manual-en.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>OpenTX User Manual</title>
<!-- 2014-08-18 Mon 20:51 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center; }
.todo { font-family: monospace; color: red; }
.done { color: green; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.right { margin-left: auto; margin-right: 0px; text-align: right; }
.left { margin-left: 0px; margin-right: auto; text-align: left; }
.center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
pre.src-sh:before { content: 'sh'; }
pre.src-bash:before { content: 'sh'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-R:before { content: 'R'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-java:before { content: 'Java'; }
pre.src-sql:before { content: 'SQL'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.right { text-align: center; }
th.left { text-align: center; }
th.center { text-align: center; }
td.right { text-align: right; }
td.left { text-align: left; }
td.center { text-align: center; }
dt { font-weight: bold; }
.footpara:nth-child(2) { display: inline; }
.footpara { display: block; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2013 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">OpenTX User Manual</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1. Introduction</a></li>
<li><a href="#sec-2">2. Credits and licence</a></li>
<li><a href="#sec-3">3. Basics</a></li>
<li><a href="#sec-4">4. Overview</a></li>
<li><a href="#sec-5">5. Learning by doing</a>
<ul>
<li><a href="#sec-5-1">5.1. The model memory</a></li>
</ul>
</li>
<li><a href="#sec-6">6. OpenTX in detail</a>
<ul>
<li>
<ul>
<li><a href="#sec-6-0-1">6.0.1. Menu overview</a></li>
<li><a href="#sec-6-0-2">6.0.2. Main views</a></li>
<li><a href="#sec-6-0-3">6.0.3. Telemetry view</a></li>
<li><a href="#sec-6-0-4">6.0.4. Radio general settings</a></li>
<li><a href="#sec-6-0-5">6.0.5. SD browser</a></li>
<li><a href="#sec-6-0-6">6.0.6. Trainer</a></li>
<li><a href="#sec-6-0-7">6.0.7. Version</a></li>
<li><a href="#sec-6-0-8">6.0.8. Diagnostics</a></li>
<li><a href="#sec-6-0-9">6.0.9. Model menus</a></li>
</ul>
</li>
<li><a href="#sec-6-1">6.1. Tutorial: your first model in OpenTX</a></li>
</ul>
</li>
<li><a href="#sec-7">7. from Google Docs</a></li>
<li><a href="#sec-8">8. Introduction to OpenTX companion</a>
<ul>
<li><a href="#sec-8-1">8.1. Basic concepts</a></li>
<li><a href="#sec-8-2">8.2. Setting up OpenTX companion for the Taranis</a></li>
<li><a href="#sec-8-3">8.3. Simulating the radio</a></li>
<li><a href="#sec-8-4">8.4. Flashing your Taranis radio</a>
<ul>
<li><a href="#sec-8-4-1">8.4.1. Installing the driver (for Windows only)</a></li>
<li><a href="#sec-8-4-2">8.4.2. Installing the flashing utility (for Mac OS and Linux)</a></li>
<li><a href="#sec-8-4-3">8.4.3. Downloading and flashing the firmware</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#sec-9">9. Further reading aka "Where do I go now"</a></li>
</ul>
</div>
</div>
<div id="outline-container-sec-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Introduction</h2>
<div class="outline-text-2" id="text-1">
<p>
OpenTX is a free and open-source firmware for programmable
radio-control transmitters. It runs on a variety of transmitter
hardware types, which might differ in the number and layout of input
devices (switches, buttons, sliders, etc.). This manual is concerned
with OpenTX and its programming capabilities, please refer to the
hardware-specific manuals to find out how to operate your transmitter
and how to navigate the menus:
</p>
<ul class="org-ul">
<li>FrSky X9D Taranis – XXX links
</li>
<li>Turnigy 9X
</li>
<li>Turnigy 9XR
</li>
<li>Turnigy 9XR Pro
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-2" class="outline-2">
<h2 id="sec-2"><span class="section-number-2">2</span> Credits and licence</h2>
<div class="outline-text-2" id="text-2">
<p>
This manual includes contributions by:
</p>
<ul class="org-ul">
<li>André Bernet – XXXXX github link
</li>
<li>andras – XXXXX github link
</li>
</ul>
<p>
If you would like to help improve it or you have spotted an error,
please let us know through the github issue tracker – XXXX link.
</p>
<p>
This manual is covered by the TBD. Therefore, commercial use of this
manual is forbidden without explicit authorization of the authors and
translators. Do not hesitate for permission, however, since we are
interested in widespread use of OpenTX and its documentation, we
simply like to know of any use in commercial applications.
</p>
</div>
</div>
<div id="outline-container-sec-3" class="outline-2">
<h2 id="sec-3"><span class="section-number-2">3</span> Basics</h2>
<div class="outline-text-2" id="text-3">
<p>
In order to understand OpenTX, especially if you have used radios with
systems other than OpenTX before, it is important to understand some
of the history of model radio control. In the early days of radio
controlled models, all electronics was analogue, simply passing the
stick and switch positions from the transmitter directly to the servo
channels in the receiver, and there was therefore a 1:1 correspondence
between input axes and servos: each axis controlled exactly one servo.
Later, analogue "mixers" became available that allowed the transmitter
to "mix" (add) the value of one control axes into another, making it
possible to control more complex models, for instance Delta or V-tail
aircraft. Even in the age of computerized transmitters, many
manufacturers still base their programming philosophy on this
paradigm, simulating these plug-in mixer modules in the transmitter
firmware but still maintaining the equivalence between input channels
and servo channels. Although the functionality offered is, in most
cases, adequate, the fact that you still have to name one side of a
V-tail "elevator" and the other "rudder" is very confusing. The
programming of a simple V-tail aircraft in this old philosophy
(familiar to many modellers) can be visualized like this:
</p>
<p>
Some computerized transmitters, notably most made by the German
company Multiplex, use a new approach much more intuitive and less
confusing. This approach is also the basis of OpenTX. In this
philosophy, each output channel of a new model defaults to "nothing",
i.e. centre signal. After deciding which channel corresponds to which
servo function, one can start defining which channels will react to
which inputs (note the plural) and how:
</p>
<p>
The result of both philosophies is the same, and both can be equally
versatile, but the approach adopted by OpenTX is cleaner and more
intuitive once the 1:1 correspondence between inputs and servos is
abolished. Take, for instance, a glider in which the stick axis
without springs (usually called "throttle") controls a combination of
flaps, spoilers, butterfly, etc., but none of the servos directly: it
would be very confusing to still have one servo called "throttle" even
though it isn't controlled primarily by the throttle stick, and the
entire model doesn't actually have a throttle.
</p>
</div>
</div>
<div id="outline-container-sec-4" class="outline-2">
<h2 id="sec-4"><span class="section-number-2">4</span> Overview</h2>
<div class="outline-text-2" id="text-4">
<p>
The following is a list of the most important concepts of OpenTX.
Read through this chapter first, especially if you have used radios
not running OpenTX in the past, as it should give you a good idea of
what to expect from OpenTX.
</p>
<ul class="org-ul">
<li><b>Models</b> are complete model definitions stored in the radio, from
which one can be selected. Apart from certain "global" settings
such as stick mode, date and time, loudspeaker volume, radio signal
quality warning thresholds, etc., everything is model-specific,
including the mixer definitions and curves. Therefore it is
guaranteed that all the settings relevant to controlling the model
are stored independently for each model.
<p>
Models can be copied, which simplifies creating models similar to
existing ones. The number of model memories varies with hardware,
the current maximum being 60, but it is possible to store and recall
(XXXXX TBD) models to/from a flash memory device (usually a microSD
card) for virtually endless model memory space. Each model has a
name and can be assigned an image for easy recognition.
</p>
</li>
<li><b>Channels</b> denote outputs on the receivers, and are numbered. The
maximum number varies with the hardware, currently up to 32 on the
Taranis with both internal and external transmitter RF modules
operating with 16 channels each. Typically, with only one receiver,
the channel number in OpenTX corresponds to the number printed next
to the terminal on the receiver. No channel is special, each one
can be used for any function.
<p>
For clarity, channels can also be named, although this is optional.
Naming only causes the name to be displayed on several screens
(servo calibration, mixers, channel monitor, etc.) but does not
influence control of the model. The name can be added, changed, or
removed at any time with no further consequences.
</p>
<p>
The channel calibration feature allows the maximum throws and centre
position to be adjusted for each channel, in addition to optional
curves that can be used for fine-tuning the servo response.
</p>
</li>
<li><b>Inputs</b> are controls, primarily the two sticks, their trims,
potentiometers, and switches.
<ul class="org-ul">
<li>The stick axes are called "throttle", "rudder", "aileron", and
"elevator", and their assignment is defined globally by the "mode"
number. Therefore, if you change the mode of the transmitter
(swapping rudder and aileron, for instance) in order to let
someone else control your model, the inputs will be taken
correctly from the right axes in all models.
<p>
There is no way (and no need) to address the sticks at their
physical position, for example "left stick forward/aft" is not
available as an input.
</p>
</li>
<li>There are also "logical" inputs defined in the "input" section of
a model set-up. These can be used for some pre-processing (for
instance, to add a throttle-cut feature) of the inputs, or simply
to define named inputs that can then be moved later as required.
For example, a "flaps" input could first be assigned to one of the
dials, then moved to another dial by only changing the input
definition if the need arises.
<p>
Logical inputs can also be named, the name again having no impact
on control of the model because it is only used for display
purposes.
</p>
</li>
<li>The switches, and also the logical switch (see below) can be used
as analogue inputs, in which case they can have the discrete
values -100%, 0, and +100% (0 being only possible with three-way
physical switches).
</li>
</ul>
</li>
<li><b>Logical switches</b> are two-state (on/off) virtual switches that
allow a logical combination of a great variety of functions. Most
importantly, they can be used for generating an internal on/off
signal depending on the value of any analogue signal (input,
telemetry value, etc.).
<p>
Once defined, logical switches can be used wherever a two-way
physical switch can.
</p>
</li>
<li><b>Mixers</b> are where most of the logic takes place, defining the
combination of inputs, logical functions, flight modes, etc. for
each channel. Note that the output of these mixers runs between
-100% and +100%, any throw adjustment, centre calibration, and servo
balancing is performed separately using servo calibration. This not
only separates servo calibration from the actual logic but also
guarantees that the limits set (in servo calibration) can never be
exceeded, preventing mechanical damage to the servo, linkage, or
model.
<p>
Other than some other radios, mixers are defined on a per-channel
basis. There is no way of using the same mixer in two channels. If
two channels need similar mixers (such as in a V-tail aircraft),
those mixers must be defined independently. Mixer lines can be
copied, making duplicating a mixer very easy. Global variables (see
below) can of great help to keep the mixer constants consistent
across multiple channels.
</p>
<p>
If multiple channels use exactly the same mix, then it is possible
to define the mixer only for one of the channels and create a simple
"pass-through" mixer for the other channels using the first mixer's
output as its input. If you take care that there is no "circular"
or "recursive" reference causing a channel to depend on itself at
one point, then this also doesn't cause any latency (delay in
processing between channels).
</p>
</li>
<li><b>Global variables</b> are global only within a model, not across the
entire radio. Each has a value between -100% and +100%, just like
any normal input, and can be used in many places where a constant
would have to be entered (for instance, in the weight of a mixer
line). There are also many ways of adjusting them (for example,
binding them to a potentiometer input), so they can be used to make
the mixer system even more flexible. One important use is the
tweaking of certain parameters during the initial flights of a
model, then removing the bits that allow changing it during flight
once the correct parameters have been found.
</li>
<li><b>Curves</b> can be used for controlling an input, mixer, or servo
response very accurately. There is a number of curves that can be
defined for each model (32 on the Taranis) and then used in many
places (input response, mixer lines, and servo calibration being the
most important).
<p>
Curves can also be named, the name having no significance in
controlling the model.
</p>
</li>
<li><b>Flight modes</b> allow for an easy combination of a variety of
settings that fit each phase of controlling the model (not only
aircraft, of course). Trim values and global variables can be made
flight-mode specific, and each can even be made dependent on the
same parameter in another flight mode, effectively letting the user
pick which parameters are independent in which flight mode.
<p>
Flight mode 0 is active by default, and the others are activated by
switches or logical switches with the ones with lower flight-mode
number taking precendence if the switch of more than one flight mode
is active at the same time.
</p>
<p>
Many features elsewhere in the radio (inputs, mixer lines, etc.) can
be set to be active only in a specified set of flight modes,
extending their use far beyond trims and global variables. Flight
modes can also be used wherever a switch or logical switch can,
making their use even more versatile.
</p>
<p>
Flight modes can also be named, the name having no significance in
controlling the model.
</p>
</li>
<li><b>Special functions</b> are a way of triggering actions based on switch
values (physical or logical). Examples of their use are:
<ul class="org-ul">
<li>Speech-synthesis voice output of parameter values at the flick of
a switch, triggered by a timer value, triggered by a telemetry
parameter reaching a critical value, etc.
</li>
<li>Pre-recorded voice announcements of important functions and
warning.
</li>
<li>Setting global variables.
</li>
</ul>
</li>
<li><b>Lua</b> is a universal programming-language already in use in many
devices in your everyday life that you don't even know about.
OpenTX has a Lua interpreter built in, which allows you to extend
the already great functionality of OpenTX even further. Lua
programs (also called scripts) reside on the memory card of the
transmitter and can be run from within your model using special
functions in order to control complex features otherwise impossible
or hard to realize, such as intricate gear-door sequencing. They
can also be used outside of models, for example for implementing a
model setup wizard which sets up inputs, mixers, etc. for common
scenarios.
</li>
<li><b>Telemetry display</b>, <b>audio output</b>, and <b>haptic alerts</b> are an
integral part of OpenTX. In fact, models can be set up such that
one never needs to look at the transmitter display because the radio
lets the user know acoustically or by vibrating whatever they need
to know.
<p>
With telemetry data from a variometer, an acoustic variometer
readout is also available, similar to the total-energy instruments
in manned gliders.
</p>
<p>
For speech synthesis and pre-recorded prompts, a memory card must be
present and loaded with the relevant voice samples, whereas simple
beep functionality is integrated into the firmware and functions
even without the card.
</p>
</li>
<li><b>Trainer</b> master functionality is implemented at the "sticks" level:
each channel of the "slave" transmitter is interpreted as a stick,
pot or input, thus the slave transmitter must be set up as a "1:1"
controller, passing each control axis directly to one of the servo
channels. Up to 16 slave channels are supported this way, and
assignment is free, meaning that any existing transmitter can be
used as a slave, even if it has fixed channel assignment. The axes
to be controlled by the slave transmitter can be picked in a very
flexible way.
<p>
The 16 trainer input channels can also be used directly in place of
any analogue input within the model, regardless of whether the slave
controller is in control or not. (XXXX TBC)
</p>
</li>
<li><b>Companion</b> is a software program to be run on a common computer
(ready-make Linux, Windows, and Mac versions are available). It
goes hand-in-hand with OpenTX because its aim is to model your
transmitter as closely as possible on the screen of your computer.
Companion is very useful for trying new settings with the comfort of
your PC's large screen, keyboard and mouse, which usually allow for
faster programming than the few buttons on the transmitter. Models
can be copied to and from the transmitter using a USB connection,
therefore Companion is even useful for making large changes to
models which would be combersome to make on the transmitter itself.
<p>
For the prospective or beginning OpenTX users, however, Companion is
a great tool for familiarizing yourself with the basic concepts of
OpenTX, before even spending money on a transmitter.
</p>
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-5" class="outline-2">
<h2 id="sec-5"><span class="section-number-2">5</span> Learning by doing</h2>
<div class="outline-text-2" id="text-5">
<p>
One thing every model pilot (or driver or captian) must learn at the
early stage is to relax while at the controls, as an upset pilot can
do stupid things they wouldn't normally do. Since the prospect of
learning to use such a complex system as a radio with OpenTX can be
similarly daunting, we thorougly recommend for the reader to sit back,
relax, and follow this chapter closely, as it will set-up a fairly
common aircraft model, displaying the use and features of the radio in
the process.
</p>
</div>
<div id="outline-container-sec-5-1" class="outline-3">
<h3 id="sec-5-1"><span class="section-number-3">5.1</span> The model memory</h3>
<div class="outline-text-3" id="text-5-1">
<blockquote>
<p>
<b>Why is this?</b>
</p>
<p>
The model we just set up is empty.
</p>
</blockquote>
</div>
</div>
</div>
<div id="outline-container-sec-6" class="outline-2">
<h2 id="sec-6"><span class="section-number-2">6</span> OpenTX in detail</h2>
<div class="outline-text-2" id="text-6">
</div><div id="outline-container-sec-6-0-1" class="outline-4">
<h4 id="sec-6-0-1"><span class="section-number-4">6.0.1</span> Menu overview</h4>
<div class="outline-text-4" id="text-6-0-1">
<p>
TBD: diagram of the menus and how to switch between them (on Taranis)
</p>
</div>
</div>
<div id="outline-container-sec-6-0-2" class="outline-4">
<h4 id="sec-6-0-2"><span class="section-number-4">6.0.2</span> Main views</h4>
<div class="outline-text-4" id="text-6-0-2">
<p>
We have 3 main views showing the same basic information in the top
part and different inputs/outputs on the lower part. On the main views
a long press of the ENTER key brings up a menu where you can reset the
timers, telemetry data (min/max values, altitude, GPS home…), all of
those, bring up a statistics view (throttle graph, timers), or show
the developer credits. As mentioned above, a short press of the PAGE
key switches views.
</p>
<p>
The new title bar includes radio battery voltage, receiver signal
strength (for FrSky telemetry-capable receivers), main onboard voltage
(can be receiver battery, flight battery, or anything else depending
on sensors the "Voltage" parameter in the telemetry settings), status
icons (SD present, USB connected, trainer port mode, logging in
progress), audio volume and time.
</p>
<p>
The other "always present" items are model name, flight mode, and
trim/pot positions. The logo is of course customisable, you'll be able
to load your model's photo there! See this thread for a great
collection of models made by the community.
</p>
<p>
The first view lists the physical switch states in the bottom left
zone, and the 2 timers (when enabled) on the right.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_main_screen1.png" alt="taranis_main_screen1.png" />
</p>
</div>
<p>
The second shows the gimbal and switches positions, and is handy to
check that all the physical controls respond as intended.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_main_screen2.png" alt="taranis_main_screen2.png" />
</p>
</div>
<p>
The third shows again the physical switches on the left, and the
states of the 32 custom (logic) switches on the right.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_main_screen3.png" alt="taranis_main_screen3.png" />
</p>
</div>
<p>
The last view is a channel monitor showing the servo outputs for all
32 channels (+/- change page). If channel names are defined on the
SERVOS page, they will show up here instead of the numbers for
convenience.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_channel_monitor.png" alt="taranis_channel_monitor.png" />
</p>
</div>
</div>
</div>
<div id="outline-container-sec-6-0-3" class="outline-4">
<h4 id="sec-6-0-3"><span class="section-number-4">6.0.3</span> Telemetry view</h4>
<div class="outline-text-4" id="text-6-0-3">
<p>
A LONG press of the PAGE key from any of the main views brings up the
telemetry views. The PAGE and +/- keys will then cycle between the
power status screen (voltage, current, power or A1/A2 if not set, cell
voltages from an FLVS-01 sensor if connected), the min/max and GPS
coordinates screen, and if defined from one to three customs screens
that can hold up to 12 items each, configured in the telemetry setup
menu.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_telemetry_screen1.png" alt="taranis_telemetry_screen1.png" />
</p>
</div>
<div class="figure">
<p><img src="./screenshots/taranis_telemetry_screen2.png" alt="taranis_telemetry_screen2.png" />
</p>
</div>
<div class="figure">
<p><img src="./screenshots/taranis_telemetry_screen3.png" alt="taranis_telemetry_screen3.png" />
</p>
</div>
</div>
</div>
<div id="outline-container-sec-6-0-4" class="outline-4">
<h4 id="sec-6-0-4"><span class="section-number-4">6.0.4</span> Radio general settings</h4>
<div class="outline-text-4" id="text-6-0-4">
<p>
A LONG press of the MENU key brings up the mostly self-explanatory
radio setup menu:
</p>
<div class="figure">
<p><img src="./screenshots/taranis_radio_setup.png" alt="taranis_radio_setup.png" />
</p>
</div>
<ul class="org-ul">
<li>Date/Time: To be set, they serve as info but also to give a correct timestamp to files and logs saved by the radio.
</li>
<li>Battery range: range of the graphical radio battery meter on the main views. To be set accordingly with the battery type you use (2s lipo here).
</li>
<li>Sound settings: Mode, Master volume, individual volumes of all mixed sources (Beeps, sound files, variometer, background music), beep duration and pitch.
</li>
<li>Contrast: Screen contrast setting.
</li>
<li>Alarms -> Sound off: if "Sound Mode" is "Quiet", the radio will not even sound warnings like a low battery. This alarm will remind you of that when turning the radio on.
</li>
<li>Inactivity alarm will remind you if you have forgotten to turn the radio off.
</li>
<li>Backlight -> Mode: If set to Keys, Controls or Both, the backlight will turn on when a stick/switch is moved and/or a key is pressed, for the duration set below.
</li>
<li>Backlight -> Alarm: Backlight will flash when an alarm sounds.
</li>
<li>Splash screen: On Taranis the splash will always be shown as the memory takes some time to load. Setting this on will just show it for longer.
</li>
<li>GPS time zone is there to show you the correct time when a GPS is present, and coordinate format lets you adjust display format to your liking.
</li>
<li>Country code: Must match your geographical location to keep RF transmission parameters within regulatory requirements.
</li>
<li>Voice language: Allows you to choose the language of the voice announcements. Note that the list contains all supported languages, but you also need to ensure a voice pack for that language has been loaded onto the SD card (in a subfolder of the SOUNDS directory).
</li>
<li>Units: Allows choosing between metric and imperial units for telemetry values.
</li>
<li>FAI mode (if the "FAI choice" option is selected in OpenTX companion): Disables all telemetry displays other than RSSI and voltage to comply with contest regulations. This is one-way, i.e. when you turn it on with this menu option it can't be disabled anymore, you need to connect the radio to the PC and use OpenTX companion to turn it off again (to prevent cheating). This allows you to come to the field, do your checks / test flights with telemetry, and turn the restricted mode on before the beginning of the contest on the radio itself.
</li>
<li>Default channel order: Defines the order of the 4 default mixers that are inserted on channels 1-4 when creating a new model. Set this to your preference. They can of course always be moved later, this is just a time-saving option.
</li>
<li>Mode: This is your stick mode, e.g. Mode 1 for throttle and aileron on the right stick, Mode 2 for throttle and rudder on the left stick.
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-6-0-5" class="outline-4">
<h4 id="sec-6-0-5"><span class="section-number-4">6.0.5</span> SD browser</h4>
<div class="outline-text-4" id="text-6-0-5">
<p>
A SHORT press of the PAGE key brings up the SD card browser page:
</p>
<div class="figure">
<p><img src="./screenshots/taranis_sd_browser.png" alt="taranis_sd_browser.png" />
</p>
</div>
<p>
This allows you to browse the SD card contents.
</p>
<p>
On each file or folder, pressing ENTER will bring up a contextual menu
with some basic file operations (copy/delete), as well as others
depending on the file type.
</p>
<p>
Folders are organised as such:
</p>
<ul class="org-ul">
<li>BMP folder: This is where you should place the 64x32, 4-bit grayscale .bmp files that you want to use as model logos. Filenames must be 10 chars long or less (not including extension). A collection of files is available here. Placing the cursor over a valid file in this folder will show it on the right side of the screen, and in the contextual menu you will find an entry to assign the selected image to the current model.
</li>
<li>LOGS folder: This is where you will find telemetry logs if enabled. Files will be created with the same name as the model they were saved from, with the date appended. One log file is created per day for each model.
</li>
<li>MODELS folder: Model files saved by the "Archive model" command of the model selection screen will be placed here. Similarly, models you want to reload using the "Restore model" of the same page need to be placed there beforehand.
</li>
<li>SOUNDS folder: This is where voice packs need to be placed. ZIP files with the standard voice packs can be downloaded from within OpenTX companion, or here. Extract the ZIP file to the root of the SD card, and it will create the necessary subdirectories (e.g. SOUNDS/en for the English pack). Any file you want to have available for the "Play Track" custom function needs to be placed within the language's directory as well. In this folder, the contextual menu includes a preview function.
</li>
<li>XXXXXXXX others?
</li>
</ul>
<p>
The microSD card can be formatted by selecting the relevant option in
the menu that appears when pressing MENU LONG. A confirmation will be
required.
</p>
</div>
</div>
<div id="outline-container-sec-6-0-6" class="outline-4">
<h4 id="sec-6-0-6"><span class="section-number-4">6.0.6</span> Trainer</h4>
<div class="outline-text-4" id="text-6-0-6">
<p>
A SHORT press of the PAGE key calls the trainer settings page:
</p>
<div class="figure">
<p><img src="./screenshots/taranis_trainer.png" alt="taranis_trainer.png" />
</p>
</div>
<p>
This page allows you to configure the trainer function for "master"
use (make sure the Trainer mode in model settings is set to
Master). For each of the 4 main functions you will be able to set the
mode (OFF, += for Add, := for Replace), ratio and input channel.
</p>
<p>
Start by setting the mode for each function (the "standard" way is
Replace i.e. when the trainer function is activated the function is
fully transferred to the student, Add allows both master and student
to act upon the function together). Then select the source channel
accordingly to the brand/model of the student radio, and set the ratio
to 100% for now. Now ensure the student radio is connected and
recognised (moving the sticks of the student radio should change the 4
numbers at the bottom of the screen) make sure all its trims are
neutral, all its sticks are centered (including throttle). Select the
CAL field and press ENTER twice. The numbers should now be 0.0 or very
close.
</p>
<p>
Now move the student radio's sticks and check the numbers vary from
-100 to +100. Should they reach those values before the stick hits the
end of its travel, reduce the ratio so that the throws match. Should
they never reach -100 to +100 even with full stick deflection, use the
Multiplier field to increase it.
</p>
<p>
Trainer input is now configured. Note that this setting is global,
because it depends on the student radio regardless of the selected
model. In order to use the Trainer function on a specific model you
will need to assign the switch you want to the "Trainer" Custom
Function for that model. More about this further.
</p>
</div>
</div>
<div id="outline-container-sec-6-0-7" class="outline-4">
<h4 id="sec-6-0-7"><span class="section-number-4">6.0.7</span> Version</h4>
<div class="outline-text-4" id="text-6-0-7">
<p>
This screen allows you to see the version of your currently loaded
OpenTX firmware.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_version.png" alt="taranis_version.png" />
</p>
</div>
<p>
When reporting a bug, please be sure to include the revision number
you see on the SVN line. XXXXX TBC
</p>
</div>
</div>
<div id="outline-container-sec-6-0-8" class="outline-4">
<h4 id="sec-6-0-8"><span class="section-number-4">6.0.8</span> Diagnostics</h4>
<div class="outline-text-4" id="text-6-0-8">
<p>
The next 2 pages are the switch and analog diagnostics, they will show
you what the firmware reads from the radio's keys and
potentiometers. This is the first place to go to if you run into
issues with badly responding sticks / pots / switches. If things are
wrong here (inconsistent stick centering or end point readings,
flickering value,…) then you can be sure the problem is
hardware-related and not due to wrong model setup.
</p>
</div>
<ol class="org-ol"><li>Input monitor<br /><div class="outline-text-5" id="text-6-0-8-1">
<p>
The Analog page also features the battery calibration setting. It
should be correct out of the box, but if not move the cursor to the
field, and adjust it so that the displayed value matches the voltage
you can measure on the battery terminals with a voltmeter.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_input_monitor.png" alt="taranis_input_monitor.png" />
</p>
</div>
</div>
</li>
<li>Calibration<br /><div class="outline-text-5" id="text-6-0-8-2">
<p>
This is the place where you can calibrate sticks and pots. Follow the
on-screen instructions, and note that when asked to center the sticks
this includes the throttle stick and the 2 sliders. S1 and S2 pots
however do not need to be centered, only the extremes are calibrated.
</p>
<div class="figure">
<p><img src="./screenshots/taranis_calibration.png" alt="taranis_calibration.png" />
</p>
</div>
</div>
</li></ol>
</div>
<div id="outline-container-sec-6-0-9" class="outline-4">
<h4 id="sec-6-0-9"><span class="section-number-4">6.0.9</span> Model menus</h4>
<div class="outline-text-4" id="text-6-0-9">
<p>
A SHORT press of the MENU key from the main views brings up the model
selection screen. There models can be selected, deleted, backed up and
restored to/form SD card using the menu brought up by a LONG press on
the ENTER key. They can also be copied or moved (one SHORT press on
ENTER key highlights the line, +/- create and place a copy of the
model on the desired slot, while two SHORT presses create a dotted
outline where +/- simply move the selected model to another slot.)
</p>
<div class="figure">
<p><img src="./screenshots/taranis_model_selection.png" alt="taranis_model_selection.png" />
</p>
</div>
</div>
<ol class="org-ol"><li>Model setup<br /><div class="outline-text-5" id="text-6-0-9-1">
<p>
A SHORT press of the PAGE key brings up the basic model setup page:
</p>
<div class="figure">
<p><img src="./screenshots/taranis_model_setup.png" alt="taranis_model_setup.png" />
</p>
</div>
<ul class="org-ul">
<li>Model name: Self-explanatory… Change letter with +/- keys, go to the next with ENTER SHORT, or press ENTER LONG to capitalize the current letter before switching to the next.
</li>
<li>Model image: There you can select a 64x32px, 16-grayscale .bmp file located in the BMP folder of the SD card as your model logo. To be able to preview the images in the folder, use the SD Browser.
</li>
<li>Timers: There are 2 fully programmable timers, that can count either up or down. If the value is set to 00:00 they will count up from 0, if not they will count down from the preset value. The trigger is set using the field next to the timer value, ABS counts up all the time, THs runs whenever the throttle stick isn't at idle, THt starts the timer the first time throttle is advanced, TH% counts up as a percentage of the full stick range. Persistent, if ticked, means the value is stored in memory when the radio is powered off or model is changed, and will be reloaded next time the model is used. Minute call will beep / say the time every full minute, while countdown will also give announcements several more times during the last minute.
</li>
<li>Extended limits allow setting servo movement limits up to 125% instead of 100%.
</li>
<li>Extended trims allows trims to cover the full stick range instead of +/-25%. Be careful when using this option, as holding the trim tabs for too long might trim so much as to render your model unflyable. The "Reset" item will reset all trims (for all flight modes).
</li>
<li>Trim step sets the precision of trim clicks. Exponential means very fine steps close to the trim center, but larger ones the farther you get from center.
</li>
<li>Throttle reverse: Ensures correct operation of throttle-based timers and functions for people who like having full throttle with the stick down.
</li>
<li>Throttle source defines what triggers the THx functions of the timers. It's common to set it to the throttle channel instead of the stick, so that throttle cut or other modifiers are taken into account.
</li>
<li>Throttle trim: IC engine mode, where trim only affects the idle part of the throw without touching the full throttle point.
</li>
<li>Throttle Warning: Will warn you if the throttle stick is not at idle when the radio is powered up or a model is loaded.
</li>
<li>Switch warning: Defines whether the radio requests the switches to be in predefined positions on power on/model change. To set them, arrange your switches the way you like, and press ENTER LONG.
</li>
<li>Center beep: Makes a beep when the selected control(s) pass the center point.
</li>
<li>Internal RF:
<ul class="org-ul">
<li>Mode: Transmission mode of the internal RF module (OFF, D16, D8, LR12).
</li>
<li>Channel range: Choice of which of the radio's internal channels are actually transmitted over the air.
</li>