OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

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!
Post Reply
thebriars0
Posts: 78
Joined: Wed Dec 02, 2015 9:25 pm
Country: United Kingdom

OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Mon Mar 05, 2018 7:58 pm

Here is the extensively updated documentation for OpenTX 2.2. It covers (hopefully) all aspects of OpenTX on the Taranis X9D+, X9E, X7, Horus X10, and Horus X12S transmitters. The 240 pages are split into 10 sections. Section 1 lists the contents of each of the other sections. Section 2 is a Getting Started guide for those new to OpenTX, or even for those who just want to know more about the program but don't have a suitable transmitter. 5 sections detail all aspects of OpenTX, while 2 further sections are Taranis and Horus specific. Finally there are two How-To sections.

Each section is in pdf format which can either be used on screen or printed out.

Section 1, Introduction and Contents
Section 1, Introduction & Contents.pdf
(312.06 KiB) Downloaded 968 times
Section 2, Getting Started
Section 2, Getting Started.pdf
(3.68 MiB) Downloaded 867 times
Section 3, The OpenTX Companion
Section 3, The OpenTX Companion.pdf
(3.62 MiB) Downloaded 750 times
Section 4, The Radio Settings Menu
Section 4, The Radio Settings Menu.pdf
(1.83 MiB) Downloaded 759 times
Section 5, The Model Editor
Section 5, The Model Editor.pdf
(9.24 MiB) Downloaded 766 times
Section 6, telemetry
Section 6, Telemetry.pdf
(3.17 MiB) Downloaded 750 times
Section 7, The Taranis Transmitters
Section 7, The Taranis Transmitters.pdf
(4.18 MiB) Downloaded 691 times
Section 8, The Horus Transmitters
Section 8, The Horus Transmitters.pdf
(3.98 MiB) Downloaded 925 times
Section 9, How-To, Part 1
Section 9, How-To Part 1.pdf
Section 9, How To Part 1
(2.77 MiB) Downloaded 922 times
Section 10, How-To, Part 2
Section 10, How-To Part 2.pdf
(2.06 MiB) Downloaded 835 times

sande005
Posts: 10
Joined: Sun Jun 15, 2014 2:10 pm
Country: -

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by sande005 » Mon Mar 05, 2018 10:47 pm

Very impressive! Thank you for putting this together. It will be very handy to refer to as I build new models in my radios.

I do note that the section on GVARS does not mention Name, Unit, Precision, Min or Max - what they are, and possible limitation on their use (ie - "precision" of 0.0, when reading a + or - 100% value will move the decimal, giving a GVAR of only 10%, etc.). Or is this a really new feature of 2.2.1, so wasn't applicable to 2.2.0?

punkindrublik
Posts: 19
Joined: Mon Jul 15, 2013 6:38 am
Country: -

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by punkindrublik » Tue Mar 06, 2018 1:14 am

Yes, thank you!

Daedalus66
Posts: 1769
Joined: Tue Dec 27, 2011 8:22 pm
Country: -
Location: Ottawa

OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by Daedalus66 » Tue Mar 06, 2018 1:51 am

I found your document on 2.1 very good indeed and am sure this will be equally helpful. From one who spends quite a bit of time writing instructions of this kind for other equipment, thank you for an excellent job.

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Tue Mar 06, 2018 10:00 am

sande005 wrote:
Mon Mar 05, 2018 10:47 pm
Very impressive! Thank you for putting this together. It will be very handy to refer to as I build new models in my radios.

I do note that the section on GVARS does not mention Name, Unit, Precision, Min or Max - what they are, and possible limitation on their use (ie - "precision" of 0.0, when reading a + or - 100% value will move the decimal, giving a GVAR of only 10%, etc.). Or is this a really new feature of 2.2.1, so wasn't applicable to 2.2.0?
Good point. There are bound to be a few holes here and there. Will work on that!


User avatar
rcdiy
Posts: 190
Joined: Fri Jul 01, 2016 6:13 am
Country: Canada
Contact:

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by rcdiy » Tue Mar 06, 2018 6:56 pm

This is awesome! We now have online, printed and PDF options:)
If you're looking for an
Online Manual http://rcdiy.ca
Printed Manual https://alofthobbies.com
Last edited by rcdiy on Tue Mar 06, 2018 7:26 pm, edited 1 time in total.
RCdiy.ca
Stay Safe & Have Fun
OpenTX Manual http://rcdiy.ca
Paying it forward by sharing my Lua scripts, documentation and videos.

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Tue Mar 06, 2018 7:20 pm

Please note, neither of the above references are for the same manual as this.

User avatar
rcdiy
Posts: 190
Joined: Fri Jul 01, 2016 6:13 am
Country: Canada
Contact:

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by rcdiy » Tue Mar 06, 2018 7:32 pm

Please look at Section 3, page 15
Lua - Enables the use of lua scripts
.

Lua scripts are always enabled. This option enables the custom scripts screen which in turn enables us to configure mix scripts.

Section 3, page 16
Backup folder - The location of where firmware backup files will be stored on the computer
I used to think this as well but when I check/tried to verify I found it not to be the came.

Backup Folder: Location of backup eeproms/model settings on the computer
RCdiy.ca
Stay Safe & Have Fun
OpenTX Manual http://rcdiy.ca
Paying it forward by sharing my Lua scripts, documentation and videos.

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Wed Mar 07, 2018 7:20 pm

