Documentation for OpenTX 2.1 and Taranis

openTx has introduced a range of new features, ideas and bling. It is fast becoming the firmware of choice for many users. openTx will run on ALL current hardware platforms, including the gruvin9x and sky9x boards. Work has already started to support the new FrSky X9D radio!
thebriars0
Posts: 46
Joined: Wed Dec 02, 2015 9:25 pm
Country: United Kingdom

Documentation for OpenTX 2.1 and Taranis

Post by thebriars0 » Sat Apr 16, 2016 2:35 pm

It would appear that decent, printed, up-to-date documentation for OpenTX has been quite a weakness, and particularly anything that works from using the Companion rather than just the transmitter. I'll leave it to you to decide whether this qualifies as decent! As it is about OpenTX, it focuses on that, using the Taranis 9XD as the transmitter example being the most common, rather than simply being about the Taranis. I know many have learned simply by programming the transmitter, and as with all things computing, one likes the things and ways one learns first, so please don't criticise using the Companion as the starting point. - If you want to, start a debate in another topic please. Personally I believe that the Companion gives a far better overview of the whole model setup, and that it is easier having used the Companion to then transfer that knowledge to the transmitter. It was certainly easier to write that way. There are plenty of screen shots to illustrate the text and hopefully make it more understandable and accessible. Wherever possible, I have also tried to link what is happening on the Companion to how the same thing operates on the transmitter.

Another feature of this documentation is not to try making it backward compatible. All this would do is make the guide cumbersome to follow, and anyway, the whole point of open source software is that one updates as new improvements come along. There is plenty of help on the internet for those wishing to update to OpenTX 2.1.

The documentation is broken down into several parts. The first part "Getting Started" is aimed at someone with no experience of OpenTX. It is intended to take a beginner gently into the use of OpenTX, and much of this part does not require the reader to have a transmitter to find out how it works.

The second part is the Reference Section, covering all aspects of the OpenTX in as much detail as possible, but bearing in mind brevity. The new 2.1 telemetry is covered in the Reference Section. In this section I have tried to address many of the common issues with OpenTX that crop up on forums such as this.

The final part is a series of How To's. There is lots of scope here for more How To's, and a second part may be added in the future.

Sept 2016 Added a short correction file, and an update for OpenTX 2.1.9. There is only one change that needs an update in the documentation.

June 2016:-
OpenTX Getting Started.pdf
(4.03 MiB) Downloaded 6060 times
June 2016:-
Reference Section 1, The Basics.pdf
(5.23 MiB) Downloaded 3665 times
June 2016:-
Reference Section 2, General Edit.pdf
(3.23 MiB) Downloaded 3020 times
June 2016 (minor update on 21st to improve quality of inputs/mixer/outputs diagrams on pp 31-33):-
Reference Section 3, The Model Editor Part 1.pdf
(9.94 MiB) Downloaded 3060 times
June 2016:-
Reference Section 3, The Model Editor Part 2.pdf
(6.23 MiB) Downloaded 2863 times
June 2016:-
Reference Section 4, How To.pdf
(4.9 MiB) Downloaded 3827 times
Sept 2016:- A couple of corrections and an update on a change in OpenTX 2.1.9
OpenTX Corrections Sept 16.pdf
(244.64 KiB) Downloaded 2213 times
Last edited by thebriars0 on Fri Sep 16, 2016 7:20 pm, edited 4 times in total.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 3:10 pm

on page...
General Edit, The Setup Screen
On the radio, the setup screen is called Radio Setup. On the OpenTX Companion it is called simply Setup. Apart from the functions already mentioned, the functions on both are the same.


Twas me having problems finding the "THIRD" setup screen.
On mine it's called as you mention in the beginning: General Settings, followed by General Edit. I can find no where "Setup" as you mention in the header.

Just reading through your 2.1 manual, which is also a THANK YOU.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 3:15 pm

Adjust RTC
RTC = Real time clock. Ticking is box will update the RTC with the GPS time. (Needs GPS telemetry to be installed in a model.)

I think you mean Ticking THIS box...

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 3:20 pm

The above were from General Settings Section two... sorry

