Difference between revisions of "OpenTX Integration"
From Spirit System Manual
| Line 1: | Line 1: | ||
| − | + | <languages /> | |
<div id="up"></div> | <div id="up"></div> | ||
<div align=center><font size="6"> | <div align=center><font size="6"> | ||
| − | Setup guide</font></div> | + | <translate>Setup guide</translate></font></div> |
<div align=center><font size="5"> | <div align=center><font size="5"> | ||
for</font></div> | for</font></div> | ||
[[File:O1.png|center|128px]] | [[File:O1.png|center|128px]] | ||
| − | <div align=center><font size="4">Integration</font> | + | <div align=center><font size="4"><translate>Integration</translate></font> |
</div> | </div> | ||
| − | <center><font size="4">'''Features'''</font></center> | + | <center><font size="4">'''<translate>Features</translate>'''</font></center> |
<div align=center> | <div align=center> | ||
| Line 18: | Line 18: | ||
|- | |- | ||
|◦ | |◦ | ||
| − | |Settings directly in the transmitter | + | |<translate>Settings directly in the transmitter</translate> |
|- | |- | ||
|◦ | |◦ | ||
| − | |Configuration of the unit | + | |<translate>Configuration of the unit</translate> |
|- | |- | ||
|◦ | |◦ | ||
| − | |No need for computer | + | |<translate>No need for computer</translate> |
|- | |- | ||
|◦ | |◦ | ||
| − | |Everything quickly accessible | + | |<translate>Everything quickly accessible</translate> |
|} | |} | ||
</div> | </div> | ||
<p></p> | <p></p> | ||
| − | <center>'''<font size="4">Requirements</font>'''</center> | + | <center>'''<font size="4"><translate>Requirements</translate></font>'''</center> |
<div align=center> | <div align=center> | ||
| Line 37: | Line 37: | ||
|- | |- | ||
|◦ | |◦ | ||
| − | |[[OpenTX 2.2]] with Lua support | + | |[[OpenTX 2.2]] <translate>with Lua support</translate> |
|- | |- | ||
|◦ | |◦ | ||
| − | |Receiver with S.Port | + | |<translate>Receiver with S.Port</translate> |
|- | |- | ||
|◦ | |◦ | ||
| − | |Integration cable for S.Port | + | |<translate>Integration cable for S.Port</translate> |
|} | |} | ||
</div> | </div> | ||
| Line 52: | Line 52: | ||
| − | == Wiring == | + | == <translate>Wiring</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>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> |
[[File:opentx-cable.jpg]] | [[File:opentx-cable.jpg]] | ||
| Line 60: | Line 60: | ||
:{| style="width: 35%;" | :{| style="width: 35%;" | ||
|- | |- | ||
| − | | style="width: 60%;"|'''Shorter lead''' of the cable | + | | style="width: 60%;"|<translate>'''Shorter lead''' of the cable |
| − | |receiver - '''S.Port''' | + | |receiver</translate> - '''S.Port''' |
|- | |- | ||
| − | | style="width: 60%;"|'''Longer lead''' of the cable | + | | style="width: 60%;"|<translate>'''Longer lead''' of the cable |
| − | |unit - '''SYS port''' | + | |unit</translate> - '''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. | + | <translate>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.</translate> |
| − | It is completely separated from basic receiver part that is transmitting the channel data. Thus your existing connection with receiver can be untouched. | + | <translate>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 SBus connection types. | + | It can work with PWM, PPM and SBus connection types.</translate> |
| − | {{Info|[[File:Info.png|18px]] For receiver that has a Molex connector for the S.Port (e.g. X4R, X4RSB, XSR), please use provided connector and pins so that you can easily connect it to the servo connector. | + | {{Info|[[File:Info.png|18px]] <translate>For receiver that has a Molex connector for the S.Port (e.g. X4R, X4RSB, XSR), please use provided connector and pins so that you can easily connect it to the servo connector.</translate> |
}} | }} | ||
<p></p> | <p></p> | ||
| − | {{Info|[[File:Info.png|18px]] 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 SBus. | + | {{Info|[[File:Info.png|18px]] <translate>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 SBus.</translate> |
}} | }} | ||
[[File:O2.jpg|class=halfwidth|center]] | [[File:O2.jpg|class=halfwidth|center]] | ||
| − | <center>'''''Example 1:''' Connection scheme for the Integration part with X4RSB receiver''</center> | + | <center>'''''<translate>Example 1:</translate>''' <translate>Connection scheme for the Integration part with X4RSB receiver</translate>''</center> |
[[File:O3.png|class=halfwidth|center]] | [[File:O3.png|class=halfwidth|center]] | ||
| − | <center>'''''Example 2:''' Optional adapter for X4R, X4RSB, XSR receivers''</center> | + | <center>'''''<translate>Example 2:</translate>''' <translate>Optional adapter for X4R, X4RSB, XSR receivers</translate>''</center> |
| − | == Installation == | + | == <translate>Installation</translate> == |
| − | 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. | + | <translate>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.</translate> |
| − | To make it work, you have to download and copy the scripts from our web. | + | <translate>To make it work, you have to download and copy the scripts from our web.</translate> |
<div align=center> | <div align=center> | ||
{| 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; "| '''For Heli''' | + | | colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center; "| '''<translate>For Heli</translate>''' |
|- | |- | ||
|FrSky Taranis X9D/X9D+/X9E: | |FrSky Taranis X9D/X9D+/X9E: | ||
| Line 107: | Line 107: | ||
<div align=center> | <div align=center> | ||
{| 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;" | ''' For Spirit Aero''' | + | | colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center;" | ''' <translate>For Spirit Aero</translate>''' |
|- | |- | ||
|FrSky Taranis X9D/X9D+/X9E: | |FrSky Taranis X9D/X9D+/X9E: | ||
| Line 118: | Line 118: | ||
| − | 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.2.0“ directory to SD Card of your transmitter.</translate> |
| − | == How to open the Menu == | + | == <translate>How to open the Menu</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>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| Do not configure the unit during a flight! | + | {{Quote| <translate>Do not configure the unit during a flight!</translate> |
}} | }} | ||
| − | '''To access the menu on Taranis, press the buttons in the following way:''' | + | '''<translate>To access the menu on Taranis, press the buttons in the following way:</translate>''' |
| − | #Press the ''MENU'' button for 1 second. | + | #<translate>Press the ''MENU'' button for 1 second.</translate> |
| − | #Click the ''PAGE'' button. | + | #<translate>Click the ''PAGE'' button.</translate> |
| − | #By clicking '''+''' and '''–''' buttons move to the ''„Spirit-2.2.0“'' directory. | + | #<translate>By clicking '''+''' and '''–''' buttons move to the ''„Spirit-2.2.0“'' directory.</translate> |
| − | #Click the ''ENT'' button. | + | #<translate>Click the ''ENT'' button.</translate> |
| − | #Start the ''basic.lua'' or ''special.lua'' script by clicking the ''ENT'' button. | + | #<translate>Start the ''basic.lua'' or ''special.lua'' script by clicking the ''ENT'' button.</translate> |
| − | '''To access the menu on Horus, press the buttons in the following way:''' | + | '''<translate>To access the menu on Horus, press the buttons in the following way:</translate>''' |
| − | #Press the '''<''' button for 1 second. | + | #<translate>Press the '''<''' button for 1 second.</translate> |
| − | #Click the ''PAGE UP'' button to reach the SD CARD page. | + | #<translate>Click the ''PAGE UP'' button to reach the SD CARD page.</translate> |
| − | #By rotary manipulator move to the ''„Spirit-2.2.0“'' directory. | + | #<translate>By rotary manipulator move to the ''„Spirit-2.2.0“'' directory.</translate> |
| − | #Click the ''manipulator'' button to enter. | + | #<translate>Click the ''manipulator'' button to enter.</translate> |
| − | #Execute the ''basic.lua'' or ''special.lua''. | + | #<translate>Execute the ''basic.lua'' or ''special.lua''.</translate> |
| − | == Integration Preview == | + | == <translate>Integration Preview</translate> == |
<br /> | <br /> | ||
| Line 150: | Line 150: | ||
[[File:O5.png|center]] | [[File:O5.png|center]] | ||
| − | <center>FrSky Taranis integration</center> | + | <center><translate>FrSky Taranis integration</translate></center> |
[[File:O6.png|center]] | [[File:O6.png|center]] | ||
| − | <center>FrSky Horus integration</center> | + | <center>FrSky <translate>Horus integration</translate></center> |
| − | == Troubleshooting == | + | == <translate>Troubleshooting</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>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> |
| − | *'''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>'''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> |
| − | *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> |
| − | == Usage == | + | == <translate>Usage</translate> == |
| − | Whenever you want to configure a parameter, start the according Lua script. | + | <translate>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. | + | There the Menu Layout is similar with the PC software to have easy navigation.</translate> |
| − | 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. | + | <translate>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.</translate> |
| − | {{Quote|'''Never perform the configuration when flying!'''}} | + | {{Quote|'''<translate>Never perform the configuration when flying!</translate>'''}} |
| − | 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. | + | <translate>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. | + | 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.</translate> |
| − | {{Info|[[File:Info.png|18px]] When Bank is 1 or 2, some parameters are hidden. In that case some pages appear to be blank.}} | + | {{Info|[[File:Info.png|18px]] <translate>When Bank is 1 or 2, some parameters are hidden. In that case some pages appear to be blank.</translate>}} |
| − | 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> |
| − | Enjoy the integration! | + | <translate>Enjoy the integration!</translate> |
| Line 189: | Line 189: | ||
{|style="width: 100%;color: white;text-align:center;" | {|style="width: 100%;color: white;text-align:center;" | ||
| − | |[[#up|↑Up↑]] | + | |[[#up|↑<translate>Up</translate>↑]] |
|} | |} | ||
---- | ---- | ||
</div> | </div> | ||
Revision as of 12:36, 12 January 2017
Setup guide
for
Integration
| ◦ | Settings directly in the transmitter |
| ◦ | Configuration of the unit |
| ◦ | No need for computer |
| ◦ | Everything quickly accessible |
| ◦ | OpenTX 2.2 with Lua support |
| ◦ | Receiver with S.Port |
| ◦ | Integration cable for S.Port |
Contents
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.
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 SBus connection types.
For receiver that has a Molex connector for the S.Port (e.g. X4R, X4RSB, XSR), please use provided connector and pins so that you can easily connect it to the servo connector.
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.
| For Heli | |
| FrSky Taranis X9D/X9D+/X9E: | http://www.spirit-system.com/dl/opentx/Spirit-2.2.0-Taranis.zip |
| FrSky Horus: | http://www.spirit-system.com/dl/opentx/Spirit-2.2.0-Horus.zip |
| For Spirit Aero | |
| FrSky Taranis X9D/X9D+/X9E: | http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.0.0-Taranis.zip |
| FrSky Horus: | http://www.spirit-system.com/dl/opentx/Spirit-Aero-1.0.0-Horus.zip |
Then unzip the file and copy the „Spirit-2.2.0“ 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.
Do not configure the unit during a flight!
To access the menu on Taranis, press the buttons in the following way:
- Press the MENU button for 1 second.
- Click the PAGE button.
- By clicking + and – buttons move to the „Spirit-2.2.0“ directory.
- Click the ENT button.
- Start the basic.lua or special.lua script by clicking the ENT button.
To access the menu on Horus, press the buttons in the following way:
- Press the < button for 1 second.
- Click the PAGE UP button to reach the SD CARD page.
- By rotary manipulator move to the „Spirit-2.2.0“ directory.
- Click the manipulator button to enter.
- Execute the basic.lua or special.lua.
4 Integration Preview
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.
- 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.
- 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 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.
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.
Do not forget to click the Save Settings when you want to save a changes permanently.
Enjoy the integration!
