!! IMPORTANT: DON'T COPY THE CONTENTS OF THIS REPOSITORY ONTO YOUR SDCARD !!
Download a zip file containing the latest version from the releases page.
Unzip the files from the link above and drag the contents of the obj
folder to your radios SD card. 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.
Navigate to the TOOLS menu in OpenTX, select "Betaflight setup" or "Betaflight CMS" and press the [ENTER] button. The first time the script is launched after a clean install or upgrade it will go through it's compile procedure and exit back to the TOOLS menu when it's done.
The "Betaflight setup" script lets you configure Betaflight through the MSP protocol.
Any changes to parameters in the script will not take effect until a save is manually initiated. Change the parameters you want to change, open the function menu by long pressing [ENTER] and select "save page" to send the modified parameters back to the flight controller.
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.
Depending on the size of the vtx tables and the telemetry protocol used, downloading the vtx tables can take a while.
Please note that if the "VTX" feature wasn't included in your Betaflight firmware build, the downloading of the VTX tables will be skipped and the VTX menu item won't be available. The initial setup of the VTX/VTX tables must be done using the Configurator.
!! IMPORTANT: TBS Crossfire/Tracer only !!
"Betaflight CMS" lets you access the same CMS menu that is available in the OSD.
The optional background script offers RTC synchronization and RSSI through MSP. RSSI will only be sent if no other RSSI source is detected. It can be setup as a special or global function in OpenTX. The image below shows how to run the background script as a special function.
Unstable testing versions of the latest builds of the Lua Script can be downloaded from here.
Be aware that these versions are intended for testing / feedback only, and may be buggy or broken. Caution is advised when using these versions.
make
and luac
in version 5.2 installed in the pathmake
from the root folderobj
folder. Copy the files to your transmitter as instructed in the 'Installing' section as if you unzipped from a downloaded file.