Virtual events (WiP) #250

raphaelcoeffic · 2019-10-06T07:38:03Z

This is a first PoC for the virtual events. It has been only tested with T16 on the simulator.
The event checks in the UI can probably be simplified once we have something working.

This PR introduces support for virtual events (added to OpenTX 2.3) and implements automatic selection of the target platform (aka radio) based on the screen resolution, this supporting automatically all the radios supported in OpenTX, as long as the screen format is one of those already supported.

Let's make the tests properly. Here is a list of targets that need testing (non-exhaustive):

Please make sure you have OpenTX 2.3.1 installed and unzip this file at the root of your SD card and report how it works:
betaflight-tx-lua-scripts_1.3.0_virtual_events.zip

Depending on your target, you should test executing the scripts directly from the SD manager and/or as a telemetry script. Both should work properly.

mikeller

Looks good to me so far.
What is the minimum OpenTX release to be able to run this?
And how well supported are the virtual events on the different devices? Are there any devices that will need specific testing?

raphaelcoeffic · 2019-10-07T06:28:17Z

This needs to run on latest opentx, which is 2.3.1 for now.

We will need tests on basically all the targets. There is a test script that @3djc wanted to update to test the virtual events (in case it does not work as expected) and potential issues need to be reported to opentx for fixing the virtual events if necessary.

Some targets with the exact same keys and hardware don’t need to be tested separately (ex: T16 / X10, all the X-lites share the same navigation).

mikeller · 2019-10-07T10:30:09Z

@raphaelcoeffic: We are close to releasing Betaflight 4.1. Normally we do a release of the lua scripts to go with a firmware release. Do you think this is stable enough to be released this or next week? If not we should look into fixing #245 independent of this, and then releasing the scripts for now, and adding this pull request after the release.

raphaelcoeffic · 2019-10-07T13:12:55Z

Definitely not ready yet, lot’s of tests required on many targets I don’t own.

Fixing the other issue might be just as challenging if we are to break other targets... I really don’t know what can be done best.

mikeller · 2019-10-08T00:55:07Z

@raphaelcoeffic: I guess in this case is to delay releasing a new version of the lua scripts until we've got the virtual events at a point where we can release them. We can crowdsource the testing to the users in here, and we can add an announcement about this to the release notes for Betaflight 4.1.
So to my understanding the problem that exists with the current scripts was introduced in 2.3, so users can avoid the problem by staying with 2.2 for now?

raphaelcoeffic · 2019-10-08T14:41:05Z

@mikeller I assume so, yes. However, it would be really good to have the "crowdsourced tests" done ASAP ;-)

Matze-Jung · 2019-10-08T19:55:45Z

That's pretty interesting! I took another approach a few months ago and mapped the inputs by radio-name identifier. But from my testing, it takes some more memory.
If virtual events work well, some things will become simpler, others will no longer be in the hands of LUA script devs.

mikeller · 2019-10-08T23:09:27Z

Since this change uses functionality that is brand new in OpenTX this will need to be tested thoroughly on as many supported hardware types as possible.
So if you are a Betaflight TX lua script user, can you please use these steps to test and provide feedback (do this for as many different TX models as you can):

Upgrade OpenTX on your TX to 2.3.1;
Download this build and install it on the TX by copying the folders in obj/ over your TX SD card:

betaflight-tx-lua-scripts_1.3.0_virtual_events_2.zip

run the Betaflight TX lua scripts, and
verify that all screens on your TX look like they should;
verify that all the buttons / scroll wheels used on your TX to control lua scripts work as they should;
if something isn't working properly, leave a comment below stating the TX model and the problem you found;
if all is fine, check if somebody already mentioned that everything is working for your TX model, and if not, add a comment below stating the TX model and that everything worked for you.

Thank you very much for helping us to improve the scripts!

raphaelcoeffic · 2019-10-09T07:57:55Z

@mikeller could you please update your zip file with my latest changes? I believe this should work better. The older version showed to have some flows when testing on the simulator and X9D+.

