How to run the Yaapu script on X10 and X12 as a Widget - yaapu/FrskyTelemetryScript GitHub Wiki

To setup the Yaapu Widget you need to configure up to 4 full screen telemetry pages.

Each page will have the Widget configured to show different information.

To toggle between pages short press the [PAGE] button.

The Widget is configured by changing the page option in the "Widget settings".

Widget valid page options are

1. main screen for single or aggregate view (mandatory)
2. mavlink message history screen (optional)
3. min/max screen for single or aggregate view (optional)
4. main screen for dual battery view (optional)

Note: after the files have been copied to the SD card the radio needs to be rebooted to clear all widget caches

Index

• Mandatory steps
• Optional steps
• Sensor discovery
• Configuration menu
• Notes

Mandatory steps

Note: starting with version 1.8.0 the blue theme is not necessary anymore

From the model page

1. long press [TELE] to enter telemetry page setup

2. short press [ENCODER] and use the encoder to change the "Layout" to full screen, confirm with [ENCODER] and press [RTN] to exit from the "Layout" setup

3. uncheck "Top Bar" and "Sliders+Trims"

4. select "Setup widgets" and press [ENCODER], you'll be presented with a full screen empty widget layout

5. short press [ENCODER] to assign a widget to the layout, the first available widget will be shown, "Gauge" in this example

6. scroll the encoder until you see the Yaapu scritp main display

7. press [ENCODER] to confirm the widget selection

8. press [RTN] to return to the telemetry pages setup

Note:

Widget version 1.8.0 and above do not require to dedicate a telemetry page to message history. To access messages it is now possible to define a "page toggle channel" from the config menu assigned to to a switch or slider. By using a 3 pos switch, a "low" value displays the main screen whereas mid and high displays the message screen.

9. next add a new telemetry page by pressing [PAGE] to select the plus icon

10. press [ENCODER] to create a new page, the Yaapu widget instance of this page will hold the mavlink message history

11. uncheck "Top Bar" and "Sliders+Trims"

12. select "Setup widgets" and press [ENCODER], you'll be presented with a full screen empty widget layout

13. short press [ENCODER] to assign a widget to the layout, the first available widget will be shown, "Gauge" in this example

14. scroll the encoder until you see the Yaapu scritp main display

15. confirm the selection with [ENCODER]

16. long press [ENCODER] to enter the widget menu

17. select "Widget settings" to enter the Yaapu widget options menu

18. press [ENCODER] (1 will start blinking) and change the "page" option to 2

19. press [RTN] to display the mavlink message history screen

20. press [RTN] to return to the main telemetry setup page

Turn your radio OFF and ON, the Yaapu widget should start at Power On!

Optional steps

To display the min/max screen repeat the steps from 9 to 20, you have to add an extra Yaapu full screen widget and set the script "page" option to 3 (step 18)

To display dual battery screen repeat the steps from 9 to 20, you have to add an extra Yaapu full screen widget and set the script "page" option to 4 (step 18)

Turn your radio OFF and ON, the Yaapu widget should start at Power On!

Sensor discovery

Note: with passthrough telemetry (protocol 10) sensor discovery is optional, the widget works just fine without it!

Now from the Yaapu widget page long press [MDL]

press [PAGE] and select the telemetry page

run "Discover new sensors", press [RTN] twice to go back to the Yaapu widget while discovery is running (do not stop sensor discovery)

As a last step from the Yaapu widget page long press [MDL]

use the encoder to select the telemetry page:

all sensors should have been discovered

stop discovery and press [RTN] twice to go back to the Yaapu widget

Note: in order for discovery to work the telemetry link has to be active!

How to access the script configuration MENU while in Widget mode

From any of the telemetry pages, (the Yaapu main widget page in this example)

long press [SYS] to enter the Radio Setup

press [PAGE] to select the "SD CARD" tab

browse to the /SCRIPTS/YAAPU folder

and run the "menu.lua" or "menu.luac" file by pressing [ENCODER] and selecting the "Execute" option

this will show the Yaapu script configuration menu

all changes are saved automatically.

Exit from the menu script by long pressing [RTN], then short press [RTN] twice to return to the main model telemetry page

Notes

Extra telemetry pages can be added to show whatever widget the user wants to, the Yaapu widget will be running in the background and all telemetry related events will be vocally reported. This allows to leverage the full OpenTX flexibility while the Yaapu script is running.

While the "menu.lua" configuration menu is running all the widgets are stopped (execution is frozen) and all telemetry info received while in the configuration menu is lost, this is an OpenTX limit, i.e. while a one time script is running all other LUA script are stopped, the user has to keep this in mind when launching the configuration menu while flying!.

While in the menu the flight timer is not stopped or reset and once back to the telemetry page it will report the correct flight time.