thebriars0
Posts: 46
Joined: Wed Dec 02, 2015 9:25 pm
Country: United Kingdom

Re: Draft Documentation for OpenTX 2.1

Post by thebriars0 » Mon Apr 18, 2016 6:11 pm

Thanks for the comments. Corrected the RTC, and the Settings one. You are right, the latter needed to be more clearly written, it was confusing.

Keep the red pen handy and please post anything else which is unclear or wrong.


chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 9:14 pm

page 35 section 3b

L2 will flash (i.e. signify true) when SH has been held down for one second, L1 will then flash after SH is released. Nether will flash if Sh is held down for a

end of sentence is missing? Doesn't seem to flow with the next page.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 9:24 pm

page 38, here's that darn Setup again, which setup??

SECTION 3
Martin Phillips April 2016
38
Open TX The Model Editor
The Special Functions Screen
The Special Functions screen gives the option of adding all sorts of exciting features to a model program. For every model, there are up to 64 Special Functions available. In addition there are a further 64 Global Functions available. These are accessed from the Setup screen and are the same as the Special Functions expect that they operate on all model settings. Thus for a function one

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 9:32 pm

This is a little off center but you might lead some light on it for me.

SWR: I've been an electronic tech for 60 years and it always meant Standing Wave Ratio of the RF output to the antenna. So I see it's a telemetry option, and / or it comes from the receiver, some result there.
My first stumble across this SWR on Taranis Plus was an earlier version of 2.0, perhaps 2.0.12 or something like that where I did a telemetry reset for altitude (moved the model down to the field, about 10 ft below the start up stand) and up came the SWR warning "bad antenna or the like". Now it dawns on me that the reset interrupted the telemetry and so the warning.

What are we really measuring...

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 9:55 pm

Pg 40 section 3b

SetFailsafe Int. Module
This feature allows the failsafe to be set dynamically, either on the ground or in the air. Assign a switch to this and with the control surfaces set as required for failsafe, simply pressing this switch will store their values. This particular feature if for the internal XJT module in a Taranis.

I think you mean IS

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:00 pm

PG 41: This is better than sliced bread! I knew there should be a way to do that. BUT it might be mentioned that this is only one line at a time OR, if possible the old Click/Shift to grab a bunch of them all at once. I don't know if that's possible, just got excited with cut and past from another model.

A useful short cut when editing the Special Functions screen is right-clicking on the special function number in the left hand column to obtain the following menu box. This enables special function lines to be cut copied or moved not only within the same model functions screen, but between models too.
OpenTX Companion

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:05 pm

PG 42 section 3b

"Calculated" virtual sensors can be manually created to combine values or extract extra data. Values can be added, averaged or multiplied, the minimum or maximum of a set of up to 4 values van be extracted.

can?

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:11 pm

It's probably okay or correct, I just stumbled when I read

section 3b pg 46

Although sensors will appear, the values might not appear straight away. GPS data takes several minutes

right away or immediately

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:14 pm

somewhere back, back back, I read another similar description of RSSI, perhaps you could do a search for it. I think you didn't describe the "I".

This one is right

RSSI
RSSI stands for Received Signal Strength Indicator
from pg 47

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:27 pm

pg 48 section 3b

This drop down box offers a range of units. Conversion is carried out automatically if the unit is acceptable alternative for the default unit. i.e. mph can be changed to km/h, but not volts, although the units shown appear to have changed.

Now the truth comes out. I was really interested in the telemetry from the beginning but your doc is so well done, looks so good, and now we're in great pictures of telemetry stuff and I'm excited.
I just don't understand the comment in bold above.

I have a sensor that simply reads the voltage of my ignition battery, but it reads it all wrong and if you disconnect it from the receiver it continues to read it wrong for about a minute till then it starts to blink on the telemetry screen. None of all that makes any sense to me.
There are some weird things that happen to the main screen of the TX if you don't define A2, it just comes up with some representation of "something" an none of it makes sense. Now defining the telemetry screen RXbt makes the main tx screen correct. Interesting too.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:34 pm

pg 52 section 3b

This data can be stored on the transmitters SD card, and downloaded to a computer using a USB cable and Bootlogger mode