mikeller · 2019-10-09T08:07:58Z

@raphaelcoeffic: Done, it's betaflight-tx-lua-scripts_1.3.0_virtual_events_2.zip.

vkolotov · 2019-10-09T10:08:58Z

An issue here with XLite Pro running v2.3.1 OTX. Joystick events are 90 degrees inverted, e.g.:

when you push right it actually generates "up" event (cursor goes up)
when you push left, "down" event generated
when you push down, nothing happens
when you push down for 2 secs, a dialog with "save page" appears
when you push up, screens get changed

Note: enter event works as expected

raphaelcoeffic · 2019-10-09T10:20:51Z

@vkolotov is this related to opentx/opentx#6916 ?

Please note that the goal here is to have something that offer a consistent user experience with the normal OpenTx menus that work the same.

vkolotov · 2019-10-09T10:30:02Z

@vkolotov is this related to opentx/opentx#6916 ?

I doubt it is related. I've copied over the new scripts and it changed direction.

The navigation in the radio controller (not in lua script) remained unchanged when I upgraded it to v2.3.1 OTX.

vkolotov · 2019-10-09T10:34:12Z

I have just reverted the scripts (copied over the backup, the latest release) and it works as expected. So it must be something wrong in the test version (zip archive provided here).

frozenskys · 2019-10-09T10:36:23Z

Is there a reason to still use the events.lua for mapping events if we can just use the virtual events directly in the ui.lua script?

McGiverGim · 2019-10-09T10:38:16Z

Tested with QX7S, to me it seems that the wheel is inverted, but I'm not totally sure if it was like this before.

raphaelcoeffic · 2019-10-09T11:07:38Z

Is there a reason to still use the events.lua for mapping events if we can just use the virtual events directly in the ui.lua script?

In fact no, this is going away next.

@vkolotov @McGiverGim I use different events now for +/- and prev/next, so that this should now work in the proper direction (same as radio nav).

raphaelcoeffic · 2019-10-09T11:09:11Z

Please note that the navigation is still tilted by 90° on T12 and X-lite(s, etc...). This will be fixed in OpenTx and be available in 2.3.2.

While testing, you might find that it works slightly differently from before, which should not be an issue, as long as it works.

The goal here is really to make supporting different targets simple and automatic, so that new targets are supported automatically, rather than having to be added one by one.

McGiverGim · 2019-10-09T13:23:46Z

@raphaelcoeffic now the wheel works as expected.

But there is another bug (it was before too), how can I change the page? If I remember correctly, before it was with the "menu" button (the three horizontal lines), but now it does nothing. But if I go out of the Betaflight lua script, the next time I enter in I'm on a new page.

mikeller · 2019-10-09T13:35:20Z

src/SCRIPTS/BF/ui.lua

            incValue(1)
-        elseif event == userEvent.press.minus or event == userEvent.repeatPress.minus or event == userEvent.dial.left then
+        elseif event == EVT_VIRTUAL_DEC or event == EVT_VIRTUAL_DEC_REPT then


This file looks so much cleaner now! 😄

well, a matter of taste as it seems :-) Anyway, that saves a bit of memory by avoiding the userEvent structure.

frozenskys · 2019-10-09T14:42:23Z

src/SCRIPTS/BF/ui.lua

-        menuActive = 1
-        currentState = pageStatus.displayMenu
-    elseif userEvent.press.pageDown and (event == userEvent.longPress.enter) then -- Horus
+    if (event == EVT_VIRTUAL_ENTER_LONG) then


Shouldn't this be if (event == EVT_VIRTUAL_MENU_LONG) then ?

MENU_LONG cannot be used in telemetry scripts (triggers the “Reset ...” menu).

raphaelcoeffic · 2019-10-09T15:44:24Z

how can I change the page?

@McGiverGim I think it should be the "page" key. Have you tried it? "page long" should go back one page, and "page" should lead you to the next page.

