You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*Some changes in OpenTX 2.2.1 cause this version to have less RAM available for lua scripts than previous versions. The recommendation is for users wanting to update OpenTX on a Taranis X9D (and keep using the Betaflight TX lua scripts) is to use 2.3.1 or higher.*
6
-
7
3
## How to download the scripts
8
4
9
5
Please visit the [releases page](https://github.com/betaflight/betaflight-tx-lua-scripts/releases) to download a zip file containing latest version.
10
6
11
7
## Firmware Considerations
12
8
13
-
- Betaflight - As a best practice, it is recommended to use the most recent stable release of Betaflight to obtain the best possible results.
14
-
- Crossfire - v2.11 or greater
15
-
- FrSky - While most receivers work fine, it's recommended to update the XSR family of receivers to their most recent firmware version to correct any known bugs in SmartPort telemetry.
9
+
- Betaflight - 4.1.0 or newer. As a best practice, it is recommended to use the most recent stable release of Betaflight to obtain the best possible results;
10
+
- OpenTX - 2.3.4 or newer;
11
+
- Crossfire TX / RX - v2.11 or newer;
12
+
- FrSky TX / RX - While most receivers work fine, it's recommended to update the XSR family of receivers to their most recent firmware version to correct any known bugs in SmartPort telemetry.
16
13
17
14
## Installing
18
15
19
16
**!! IMPORTANT: DON'T COPY THE CONTENTS OF THIS REPOSITORY ONTO YOUR SDCARD !!**
20
17
21
-
Unzip the files from the link above and drag the contents to your radio. If you do this correctly, the SCRIPTS directory will merge with your existing directories, placing the scripts in their appropriate paths. You will know if you did this correctly if the bf.lua file shows up in your /SCRIPTS/TELEMETRY directory.
18
+
Unzip the files from the link above and drag the contents to your radio. If you do this correctly, the SCRIPTS directory will merge with your existing directories, placing the scripts in their appropriate paths. You will know if you did this correctly if the `bf.lua` file shows up in your `/SCRIPTS/TOOLS` directory.
22
19
23
20
The src directory is not required for use and is only available for maintenance of the code. While it may work to use this directory, you may encounter memory issues on your transmitter.
24
21
@@ -39,28 +36,18 @@ Manual method (varies, based on the model of your transmitter)
39
36
4. Reinsert your SD card into the transmitter
40
37
5. Power up your transmitter.
41
38
42
-
If you copied the files correctly, you can now go into the OpenTx Tools screen (Since OpenTx 2.3.0) and access the Betaflight Configuration tool, or you can use the telemetry screen setup page and set up the script as telemetry page.
43
-
44
-
### Adding the script as a telemetry page
45
-
46
-
Setting up the script as a telemetry page will enable access at the press of a button. (For now, this only applies to the Taranis X9D series).
39
+
If you copied the files correctly, you can now go into the OpenTx Tools screen from the main menu and access the Betaflight Configuration tool. The first time you run the script, a message 'Compiling...' will appear in the display before the script is started - this is normal, and is done to minimise the RAM usage of the script.
47
40
48
-
1. Hit the [MENU] button and select the model for which you would like to enable the script.
49
-
2. While on the [MODEL SELECTION] screen, long-press the [PAGE] button to navigate to the [DISPLAY] page.
50
-
3. Use the [-] button to move the cursor down to [Screen 1] and hit [ENT].
51
-
4. Use the [+] or [-] buttons to select the [Script] option and press [ENT].
52
-
5. Press [-] to move the cursor to the script selection field and hit [ENT].
53
-
6. Select 'bf' and hit [ENT].
54
-
7. Long-press [EXIT] to return to your model screen.
41
+
### Running the script as a telemetry page
55
42
56
-
To invoke the script, simply long-press the [PAGE] button from the model screen.
43
+
Due to issues with input mapping and memory overruns, running the script as a telemetry page **is no longer supported**. The only way to run the script is through the Tools screen in the OpenTX main menu.
57
44
58
45
### Setting up VTX Tables
59
46
60
-
If you are using a VTX that supports the SmartAudio or Tramp protocols then bands and channels etc. are managed using vtx tables since firmware version 4.1.0. The betaflight configurator will allow you to save your configuration to a _craftname_.lua file. Place this into the BF\VTX folder on the root of the SD card and rename it to match the model you use on your transmitter for this craft. The lua scrips will then use this information on the VTX configuration screen instead of the defaults.
47
+
If you are using a VTX that supports the SmartAudio or Tramp protocols then bands and channels etc. are managed using VTX tables since Betaflight version 4.1.0. The script will be downloading and storing the current VTX table for every model the first time the model is connected and the script is run. If you change the VTX table, you have to re-load the updated VTX table in the script, by choosing the 'vtx tables' option in the function menu.
61
48
62
49
## Building from source
63
50
64
-
- Be sure to have `LUA 5.2` installed in the path
65
-
- Run `./bin/build.sh` from the root folder
66
-
-Compiled files will be created a the `obj` in the root folder. Copy the files to your transmitter as instructed in the `Installing` section below as if you unzipped from a downloaded file.
51
+
- Be sure to have `make` and `luac` in version 5.2 installed in the path
52
+
- Run `make` from the root folder
53
+
-The installation files will be created a the `obj` in the root folder. Copy the files to your transmitter as instructed in the '[Installing](#installing)' section below as if you unzipped from a downloaded file.
0 commit comments