I think BootLoader mode

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:41 pm

pg 53 section 3b

Not sure if this matters.
I think most of the US guys think "antenna" not aerial.

I just halted when I read it. Antennas are packed with xXR's so that might be a consideration. Not my call.

The data logging also logs the joystick, slider and switch positions on the transmitter. Even if no sensors are fitted it will also log the RSSI and receiver battery voltage. This latter ability is very useful with a new model to fully test that the receiver aerials are functioning well in all flight conditions.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:46 pm

That's it for me today.

I'll try to go through:
OpenTX Getting Started Part1.pdf
(1.45 MiB) Downloaded 103 times
Reference Section 1, The Basics.pdf
(1.12 MiB) Downloaded 68 times
Reference Section 2, General Edit.pdf
(2.7 MiB) Downloaded 59 times
in the next few days if I have time. and the

and How TO's
It's been fun and you taught me a lot! Thanks to you.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Mon Apr 18, 2016 10:48 pm

Back to that telemetry and SWR issue.

Just seems wrong that it requires telemetry from the RX to tell me about my TX. Just makes no sense period.

User avatar
MikeB
9x Developer
Posts: 13609
Joined: Tue Dec 27, 2011 1:24 pm
Country: -
Location: Poole, Dorset

Re: Draft Documentation for OpenTX 2.1

Post by MikeB » Mon Apr 18, 2016 11:02 pm

The XJT module sends telemetry data to the main processor. One of the items it sends is the SWR of the XJT, so it is handled as a telemetry item, and is always present, even if you don't have a receiver powered.

Mike.
ersky9x/er9x developer

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Tue Apr 19, 2016 10:05 am

Thanks for the flow on that Mike. Mentally I tied it to the telemetry from the RX.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Tue Apr 19, 2016 10:30 am

pg 7 how to's

errors highlighted

Sound files can be created for a variety of purposes. The can be used as warnings, for information or to play background music. Spoken files can be created using a microphone on the computer or a computer text-to-speech generator that will save the files. Sound files can also be spoken timed commands.

Either go on line a select a text to speech program, or download one. Balabolka if it available is quite a good program and has the added benefit that it will save in the right format for OpenTX without having to use Audacity to convert it.
Here is a phrase to be used when the timer countdown gets to zero. It does produce the odd wry smile down at the flying field.


THEY can be used, and, Either go on line AND.
Wry isn't used in American English. I had to look it up to find what it meant.
Perhaps "It does produce a good smile down at the flying field." That might be more universal.

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Tue Apr 19, 2016 10:32 am

how to pg 9

When the radio is turned on or the model is selected, display a check list text file and play an audio file. This is an example of a text file:
Audio files at model selection time may contain music, reminder to do a range check, reminder to orientate the antenna appropriately, other pre-flight checks or anything else you can imagine.
To Create The Text File
Using a text editor, like Notepad in Microsoft Windows, create a text file with name ‘MyModel.txt”. MyModel must be exactly the same as the name of the model, without blanks. The width of the Taranis screen is 35 characters so each line must be limiter to 35 characters - this includes spaces. The screen has 7 lines below the heading but you can scroll down to more lines.


When the radio is turned on or the model is selected, the radio can display a check list text file and play an audio file.
must be limited to

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Tue Apr 19, 2016 10:34 am

how to's pg 3

6. These files will need to be copied to a similar folder on the actual SD card in the transmitter. In OpenTX, with the transmitter in boot mode and connected to the computer, this can be


Bootloader

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Tue Apr 19, 2016 11:27 am

pg 13 Section 1

The next screen now shows the position of the joysticks and the TRIM switch positions.

The third screen shows the toggle switches and the state of the 32 Logical Switches. Each logical

sentence ends abruptly

chuckstarck
Posts: 22
Joined: Mon Apr 18, 2016 3:07 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by chuckstarck » Tue Apr 19, 2016 11:53 am

Pg 13 of getting started

The very end. Adding a last line of %100 travel, no switch will resolve a defective switch. I see this often in tutorials.


I"ve looked through it all now.