McGiverGim · 2019-10-09T16:47:34Z

@McGiverGim I think it should be the "page" key. Have you tried it? "page long" should go back one page, and "page" should lead you to the next page.

The page key returns to the others telemetry pages, as always did I think.

McGiverGim · 2019-10-09T16:53:56Z

Now I understand because each time I go out and in of the Betaflight script I have a different page: the page key, that rolls the telemetry pages, has been assigned to roll too the Betaflight pages. In the X7 this has been always the menu button.

raphaelcoeffic · 2019-10-09T16:56:03Z

The page key returns to the others telemetry pages, as always did I think.

hmm... I obviously forgot that bit... Then I need to re-instate the menu key ;-)

McGiverGim · 2019-10-09T17:11:27Z

hmm... I obviously forgot that bit... Then I need to re-instate the menu key ;-)

True, executing directly the script from the folders explorer, works ok. But I have it in the telemetry page. Is more intuitive to use the page key as you did, but it seems to interfere with Open TX. Maybe it can be disabled until we press Exit? Now I know because it was assigned to the menu key 😋

raphaelcoeffic · 2019-10-09T17:20:21Z

@McGiverGim can you please re-try with my latest change?

McGiverGim · 2019-10-09T17:46:02Z

@McGiverGim can you please re-try with my latest change?

Now it produces an infinite loop, rolling all the pages of the Betaflight script 😮

raphaelcoeffic · 2019-10-09T20:35:12Z

Now it produces an infinite loop, rolling all the pages of the Betaflight script 😮

F...! that'S what happens when I don't test it before... sorry for that!

McGiverGim · 2019-10-09T20:52:08Z

I can't test it until tomorrow. You don't need to make the same change when long pressing the menu to move page back?

frozenskys · 2019-10-09T20:52:36Z

@raphaelcoeffic that's working a lot better, however... ENTER_LONG triggers the “Reset ...” menu AND the BF popup menu on my X7 :| (unless I've done something wrong...)

mikeller · 2019-10-09T23:31:06Z

src/BF/bf.lua

@@ -9,6 +9,8 @@ assert(loadScript(radio.preLoad))()
 assert(loadScript(protocol.transport))()
 assert(loadScript(SCRIPT_HOME.."/MSP/common.lua"))()

+isTelemScript = false


Extra vowels don't cost extra. 😁 How about isTelemetryScript?

- uses the screen resolution to determine the target. - changes menu key mapping based on telemetry script vs standalone script.

asizon · 2019-10-10T05:45:28Z

Testes in X9D+, I think it take a long time for saving pages, more slowly that the previous version, can it make more fast??

McGiverGim · 2019-10-10T06:27:13Z

Tested latest version, some things that are different from the "old" script:

Now I can't go back in the Betaflight pages. Before, menu key go forward, and long menu key go backward. Now the long press in the menu key shows the menu.
Before the menu appeared with the enter key. Now it does nothing.

I think is important to have a backward key. I understand that the problem is that the page key does not work as expected. Is there a way to tell Open TX to ignore the page key until we get out of the script?

raphaelcoeffic · 2019-10-10T06:50:04Z

I think is important to have a backward key. I understand that the problem is that the page key does not work as expected. Is there a way to tell Open TX to ignore the page key until we get out of the script?

no, it is actually reserved for changing between telemetry pages.

raphaelcoeffic added 2 commits October 6, 2019 08:39

line endings normalized

82ea15a

choose platform by screen resolution

fef1445

raphaelcoeffic requested a review from mikeller October 6, 2019 07:39

This was referenced Oct 6, 2019

having syntax error with jumper t12 #248

Closed

opentx 2.3 number jumping back to another value #245

Closed

mikeller reviewed Oct 7, 2019

View reviewed changes

mikeller previously approved these changes Oct 9, 2019

View reviewed changes

frozenskys mentioned this pull request Oct 9, 2019

