Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 5.49 KB

README.md

File metadata and controls

107 lines (70 loc) · 5.49 KB
Raw

Rotorflight Lua Scripts

Rotorflight is a Flight Control software suite designed for single-rotor helicopters. It consists of:

  • Rotorflight Flight Controller Firmware
  • Rotorflight Configurator, for flashing and configuring the flight controller
  • Rotorflight Blackbox Explorer, for analyzing blackbox flight logs
  • Rotorflight Lua Scripts, for configuring the flight controller using a transmitter running:
    • EdgeTX/OpenTX (this repository)
    • Ethos

Built on Betaflight 4.3, Rotorflight incorporates numerous advanced features specifically tailored for helicopters. It's important to note that Rotorflight does not support multi-rotor crafts or airplanes; it's exclusively designed for RC helicopters.

This version of Rotorflight is also known as Rotorflight 2 or RF2.

Information

Tutorials, documentation, and flight videos can be found on the Rotorflight website.

Lua Scripts Requirements

  • EdgeTX 2.5.0 or OpenTX 2.3.12 or later transmitter firmware
  • A receiver supporting remote configuration:
    • a FrSky Smartport or F.Port receiver, or
    • a Crossfire v2.11 or newer receiver, or
    • an ELRS 2.0.1 or newer receiver

Important

If you're using ELRS, make sure to set the baudrate to 921k in the Hardware menu of your transmitter.

Installation

Please download the latest version from GitHub and copy the contents of the SCRIPTS folder to your transmitter. You will know that you've done it correctly when you find the rf2.lua file located in the /SCRIPTS/TOOLS directory. Plus, you should now see Rotorflight 2 listed in the Tools menu of your transmitter.

Copying the SCRIPTS folder

USB Method

  1. Connect your transmitter to a computer with an USB cable
  2. Open the new drive on your computer
  3. Unzip the file and copy the SCRIPTS folder to the root the new drive
  4. Eject the drive
  5. Unplug the USB cable

SD Card Method

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

If you copied the files correctly, you can now go into the Tools menu on your transmitter and access the Rotorflight 2 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.

Usage

See the Lua Scripts page.

Background script

The optional background script rf2bg.lua features Real Time FC Clock synchronization and the Adjustment Teller.

  • RTC synchronization will send the time of the transmitter to the flight controller. The script will beep if RTC synchronization has been completed. Blackbox logs and files created by the FC will now have the correct timestamp.
  • The Adjustment Teller will tell you what adjustment you just made. It supports all adjustments except profile adjustments.
    • S.port/F.port: the telemetry sensors 5110 and 5111 should be available. Discover or add them if they aren't.
    • CRSF: the telemetry sensor FM should be available. Also do a set crsf_flight_mode_reuse = ADJFUNC in the CLI and save.

The background script can be configured as either a special or global function in EdgeTX/OpenTX. The image below illustrates how to set up the background script as a special function. This configuration ensures that the script runs automatically as soon as the model is selected.

Background script setup

Building from source on Linux

  • 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 in the obj folder. Copy the files to your transmitter as instructed in the Installation section as if you unzipped from a downloaded file.

Contributing

Rotorflight is an open-source community project. Anybody can join in and help to make it better by:

  • Helping other users on Rotorflight Discord or other online forums
  • Reporting bugs and issues, and suggesting improvements
  • Testing new software versions, new features and fixes; and providing feedback
  • Participating in discussions on new features
  • Create or update content on the Website
  • Contributing to the software development - fixing bugs, implementing new features and improvements
  • Translating Rotorflight Configurator into a new language, or helping to maintain an existing translation

Origins

Rotorflight is software that is open source and is available free of charge without warranty.

Rotorflight is forked from Betaflight, which in turn is forked from Cleanflight. Rotorflight borrows ideas and code also from HeliFlight3D, another Betaflight fork for helicopters.

Big thanks to everyone who has contributed along the journey!

Contact

Team Rotorflight can be contacted by email at [email protected].