Difference between revisions of "OpenTX Integration"

From Spirit System Manual
Jump to: navigation, search
(41 intermediate revisions by 2 users not shown)
Line 46: Line 46:
 
|-
 
|-
 
|◦
 
|◦
|[[OpenTX 2.2]] <translate><!--T:10-->
+
|<translate><!--T:66-->
 +
[[OpenTX 2.2]]</translate> <translate><!--T:10-->
 
with Lua support</translate>
 
with Lua support</translate>
 
|-
 
|-
Line 69: Line 70:
 
<translate><!--T:14-->
 
<translate><!--T:14-->
 
To enable the Integration, you have to only connect your receiver and unit according to the following scheme. Please note, that to make this possible, you will need special cable that is available in our eshop.</translate>
 
To enable the Integration, you have to only connect your receiver and unit according to the following scheme. Please note, that to make this possible, you will need special cable that is available in our eshop.</translate>
 +
 +
'''So you will need to connect:'''
 +
*FrSky Integration cable
 +
*S-Bus, PPM or PWM connection to the receiver (same that you used without the integration).
  
 
[[File:opentx-cable.jpg]]
 
[[File:opentx-cable.jpg]]
Line 123: Line 128:
 
{| style="width: 95%;background-color: Gainsboro;color:black;"
 
{| style="width: 95%;background-color: Gainsboro;color:black;"
 
| colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center; "| '''<translate><!--T:28-->
 
| colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center; "| '''<translate><!--T:28-->
For Heli</translate>'''
+
Download script for Heli</translate>'''
 +
|-
 +
|All FrSky Taranis and Horus radios - '''ENGLISH''':
 +
|[http://www.spirit-system.com/dl/opentx/Spirit-2.5.1-en.zip http://www.spirit-system.com/dl/opentx/Spirit-2.5.1-en.zip]
 +
|-
 +
|All FrSky Taranis and Horus radios - '''ČESKY''':
 +
|[http://www.spirit-system.com/dl/opentx/Spirit-2.5.1-cs.zip http://www.spirit-system.com/dl/opentx/Spirit-2.5.1-cs.zip]
 +
|}
 +
</div>
 +
<p></p>
 +
<div align=center>
 +
{| style="width: 95%;background-color: Gainsboro;color:black;"
 +
| colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center; "| '''<translate>
 +
<!--T:62-->
 +
Download script for Aero</translate>'''
 
|-
 
|-
 
|FrSky Taranis X9D/X9D+/X9E:
 
|FrSky Taranis X9D/X9D+/X9E:
|[http://www.spirit-system.com/dl/opentx/Spirit-2.2.0-Taranis.zip http://www.spirit-system.com/dl/opentx/Spirit-2.2.0-Taranis.zip]
+
|[http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Taranis-x9.zip http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Taranis-x9.zip]
 +
|-
 +
|FrSky Taranis Q X7:
 +
|[http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Taranis-x7.zip http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Taranis-x7.zip]
 
|-
 
|-
 
|FrSky Horus:
 
|FrSky Horus:
|[http://www.spirit-system.com/dl/opentx/Spirit-2.2.0-Horus.zip http://www.spirit-system.com/dl/opentx/Spirit-2.2.0-Horus.zip]
+
|[http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Horus.zip http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Horus.zip]
 
|}
 
|}
 
</div>
 
</div>
Line 135: Line 157:
  
 
<translate><!--T:30-->
 
<translate><!--T:30-->
Then unzip the file and copy the „Spirit-­2.2.0“ directory to SD Card of your transmitter.</translate>
+
Then unzip the file and copy the „Spirit-­2.3.0“ (or „Spirit-Aero-1.2.0“ for Aero) directory to SD Card of your transmitter.</translate>
  
 
== <translate><!--T:31-->
 
== <translate><!--T:31-->
Line 143: Line 165:
 
You can access the integration menu whenever you want to configure the unit. When it is opened, it behave similarly as when you start the PC software. This mean that for example Bank Switching will be performed in the menu, not with assigned switch. When script is closed, everything returns to the flight regime.</translate>
 
You can access the integration menu whenever you want to configure the unit. When it is opened, it behave similarly as when you start the PC software. This mean that for example Bank Switching will be performed in the menu, not with assigned switch. When script is closed, everything returns to the flight regime.</translate>
  
{{Quote| <translate><!--T:33-->
 
Do not configure the unit during a flight!</translate>
 
}}
 
  
 
'''<translate><!--T:34-->
 
'''<translate><!--T:34-->
Line 155: Line 174:
 
Click the ''PAGE'' button.</translate>
 
Click the ''PAGE'' button.</translate>
 
#<translate><!--T:37-->
 
#<translate><!--T:37-->
By clicking '''+''' and '''–''' buttons move to the ''„Spirit-2.2.0“'' directory.</translate>
+
By clicking '''+''' and '''–''' buttons move to the ''„Spirit-2.3.0“ (or „Spirit-Aero-1.1.0“ for Aero)'' directory.</translate>
 
#<translate><!--T:38-->
 
#<translate><!--T:38-->
 
Click the ''ENT'' button.</translate>
 
Click the ''ENT'' button.</translate>
 
#<translate><!--T:39-->
 
#<translate><!--T:39-->
Start the ''basic.lua'' or ''special.lua'' script by clicking the ''ENT'' button.</translate>
+
Start the ''basic.lua'' or ''special.lua'' script by holding the ''ENT'' button, then select ''Execute''.</translate>
  
 
'''<translate><!--T:40-->
 
'''<translate><!--T:40-->
Line 169: Line 188:
 
Click the ''PAGE UP'' button to reach the SD CARD page.</translate>
 
Click the ''PAGE UP'' button to reach the SD CARD page.</translate>
 
#<translate><!--T:43-->
 
#<translate><!--T:43-->
By rotary manipulator move to the ''„Spirit-­2.2.0“'' directory.</translate>
+
By rotary manipulator move to the ''„Spirit-­2.3.0“ (or „Spirit-Aero-1.1.0“ for Aero)'' directory.</translate>
 
#<translate><!--T:44-->
 
#<translate><!--T:44-->
 
Click the ''manipulator'' button to enter.</translate>
 
Click the ''manipulator'' button to enter.</translate>
 
#<translate><!--T:45-->
 
#<translate><!--T:45-->
 
Execute the ''basic.lua'' or ''special.lua''.</translate>
 
Execute the ''basic.lua'' or ''special.lua''.</translate>
 +
 +
[[File:horus-execute.png|300px|]]
  
 
== <translate><!--T:46-->
 
== <translate><!--T:46-->
 
Integration Preview</translate> ==
 
Integration Preview</translate> ==
  
<br />
+
<translate><!--T:47-->
[[File:O4.png|center]]
+
FrSky Taranis integration</translate>:
<br />
+
[[File:O5.png|center]]
+
  
<center><translate><!--T:47-->
+
[[File:O4.png]] [[File:O5.png]]
FrSky Taranis integration</translate></center>
+
  
  
[[File:O6.png|center]]
+
FrSky <translate><!--T:48-->
 
+
Horus integration</translate>:
<center>FrSky <translate><!--T:48-->
+
Horus integration</translate></center>
+
  
 +
[[File:O6.png]] [[File:frsky-servos.png]]
  
 
== <translate><!--T:49-->
 
== <translate><!--T:49-->
Line 198: Line 215:
 
*<translate><!--T:50-->
 
*<translate><!--T:50-->
 
If the Menu will not load any parameter value, it is likely that the integration cable is connected improperly. If you use any Telemetry sensor, we recommend to disconnect it (at least from signal line) and verify again.</translate>
 
If the Menu will not load any parameter value, it is likely that the integration cable is connected improperly. If you use any Telemetry sensor, we recommend to disconnect it (at least from signal line) and verify again.</translate>
 
*<translate><!--T:51-->
 
'''MLVSS sensor''' is known to cause interferences on the S.Port line, thus affecting all other sensors including the Integration. We do not recommend to use this sensor at least until the fix will be available.</translate>
 
  
 
*<translate><!--T:52-->
 
*<translate><!--T:52-->
 
If you will see the Lua script error: ''Script syntax error - attempt to call global function sportTelemetry'', then the OpenTX firmware in your transmitter is 2.1 or earlier. Please check the [[OpenTX 2.2]] page for update instructions.</translate>
 
If you will see the Lua script error: ''Script syntax error - attempt to call global function sportTelemetry'', then the OpenTX firmware in your transmitter is 2.1 or earlier. Please check the [[OpenTX 2.2]] page for update instructions.</translate>
 +
 +
== <translate><!--T:63-->
 +
Telemetry data</translate> ==
 +
 +
<translate><!--T:64-->
 +
With this connection the Spirit will not only offer the Integration, but also a various telemetry data.
 +
These data can be displayed on your main screen and even logged during flight.</translate>
 +
 +
<translate><!--T:67-->
 +
Firstly, it is necessary to scan for the new sensors.
 +
Go to '''MENU - Page 13/14 - TELEMETRY''' and press '''Discover new sensors'''. When all variables are discovered, then stop discovery of the sensors.
 +
 +
<!--T:68-->
 +
To add the Telemetry data onto the main screen, go to '''MENU - Page 14/14 - DISPLAY'''.
 +
There you can add any variable you want to be displayed. Variables with +/- character are meant to be maximal/minimal measured values.
 +
 +
<!--T:69-->
 +
Finally, exit to the main screen and press the PAGE button for 1 second.</translate>
 +
 +
<translate><!--T:65-->
 +
With the Spirit firmware 2.4 you are able to view:
 +
* '''RPM''' [RPM] - Current RPM from the [[Configuration#Governor|Governor]].
 +
* '''Fuel''' [%] - Vibrations of the model (Reported as Fuel)
 +
* '''RB1V''' [V] - Main Battery Voltage
 +
* '''RB1A''' [A] - Main Battery Current
 +
* '''RB1C''' [mAh] - Main Battery Consumed Capacity
 +
* '''RB2C''' [V] - BEC Voltage (10x) - ''set Ratio 25.5''
 +
* '''Tmp1''' [°C] - ESC Temperature</translate>
  
 
== <translate><!--T:53-->
 
== <translate><!--T:53-->
Line 227: Line 269:
 
<translate><!--T:59-->
 
<translate><!--T:59-->
 
Do not forget to click the '''Save Settings''' when you want to save a changes permanently.</translate>
 
Do not forget to click the '''Save Settings''' when you want to save a changes permanently.</translate>
 +
  
 
<translate><!--T:60-->
 
<translate><!--T:60-->

Revision as of 08:50, 23 August 2018

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎magyar • ‎italiano • ‎русский
Setup guide
for
O1.png
Integration


Features
Settings directly in the transmitter
Configuration of the unit
No need for computer
Everything quickly accessible

Requirements
OpenTX 2.2 with Lua support
Receiver with S.Port
Integration cable for S.Port




1 Wiring

To enable the Integration, you have to only connect your receiver and unit according to the following scheme. Please note, that to make this possible, you will need special cable that is available in our eshop.

So you will need to connect:

  • FrSky Integration cable
  • S-Bus, PPM or PWM connection to the receiver (same that you used without the integration).

Opentx-cable.jpg

Shorter lead of the cable receiver - S.Port
Longer lead of the cable unit - SYS port


The integration cable is used for bi-­directional data transmission between unit and receiver, respectively transmitter. This include telemetry data and possibility to configure all parameters of the unit, directly from your transmitter.

It is completely separated from basic receiver part that is transmitting the channel data. Thus your existing connection with receiver can be untouched. It can work with PWM, PPM and S­Bus connection types.

Info.png For receiver that has a Molex connector for the S.Port (e.g. X4R, X4R­SB, XSR), please use provided connector and pins so that you can easily connect it to the servo connector.

Info.png S.Port connection alone will not work – it is used only for configuration. Channel data must be transmitted by a conventional protocols such as PWM, PPM or S­Bus.

O2.jpg
Example 1: Connection scheme for the Integration part with X4R­SB receiver
O3.png
Example 2: Optional adapter for X4R, X4R­SB, XSR receivers

2 Installation

Configuration of the unit is accessible throught Lua scripts. These scripts are tailored by Spirit System to allow full integration with the unit. With this integration you can access all the menus and configure any parameter whenever you wish.

To make it work, you have to download and copy the scripts from our web.

Download script for Heli
All FrSky Taranis and Horus radios - ENGLISH: http://www.spirit-system.com/dl/opentx/Spirit-2.5.1-en.zip
All FrSky Taranis and Horus radios - ČESKY: http://www.spirit-system.com/dl/opentx/Spirit-2.5.1-cs.zip

Download script for Aero
FrSky Taranis X9D/X9D+/X9E: http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Taranis-x9.zip
FrSky Taranis Q X7: http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Taranis-x7.zip
FrSky Horus: http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.2.0-Horus.zip

Then unzip the file and copy the „Spirit-­2.3.0“ (or „Spirit-Aero-1.2.0“ for Aero) directory to SD Card of your transmitter.

3 How to open the Menu

You can access the integration menu whenever you want to configure the unit. When it is opened, it behave similarly as when you start the PC software. This mean that for example Bank Switching will be performed in the menu, not with assigned switch. When script is closed, everything returns to the flight regime.


To access the menu on Taranis, press the buttons in the following way:

  1. Press the MENU button for 1 second.
  2. Click the PAGE button.
  3. By clicking + and buttons move to the „Spirit-2.3.0“ (or „Spirit-Aero-1.1.0“ for Aero) directory.
  4. Click the ENT button.
  5. Start the basic.lua or special.lua script by holding the ENT button, then select Execute.

To access the menu on Horus, press the buttons in the following way:

  1. Press the < button for 1 second.
  2. Click the PAGE UP button to reach the SD CARD page.
  3. By rotary manipulator move to the „Spirit-­2.3.0“ (or „Spirit-Aero-1.1.0“ for Aero) directory.
  4. Click the manipulator button to enter.
  5. Execute the basic.lua or special.lua.

Horus-execute.png

4 Integration Preview

FrSky Taranis integration:

O4.png O5.png


FrSky Horus integration:

O6.png Frsky-servos.png

5 Troubleshooting

  • If the Menu will not load any parameter value, it is likely that the integration cable is connected improperly. If you use any Telemetry sensor, we recommend to disconnect it (at least from signal line) and verify again.
  • If you will see the Lua script error: Script syntax error - attempt to call global function sportTelemetry, then the OpenTX firmware in your transmitter is 2.1 or earlier. Please check the OpenTX 2.2 page for update instructions.

6 Telemetry data

With this connection the Spirit will not only offer the Integration, but also a various telemetry data. These data can be displayed on your main screen and even logged during flight.

Firstly, it is necessary to scan for the new sensors. Go to MENU - Page 13/14 - TELEMETRY and press Discover new sensors. When all variables are discovered, then stop discovery of the sensors.

To add the Telemetry data onto the main screen, go to MENU - Page 14/14 - DISPLAY. There you can add any variable you want to be displayed. Variables with +/- character are meant to be maximal/minimal measured values.

Finally, exit to the main screen and press the PAGE button for 1 second.

With the Spirit firmware 2.4 you are able to view:

  • RPM [RPM] - Current RPM from the Governor.
  • Fuel [%] - Vibrations of the model (Reported as Fuel)
  • RB1V [V] - Main Battery Voltage
  • RB1A [A] - Main Battery Current
  • RB1C [mAh] - Main Battery Consumed Capacity
  • RB2C [V] - BEC Voltage (10x) - set Ratio 25.5
  • Tmp1 [°C] - ESC Temperature

7 Usage

Whenever you want to configure a parameter, start the according Lua script. There the Menu Layout is similar with the PC software to have easy navigation.

It is working in the same way as when the PC software is connected. This mean that when the Integration menu is opened, you can change even the basic parameters that could affect the helicopter significantly.

Warning.png Never perform the configuration when flying!

When using the Bank Switching or Real-Time tuning features the menu will take full control of it. The unit will not react to a Switch position changes. For the Bank Switching there is Banks option where you can manually change the banks. Whenever you will change the Bank the configuration will be saved to not loose the current settings.

Info.png When Bank is 1 or 2, some parameters are hidden. In that case some pages appear to be blank.

Do not forget to click the Save Settings when you want to save a changes permanently.


Enjoy the integration!