Skip to content

6 Customization

Jump to bottom
Alessandro Apostoli edited this page Jul 13, 2020 · 6 revisions

Customization

When the Yaapu FrskyGCS script begins it first identifies the vehicle type. It then loads several pre-created default pages for that vehicle type stored in the SCRIPTS/TOOLS/yaapu subdirectory.

For any vehicle type it will load files named:

  • default_commands.lua
  • default_params.lua

Then files matching the vehicle type:

  • <vehicle frametype>_params_x.lua (copter_params_1.lua, plane_params_1.lua, etc)
  • <vehicle frametype>_tune.lua (copter_tune.lua, plane_tune.lua, etc)
  • <vehicle frametype>_commands_x.lua (copter_commands_1.lua, plane_commands_1.lua, etc)

Note: plane will load not only plane files but qplane files if a QuadPlane is enabled; and copter will also load heli files if a heli frame.

In addition, it will look for pages in the MODELS/yaapu subdirectory for Taranis type transmitters, or the SCRIPTS/YAAPU/CFG directory for Horus types, with file names in these formats:

  • <this model's name>params_x.lua (mymodel_params_1, etc)
  • <this model's name>_commands_x.lua (mymodel_commands_1, etc)

and display them in addition to the default pages, allowing customization on per model basis.

Creating a new custom page of parameters

A Windows utility is provided: LuaGSCGUI.exe which allows the creation and saving of custom parameter pages (you cannot customize command pages since there are only these commands possible in Yaapu GCS) . You can also load and edit an existing .lua parameter file.

The group of parameters desired is selected and then saved in a .lua file. This file should be named to match one of the naming conventions shown above.

Multiple files can be created. Add the file(s) to the SCRIPTS/TOOLS/yaapu or MODELS/yaapu directory on Taranis class radios or to the /SCRIPTS/YAAPU/CFG directory on Horus radios.

Tutorial video:

IMAGE ALT TEXT HERE

Next these files must be compiled. Execute the luagcs_compiler.lua script in the /SCRIPTS directory.

At this point everything is ready for use.

Additional Information

  • do not add more than 12 parameters to a Taranis/QX7 custom page due to memory limitations of those radios
  • if you add parameters that are not active, ie Quadplane, RSSI, OSD,etc. params when not enabled in the vehicle it causes no problem, they will just not be populated with a value. However, the script will periodically re-attempt to download and display them as long as it is running.
  • you may remove a default page from the SCRIPTS/TOOLS/yaapu directory if you do not want it
  • After you create a new model, if you run the luagcs_compiler.lua script in the /SCRIPTS directory, it will create empty files, appropriately named for that model. You can either load the empty .lua file into the LuaGSCGUI.exe and add params, or rename a file you created with it to the correct model naming convention and replace it.
  • Empty page files are not displayed
  • If you load an existing .lua param file into the GUI tool for editing, any parameter not available for that type vehicle will not be entered and will be lost if the file is re-saved.
  • Yaapu GCS uses .lua files for each display page, but when you edit them or merely resave them using the LuaGSGUI program, it creates an accompanying .xml file that stores metadata about range/inc options, vehicle type, author, etc. so that the .lua file can be edited easier in the future. It does not hurt to have the .xml files on the SD card, or you can just copy the .lua file there. Be sure to re-compile any time you change anything.

Clone this wiki locally