Hi Rcdiy, Point taken for the LUA scripts, Another change to make.

However, had a play with the backup, and I think it is a bug. I have found that nothing is saved in the backup files location despite a lot of different loading and saving. The models are saved in the file directed by the "Save as" command.

User avatar
Kilrah
Posts: 9487
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by Kilrah » Wed Mar 07, 2018 7:41 pm

What rcdiy said is correct, but it was made for the AVR radios back in the day (where flashing firmware erases all settings, so it was even more important to have a backup) and probably never really got support added for newer radios.

There has never been an automatic firmware backup feature for any radio.

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Wed Mar 07, 2018 8:04 pm

So what is the enable automatic backup before writing box for:
Capture.JPG

User avatar
Kilrah
Posts: 9487
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by Kilrah » Wed Mar 07, 2018 8:31 pm

"Enable automatic backup of models and settings before writing firmware." BUT as I said may or may not do anything on some radios.

User avatar
rcdiy
Posts: 190
Joined: Fri Jul 01, 2016 6:13 am
Country: Canada
Contact:

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by rcdiy » Thu Mar 08, 2018 5:20 am

I think I’ll add a note in my documentation explaining not to rely on it and to do our own backups. I may create a GitHub issue. It would be nice to have clarity on expectations of that option.
RCdiy.ca
Stay Safe & Have Fun
OpenTX Manual http://rcdiy.ca
Paying it forward by sharing my Lua scripts, documentation and videos.

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Thu Mar 08, 2018 10:48 am

At the very least, the boxes are unclear. As far as I can see, It was of some use with the Taranis, as a 32k bin file was stored in the directory, however it has no effect whatsoever with the Horus. I will alter my docs too to clarify this. I think you are right not to rely on it doing model backups. The program is complicated enough as it is, could these boxes simply be removed?

User avatar
Kilrah
Posts: 9487
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by Kilrah » Thu Mar 08, 2018 1:09 pm

If it works for the Taranis which I wasn't even sure about then it should be left for it. For Horus it wasn't possible but the upcoming bootloader might change that.

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Sun Mar 25, 2018 8:35 pm

Could the text in the edit settings menu be improved to clarify things?

georgeg
Posts: 1
Joined: Sun May 13, 2018 3:47 am
Country: -

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by georgeg » Sun May 13, 2018 3:57 am

This is a most impressive manual. Easily the best available. I like how it shows Taranis, X7, X10 and X12 and illustrates the differences in their displays. Very well done. That said, might you consider rotating the illustrations on pgs 5-34,35, and 36? As published, when you print them and then 3-hole punch the pages, they read from across the left side of a binder. I could 3-hole punch the other side of the pages but then the page numbers would be upside down at the top of the page which doesn't work too well.

Your page 9-15 for recording what switches are used for is nice but is there any chance of doing similar pages using the other transmitters as your illustration?

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

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by thebriars0 » Sun May 13, 2018 1:27 pm

Thank you for those comments. Good point about the illustrations. Nobody else has commented on that!

As for the switch diagram. I'll have to work on that. I ran out of time/effort/patience/coffee when I was finishing that section off.

There will have to be an update soon to correct a number of omissions, errors , suggestions, and the changes made to 2.2.2 when it comes out, though this would appear a while away yet.

User avatar
rcdiy
Posts: 190
Joined: Fri Jul 01, 2016 6:13 am
Country: Canada
Contact:

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by rcdiy » Fri Jun 01, 2018 11:23 pm

The OpenTX Companion
Section 3
Page 15

Lua - Enable the use of LUA scripts. Use of LUA scripts are outside the scope of this guide.
Incorrect.
Lua - Enables the Lua custom scripts screen.
Similar to how noheli removes the heli CCP screen. Lua adds the custom scripts screen.
The companion Lua mouse over tool tip has now been updated to say this.

Page 16
Backup folder: The location of where firmware...
Incorrect
Backup Folder: Location of backup eeproms/model settings on the computer

Both these mistakes are ones I made during my documentation but corrected on discussion with the developers.
RCdiy.ca
Stay Safe & Have Fun
OpenTX Manual http://rcdiy.ca
Paying it forward by sharing my Lua scripts, documentation and videos.

User avatar
rcdiy
Posts: 190
Joined: Fri Jul 01, 2016 6:13 am
Country: Canada
Contact:

Re: OpenTX 2.2 Documentation for the Taranis and Horus Transmitters

Post by rcdiy » Fri Jun 01, 2018 11:36 pm

Oops I see I already reported this but they haven't been addressed.
How often will you update your documentation. While outstanding in the production/presentation we need them to be correct as well. I'm directing people to your documents from the OpenTX Manual Post sticky on this site and from the RCDIY.ca home page.

Just so you know, I'm not reading through looking for errors :) I was reading through to figure out how Companion connects to the Horus transmitters. Turn off Horus, plug in USB cable, Zadig STM32 drivers used, then use Companion to edit models and settings and do firmware updates????
RCdiy.ca
Stay Safe & Have Fun
OpenTX Manual http://rcdiy.ca
Paying it forward by sharing my Lua scripts, documentation and videos.

Post Reply

Return to “openTx”