Difference between revisions of "OpenTX Integration"
(83 intermediate revisions by 2 users not shown) | |||
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><!--T:1--> |
+ | Setup guide</translate></font></div> | ||
<div align=center><font size="5"> | <div align=center><font size="5"> | ||
− | for</font></div> | + | <translate><!--T:2--> |
− | [[File:O1.png|center]] | + | for</translate></font></div> |
− | <div align=center><font size="4">Integration</font> | + | [[File:O1.png|center|128px]] |
+ | <div align=center><font size="4"><translate><!--T:3--> | ||
+ | Integration</translate></font> | ||
</div> | </div> | ||
− | |||
− | |||
− | <center><font size="4">'''Features'''</font></center> | + | |
+ | <center><font size="4">'''<translate><!--T:4--> | ||
+ | Features</translate>'''</font></center> | ||
<div align=center> | <div align=center> | ||
Line 19: | Line 22: | ||
|- | |- | ||
|◦ | |◦ | ||
− | |Settings directly in the transmitter | + | |<translate><!--T:5--> |
+ | Settings directly in the transmitter</translate> | ||
|- | |- | ||
|◦ | |◦ | ||
− | |Configuration of the unit | + | |<translate><!--T:6--> |
+ | Configuration of the unit</translate> | ||
|- | |- | ||
|◦ | |◦ | ||
− | |No need for computer | + | |<translate><!--T:7--> |
+ | No need for computer</translate> | ||
|- | |- | ||
|◦ | |◦ | ||
− | |Everything quickly accessible | + | |<translate><!--T:8--> |
+ | Everything quickly accessible</translate> | ||
|} | |} | ||
</div> | </div> | ||
<p></p> | <p></p> | ||
− | <center>'''<font size="4">Requirements</font>'''</center> | + | <center>'''<font size="4"><translate><!--T:9--> |
+ | Requirements</translate></font>'''</center> | ||
<div align=center> | <div align=center> | ||
Line 38: | Line 46: | ||
|- | |- | ||
|◦ | |◦ | ||
− | |[[OpenTX 2.2]] with Lua support | + | |<translate><!--T:66--> |
+ | [[OpenTX 2.2]]</translate> or <translate><!--T:78--> | ||
+ | [[EdgeTX]]</translate> <translate><!--T:10--> | ||
+ | with Lua support</translate> | ||
|- | |- | ||
|◦ | |◦ | ||
− | |Receiver with S.Port | + | |<translate><!--T:11--> |
+ | Receiver with S.Port</translate> | ||
|- | |- | ||
|◦ | |◦ | ||
− | |Integration cable for S.Port | + | |<translate><!--T:12--> |
+ | Integration cable for S.Port - <font color=red>Not needed for '''Spirit GT'''</font></translate> | ||
|} | |} | ||
</div> | </div> | ||
Line 53: | Line 66: | ||
− | == | + | == <translate><!--T:13--> |
+ | Wiring</translate> == | ||
− | + | === Spirit 1, Spirit 2, Spirit Pro === | |
− | :{| style="width: | + | <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> | ||
+ | |||
+ | '''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]] | ||
+ | |||
+ | :{| style="width: 40%;" | ||
|- | |- | ||
− | | style="width: | + | | style="width: 55%;"|<translate><!--T:15--> |
− | | | + | '''Shorter lead''' of the cable |
+ | |receiver</translate> - '''S.Port''' | ||
|- | |- | ||
− | | style="width: | + | | style="width: 55%;"|<translate><!--T:16--> |
− | | | + | '''Longer lead''' of the cable |
+ | |unit</translate> - '''SYS port''' | ||
|} | |} | ||
− | |||
+ | <translate><!--T:17--> | ||
+ | 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> | ||
+ | |||
+ | <translate><!--T:18--> | ||
It is completely separated from basic receiver part that is transmitting the channel data. Thus your existing connection with receiver can be untouched. | 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><!--T:19--> |
+ | 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><!--T:20--> |
+ | 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| | + | [[File:O2.jpg|500px|center]] |
− | <center>'''''Example 1:''' Connection scheme for the Integration part with X4RSB receiver''</center> | + | <center>'''''<translate><!--T:21--> |
+ | Example 1:</translate>''' <translate><!--T:22--> | ||
+ | Connection scheme for the Integration part with X4RSB receiver</translate>''</center> | ||
− | [[File:O3.png| | + | [[File:O3.png|500px|center]] |
− | <center>'''''Example 2:''' Optional adapter for X4R, X4RSB, XSR receivers''</center> | + | <center>'''''<translate><!--T:23--> |
+ | Example 2:</translate>''' <translate><!--T:24--> | ||
+ | Optional adapter for X4R, X4RSB, XSR receivers</translate>''</center> | ||
− | == | + | === Spirit GT === |
− | + | [[File:frsky-gt-cable.jpg|class=halfwidth|center]] | |
− | To make it work, you have to download and copy the scripts from our web. | + | <center>'''<translate><!--T:74--> |
+ | Example 3:</translate>''' <translate><!--T:75--> | ||
+ | It is enough to use a normal servo cable with red wire disconnected.</translate>''</center> | ||
+ | |||
+ | [[File:frsky-gt.jpg|500px|center]] | ||
+ | |||
+ | <center>'''<translate><!--T:76--> | ||
+ | Example 4:</translate>''' <translate><!--T:77--> | ||
+ | Wiring for S-BUS and S.PORT with FrSky receiver</translate>''</center> | ||
+ | |||
+ | == <translate><!--T:25--> | ||
+ | Installation</translate> == | ||
+ | |||
+ | <translate><!--T:26--> | ||
+ | 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> | ||
+ | |||
+ | <translate><!--T:27--> | ||
+ | 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; "| ''' | + | | colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center; "| '''<translate><!--T:28--> |
+ | Download script for Heli</translate>''' | ||
|- | |- | ||
− | |FrSky Taranis | + | |<translate><!--T:70--> |
− | |[ | + | All FrSky Taranis and Horus radios - '''ENGLISH'''</translate>: |
+ | |[https://www.spirit-system.com/dl/opentx/Spirit-3.7.0-en.zip https://www.spirit-system.com/dl/opentx/Spirit-3.7.0-en.zip] | ||
|- | |- | ||
− | |FrSky Horus: | + | |<translate><!--T:71--> |
− | |[ | + | All FrSky Taranis and Horus radios - '''ČESKY'''</translate>: |
+ | |[https://www.spirit-system.com/dl/opentx/Spirit-3.7.0-cs.zip https://www.spirit-system.com/dl/opentx/Spirit-3.7.0-cs.zip] | ||
|} | |} | ||
</div> | </div> | ||
Line 105: | Line 159: | ||
<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;" | ''' | + | | colspan="2" style="background-color: orange;color:white;border-radius: 8px;text-align:center; "| '''<translate> |
+ | <!--T:62--> | ||
+ | Download script for Aero</translate>''' | ||
|- | |- | ||
− | |FrSky Taranis | + | |<translate><!--T:72--> |
− | |[ | + | All FrSky Taranis and Horus radios - '''ENGLISH'''</translate>: |
+ | |[https://www.spirit-system.com/dl/opentx/Spirit-Aero-1.5.1-en.zip https://www.spirit-system.com/dl/opentx/Spirit-Aero-1.5.1-en.zip] | ||
|- | |- | ||
− | |FrSky Horus: | + | |<translate><!--T:73--> |
− | |[ | + | All FrSky Taranis and Horus radios - '''ČESKY'''</translate>: |
+ | |[https://www.spirit-system.com/dl/opentx/Spirit-Aero-1.5.1-cs.zip https://www.spirit-system.com/dl/opentx/Spirit-Aero-1.5.1-cs.zip] | ||
|} | |} | ||
</div> | </div> | ||
+ | <p></p> | ||
+ | <translate><!--T:30--> | ||
+ | Then unzip the file and copy the „Spirit-3.7.0“ (or „Spirit-Aero-1.5.1“ for Aero) directory to SD Card of your transmitter.</translate> | ||
− | + | == <translate><!--T:31--> | |
+ | How to open the Menu</translate> == | ||
− | + | <translate><!--T:32--> | |
+ | 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> | ||
− | |||
− | + | '''<translate><!--T:34--> | |
− | + | To access the menu on Taranis, press the buttons in the following way:</translate>''' | |
− | ''' | + | #<translate><!--T:35--> |
+ | Press the ''MENU'' button for 1 second.</translate> | ||
+ | #<translate><!--T:36--> | ||
+ | Click the ''PAGE'' button.</translate> | ||
+ | #<translate><!--T:37--> | ||
+ | By clicking '''+''' and '''–''' buttons move to the ''„Spirit-3.3.0“ (or „Spirit-Aero-1.5.0“ for Aero)'' directory.</translate> | ||
+ | #<translate><!--T:38--> | ||
+ | Click the ''ENT'' button.</translate> | ||
+ | #<translate><!--T:39--> | ||
+ | Start the ''basic.lua'' or ''special.lua'' script by holding the ''ENT'' button, then select ''Execute''.</translate> | ||
− | + | '''<translate><!--T:40--> | |
− | + | To access the menu on Horus, press the buttons in the following way:</translate>''' | |
− | + | ||
− | + | ||
− | + | ||
− | ''' | + | #<translate><!--T:41--> |
+ | Press the '''<''' button for 1 second.</translate> | ||
+ | #<translate><!--T:42--> | ||
+ | Click the ''PAGE UP'' button to reach the SD CARD page.</translate> | ||
+ | #<translate><!--T:43--> | ||
+ | By rotary manipulator move to the ''„Spirit-3.3.0“ (or „Spirit-Aero-1.5.0“ for Aero)'' directory.</translate> | ||
+ | #<translate><!--T:44--> | ||
+ | Click the ''manipulator'' button to enter.</translate> | ||
+ | #<translate><!--T:45--> | ||
+ | Execute the ''basic.lua'' or ''special.lua''.</translate> | ||
− | + | [[File:horus-execute.png|300px|]] | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | == | + | == <translate><!--T:46--> |
+ | Integration Preview</translate> == | ||
− | < | + | <translate><!--T:47--> |
− | + | FrSky Taranis integration</translate>: | |
− | < | + | |
− | + | ||
− | + | [[File:O4.png]] [[File:O5.png]] | |
− | + | FrSky <translate><!--T:48--> | |
+ | Horus integration</translate>: | ||
− | < | + | [[File:O6.png]] [[File:frsky-servos.png]] |
+ | |||
+ | == <translate><!--T:49--> | ||
+ | Troubleshooting</translate> == | ||
+ | |||
+ | *<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> | ||
+ | |||
+ | *<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> | ||
+ | |||
+ | == <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 | ||
+ | * '''5120''' [μs] - Throttle PWM Value</translate> | ||
+ | |||
+ | == <translate><!--T:53--> | ||
+ | Usage</translate> == | ||
+ | |||
+ | <translate><!--T:54--> | ||
+ | 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.</translate> | ||
+ | |||
+ | <translate><!--T:55--> | ||
+ | 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|'''<translate><!--T:56--> | ||
+ | Never perform the configuration when flying!</translate>'''}} | ||
+ | |||
+ | <translate><!--T:57--> | ||
+ | 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.</translate> | ||
+ | |||
+ | {{Info|[[File:Info.png|18px]] <translate><!--T:58--> | ||
+ | When Bank is 1 or 2, some parameters are hidden. In that case some pages appear to be blank.</translate>}} | ||
+ | |||
+ | <translate><!--T:59--> | ||
+ | Do not forget to click the '''Save Settings''' when you want to save a changes permanently.</translate> | ||
+ | |||
+ | |||
+ | <translate><!--T:60--> | ||
+ | Enjoy the integration!</translate> | ||
Line 160: | Line 298: | ||
{|style="width: 100%;color: white;text-align:center;" | {|style="width: 100%;color: white;text-align:center;" | ||
− | |[[#up|↑Up↑]] | + | |[[#up|↑<translate><!--T:61--> |
+ | Up</translate>↑]] | ||
|} | |} | ||
---- | ---- | ||
</div> | </div> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Latest revision as of 13:37, 6 June 2024
◦ | Settings directly in the transmitter |
◦ | Configuration of the unit |
◦ | No need for computer |
◦ | Everything quickly accessible |
◦ | OpenTX 2.2 or EdgeTX with Lua support |
◦ | Receiver with S.Port |
◦ | Integration cable for S.Port - Not needed for Spirit GT |
Contents
1 Wiring
1.1 Spirit 1, Spirit 2, Spirit Pro
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).
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.
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.
1.2 Spirit GT
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: | https://www.spirit-system.com/dl/opentx/Spirit-3.7.0-en.zip |
All FrSky Taranis and Horus radios - ČESKY: | https://www.spirit-system.com/dl/opentx/Spirit-3.7.0-cs.zip |
Download script for Aero | |
All FrSky Taranis and Horus radios - ENGLISH: | https://www.spirit-system.com/dl/opentx/Spirit-Aero-1.5.1-en.zip |
All FrSky Taranis and Horus radios - ČESKY: | https://www.spirit-system.com/dl/opentx/Spirit-Aero-1.5.1-cs.zip |
Then unzip the file and copy the „Spirit-3.7.0“ (or „Spirit-Aero-1.5.1“ 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:
- Press the MENU button for 1 second.
- Click the PAGE button.
- By clicking + and – buttons move to the „Spirit-3.3.0“ (or „Spirit-Aero-1.5.0“ for Aero) directory.
- Click the ENT button.
- 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:
- Press the < button for 1 second.
- Click the PAGE UP button to reach the SD CARD page.
- By rotary manipulator move to the „Spirit-3.3.0“ (or „Spirit-Aero-1.5.0“ for Aero) directory.
- Click the manipulator button to enter.
- Execute the basic.lua or special.lua.
4 Integration Preview
FrSky Taranis integration:
FrSky Horus integration:
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
- 5120 [μs] - Throttle PWM Value
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.
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.
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!