Use new OpenTX Tools screen / Add Menu / Use Virtual Events #252

Closed

raphaelcoeffic dismissed mikeller’s stale review via 0ff85ea October 9, 2019 11:02

mikeller reviewed Oct 9, 2019

View reviewed changes

frozenskys reviewed Oct 9, 2019

View reviewed changes

frozenskys mentioned this pull request Oct 9, 2019

Add BF Scripts to OpenTX 2.3.x Tools screen #253

Merged

raphaelcoeffic force-pushed the virtual-events branch from 08c73b9 to faf0976 Compare October 9, 2019 21:54

mikeller reviewed Oct 9, 2019

View reviewed changes

Use virtual events

6afc979

- uses the screen resolution to determine the target. - changes menu key mapping based on telemetry script vs standalone script.

raphaelcoeffic force-pushed the virtual-events branch from faf0976 to 6afc979 Compare October 9, 2019 23:35

mikeller approved these changes Oct 10, 2019

View reviewed changes

raphaelcoeffic mentioned this pull request Oct 12, 2019

X9D+ - virtual events lua still not correct #255

Closed

mikeller added this to the 1.4 milestone Oct 13, 2019

mikeller merged commit 4fd9cbe into master Oct 13, 2019

RipperDrone mentioned this pull request Oct 13, 2019

Virtual events #257

Merged

Virtual events (WiP) #250

Virtual events (WiP) #250

Conversation

raphaelcoeffic commented Oct 6, 2019 • edited Loading

mikeller left a comment

Choose a reason for hiding this comment

raphaelcoeffic commented Oct 7, 2019

mikeller commented Oct 7, 2019

raphaelcoeffic commented Oct 7, 2019

mikeller commented Oct 8, 2019

raphaelcoeffic commented Oct 8, 2019

Matze-Jung commented Oct 8, 2019

mikeller commented Oct 8, 2019 • edited Loading

raphaelcoeffic commented Oct 9, 2019

mikeller commented Oct 9, 2019 • edited Loading

vkolotov commented Oct 9, 2019

raphaelcoeffic commented Oct 9, 2019 • edited Loading

vkolotov commented Oct 9, 2019

vkolotov commented Oct 9, 2019

frozenskys commented Oct 9, 2019

McGiverGim commented Oct 9, 2019

raphaelcoeffic commented Oct 9, 2019

raphaelcoeffic commented Oct 9, 2019 • edited Loading

McGiverGim commented Oct 9, 2019

mikeller Oct 9, 2019

Choose a reason for hiding this comment

raphaelcoeffic Oct 9, 2019

Choose a reason for hiding this comment

frozenskys Oct 9, 2019

Choose a reason for hiding this comment

raphaelcoeffic Oct 9, 2019

Choose a reason for hiding this comment

raphaelcoeffic commented Oct 9, 2019

McGiverGim commented Oct 9, 2019

McGiverGim commented Oct 9, 2019

raphaelcoeffic commented Oct 9, 2019

McGiverGim commented Oct 9, 2019

raphaelcoeffic commented Oct 9, 2019

McGiverGim commented Oct 9, 2019

raphaelcoeffic commented Oct 9, 2019

McGiverGim commented Oct 9, 2019

frozenskys commented Oct 9, 2019 • edited Loading

mikeller Oct 9, 2019

Choose a reason for hiding this comment

asizon commented Oct 10, 2019 • edited Loading

McGiverGim commented Oct 10, 2019

raphaelcoeffic commented Oct 10, 2019

raphaelcoeffic commented Oct 6, 2019 •

edited

Loading

mikeller commented Oct 8, 2019 •

edited

Loading

mikeller commented Oct 9, 2019 •

edited

Loading

raphaelcoeffic commented Oct 9, 2019 •

edited

Loading

raphaelcoeffic commented Oct 9, 2019 •

edited

Loading

frozenskys commented Oct 9, 2019 •

edited

Loading

asizon commented Oct 10, 2019 •

edited

Loading