You've done a marvelous job.
I'd like to see the top of this thread edited each time you make a change in that section. That way a person can download all the manual and if there is a change, they can see what section that's in and just print that section or perhaps some way to update a page and print that page would even be neater.

Smiles to you for all you have done. Some will not want this because they already know and new people will have an anchored place to start from. We need a link on opentx-u for this work.

thebriars0
Posts: 46
Joined: Wed Dec 02, 2015 9:25 pm
Country: United Kingdom

Re: Draft Documentation for OpenTX 2.1

Post by thebriars0 » Tue Apr 19, 2016 2:50 pm

Wow! Thanks for all the hard work, ought to call you ChuckStar! I shall work my way through them in the next few days, and make the changes you've suggested.

Have had a flurry of emails, and it looks like the OpenTX team would like to include it on their website which is undergoing a rewrite at the moment. I'll do all the updates, and any more that come in and produce revised versions for the beginning of May hopefully. If it goes on the OpenTX website, then I shall remove these copies and put a link instead.

At the moment we have 3 fine days with sunshine but no RAIN and low winds, so flying takes priority. Our field is still flooded and too wet to cut the grass. Been quite mild all winter but wet.
Last edited by thebriars0 on Tue Apr 19, 2016 4:32 pm, edited 1 time in total.

RCAdik
Posts: 2
Joined: Fri Dec 04, 2015 7:04 pm
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by RCAdik » Tue Apr 19, 2016 3:42 pm

Good to hear about the OpenTX team!
2.1.x specific documentation will be helpful to many.

freddan6
Posts: 1
Joined: Wed Apr 20, 2016 5:58 am
Country: -

Re: Draft Documentation for OpenTX 2.1

Post by freddan6 » Wed Apr 20, 2016 6:30 am

Great Job.
I have a number of small comments

Reference Section 1. The Basics
Page 2) Configure communication. Please rephrase this, When I am using alternate radios, in my case 9XR and Taranis I need to go in to this menu and change communication when I change radio. I suspect it is automatically correct when using Taranis, and I need to change it when I plug in my 9XR.
Page 6) Fia Choice => FAI Choice, FIA Mode => FAI Mode.
Page 10) Please check this with someone native English speaking but the "for" looks wrong "This can be changed for one’s own screen." My gut feeling says "This can be changed to one’s own screen" But I am not 100% sure.
Page 13) Last sentence is cut. "Each logical" .... something should follow

regards //Fredrik

User avatar
Kilrah
Posts: 8769
Joined: Sat Feb 18, 2012 6:56 pm
Country: United Arab Emirates

Re: Draft Documentation for OpenTX 2.1

Post by Kilrah » Wed Apr 20, 2016 9:35 am

freddan6 wrote: Page 2) Configure communication. Please rephrase this, When I am using alternate radios, in my case 9XR and Taranis I need to go in to this menu and change communication when I change radio. I suspect it is automatically correct when using Taranis, and I need to change it when I plug in my 9XR.
You should not need to.

thebriars0
Posts: 46
Joined: Wed Dec 02, 2015 9:25 pm
Country: United Kingdom

Re: Draft Documentation for OpenTX 2.1

Post by thebriars0 » Wed Apr 20, 2016 4:22 pm

freddan6 wrote:Great Job.
I have a number of small comments

Reference Section 1. The Basics
Page 2) Configure communication. Please rephrase this, When I am using alternate radios, in my case 9XR and Taranis I need to go in to this menu and change communication when I change radio. I suspect it is automatically correct when using Taranis, and I need to change it when I plug in my 9XR.
Thanks for the response Kilrah

Page 6) Fia Choice => FAI Choice, FIA Mode => FAI Mode.
Done

Page 10) Please check this with someone native English speaking but the "for" looks wrong "This can be changed for one’s own screen." My gut feeling says "This can be changed to one’s own screen" But I am not 100% sure.
I am a native English speaker (British English I hasten to add.) Actually both are equally correct.
Page 13) Last sentence is cut. "Each logical" .... something should follow
Oops, formatting error hid the rest.

regards //Fredrik
Thanks for the feedback.

Post Reply

Return to “openTx”

Who is online

Users browsing this forum: No registered users and 5 guests