Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 3.18 KB

README.md

File metadata and controls

53 lines (33 loc) · 3.18 KB
Raw

betaflight-tx-lua-scripts

How to download the scripts

Please visit the releases page to download a zip file containing latest version.

Firmware Considerations

  • 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;
  • OpenTX - 2.3.4 or newer;
  • Crossfire TX / RX - v2.11 or newer;
  • 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.

Installing

!! IMPORTANT: DON'T COPY THE CONTENTS OF THIS REPOSITORY ONTO YOUR SDCARD !!

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.

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.

How to install

Bootloader Method

  1. Power off your transmitter and power it back on in boot loader mode.
  2. Connect a USB cable and open the SD card drive on your computer.
  3. Unzip the file and copy the scripts to the root of the SD card.
  4. Unplug the USB cable and power cycle your transmitter.

Manual method (varies, based on the model of your transmitter)

  1. Power off your transmitter.
  2. Remove the SD card and plug it into a computer
  3. Unzip the file and copy the scripts to the root of the SD card.
  4. Reinsert your SD card into the transmitter
  5. Power up your transmitter.

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.

Running the script as a telemetry page

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.

Setting up VTX Tables

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.

Building from source

  • Be sure to have make and luac in version 5.2 installed in the path
  • Run make from the root folder
  • The installation 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.