feat(joystick): add support for Android gamepad features #4626

ThomasKuehne · 2024-02-11T17:25:37Z

here be dragons - diverse tests required, USB HID support is sometimes ... picky

enhancements to the USB joystick - all Google mandated features for Android gamepads, except for the back key, are supported

new sim axis Accelerator (Acc), Break (Brk) and Steering (Steer)
new sim axis D-pad (dpad) also known as HAT switch
new joystick circular cutout mode "X-Y, Z-rZ"
mixing physical axis and sim axis now works
buttons are sparse - no need to configure buttons 0-5 if you only need button 6 or do remapping on the host

For Android use the USB Joystick Mode "Advanced" with "If.mode" Gamepad:

EdgeTX	Android	Linux	USB HID
axis X	left axis X	ABS_X	X
axis Y	left axis Y	ABS_Y	Y
axis Z	left axis X	ABS_Z	Z
axis rotZ	left axis Y	ABS_RZ	Rz
sim Acc ¹	right trigger	ABS_GAS	Accelerator
sim Brk ¹	left trigger	ABS_BRAKE	Break
sim HAT ²	D-pad	ABS_HAT0X / ABS_HAT0Y	Hat Switch
button 0	A	BTN_SOUTH	Button 1
button 1	B	BTN_EAST	Button 2
button 2	C ³	BTN_C	Button 3
button 3	X	BTN_NORTH	Button 4
button 4	Y	BTN_WEST	Button 5
button 5	Z ³	BTN_Z	Button 6
button 6	left shoulder button	BTN_TL	Button 7
button 7	right shoulder button	BTN_TR	Button 8
button 8	L2 ³	BTN_TL2	Button 9
button 9	R2 ³	BTN_TR2	Button 10
button 10	select ³	BTN_SELECT	Button 11
button 11	start ³	BTN_START	Button 12
button 12	mode ³	BTN_MODE	Button 13
button 13	left stick click	BTN_THUMBL	Buton 14
button 14	right stick click	BTN_THUMBR	Button 15

notes:

translation work required
- TR_VUSBJOYSTICK_CH_SIM has 4 additional values for the new axis
- TR_VUSBJOYSTICK_CIRC_COUTOUT has 1 additional value for the new circular cutout mode
button numbering between EdgeTX and the USB HID standard is off by one, resolving that would likely be a breaking change in the UI
is based on the battery capacity pull request feat: add battery level reporting to USB HID joystick #4602

triggers - check "advanced joystick howto" for EdgeTX/edgetx#4626 edgetx-user-manual#29 how to feed these half axis ↩ ↩²
D-pad - check "advanced joystick howto" for EdgeTX/edgetx#4626 edgetx-user-manual#29 how to feed this special axis ↩
these do work on most Android devices, however their support isn't mandatory ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷

ulfhedlund · 2024-02-14T18:43:19Z

SE translation:
#define TR_VUSBJOYSTICK_CH_SIM "Ske","Hjd","Rod","Gas", "Acc", "Brms", "Styr","dpad"

ThomasKuehne · 2024-02-17T15:42:39Z

Suggested layouts for tests:

channel	Android	Betaflight	Dualsense	EdgeTX pre 2.9	EdgeTX Classic
CH1	axis X	axis X	axis X	axis X	axis X
CH2	axis Y	axis Y	axis Y	axis Y	axis Y
CH3	axis Z	axis Z	axis Z	axis Z	axis Z
CH4	axis rotZ	axis rotX	axis rotZ	axis rotX	axis rotX
CH5	sim Brk	axis rotZ	axis rotX	axis rotY	axis rotY
CH6	sim Acc	axis rotY	axis rotY	axis rotZ	axis rotZ
CH7	-	axis Slider	-	axis Slider	axis Slider
CH8	sim Dpad	axis Dial	sim Dpad	axis Slider	axis Dial
CH9	button 0	button 0	button 0	button 0	button 0
CH10	button 1	button 1	button 1	button 1	button 1
CH11	-	button 2	button 2	button 2	button 2
CH12	button 3	button 3	button 3	button 3	button 3
CH13	button 4	button 4	button 4	button 4	button 4
CH14	-	button 5	button 5	button 5	button 5
CH15	button 6	button 6	button 6	button 6	button 6
CH16	button 7	button 7	button 7	button 7	button 7
CH17	button 8	-	button 8	button 8	button 8
CH18	button 9	-	button 9	button 9	button 9
CH19	button 10	-	button 10	button 10	button 10
CH20	button 11	-	button 11	button 11	button 11
CH21	button 12	-	button 12	button 12	button 12
CH22	button 13	-	button 13	button 13	button 13
CH23	button 14	-	button 14	button 14	button 14
CH24	-	-	-	button 8POS (15-23)	button 8POS (15-23)

Stick to the order the axis are declared. Applications are supposed to read axis IDs however many do not and use different kinds of position index instead.

Similar layouts:

other controller	use layout
OpenTX	EdgeTX pre 2.9
Orqa FPV.Ctrl	EdgeTX pre 2.9
Stadia	Android - use buttons 0-1, 3-4, 6-7, 10-14 and 16-19
Xbox	Android - use buttons 0-14

ThomasKuehne · 2024-02-29T17:55:44Z

Items resolved during compability testing:

dpad axis was displaced by about 0.5%
the sim Steering axis is commonly supported on Linux and on some Android devices
an additional circular cutout mode "X-Y, Z-rZ" was needed

Anybody else finding functional items gets a cookie 🍪

ThomasKuehne · 2024-04-05T20:36:59Z

Sorry for that - commit history is now squashed and without any merge commits.

pfeerick · 2024-04-05T21:21:30Z

Don't stress over it too much... that's why I said "where possible". As rebasing after having done merge commits can be messy and prone to things going wrong. So IMO not is worth the hassle if PR is otherwise self-contained and doesn't conflict.

…

On Sat, 6 Apr 2024, 6:37 am ThomasKuehne, ***@***.***> wrote: Sorry for that - commit history is now squashed and without any merge commits. — Reply to this email directly, view it on GitHub <#4626 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABJ66KIFIHNKOYIPG3GG57LY34DQBAVCNFSM6AAAAABDDWCKNCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANBQGU4TIMRTGY> . You are receiving this because your review was requested.Message ID: ***@***.***>

ThomasKuehne · 2024-04-07T15:31:09Z

No worries.
The cause for the initial merge approach were the concurrent translation updates - especially Portuguese and Ukrainian - leading to merge conflicts.

pfeerick

LGTM. Did some ... testing ... with FPV Skydive on phone with TX16S as well as checking axis all seem ok on Computer using Gamepad tester.

Used recommended Android order with channels in RTAE order to get the axis right per matching "Gamepad Tester" controller layout on Android...
https://manual.edgetx.org/edgetx-how-to/configure-advanced-joystick-with-edgetx#common-axis-mapping

pfeerick · 2024-05-29T10:05:14Z

Can we get some translations for this please 😃 Will be merged in seven days or when translations complete, whichever comes first.

TR_VUSBJOYSTICK_CH_SIM has 4 additional values (last four) for the new axis
TR_VUSBJOYSTICK_CIRC_COUTOUT has 1 additional value (the last one) for the new circular cutout mode

#define TR_VUSBJOYSTICK_CH_SIM         "Ail","Ele","Rud","Thr","Acc","Brk","Steer","Dpad"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT   "None","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

froqstar · 2024-05-29T10:36:21Z

DE

#define TR_VUSBJOYSTICK_CH_SIM         "Quer","Höhe","Seite","Gas","Beschl.","Bremsen","Lenkung","Dpad"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT   "kein","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

How many chars do we have space for? I assumed 5 based on "Steer"

zyren · 2024-05-29T12:49:35Z

CN

#define TR_VUSBJOYSTICK_CH_SIM         "横滚","俯仰","航向","油门","加速","刹车","转盘","方向"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT   "无","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

TW

#define TR_VUSBJOYSTICK_CH_SIM         "橫滾","俯仰","航向","油門","加速","剎車","轉盤","方向"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT   "無","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

pfeerick · 2024-05-29T12:52:52Z

How many chars do we have space for? I assumed 5 based on "Steer"

I would try to keep it under 9 characters... this is the space it would fit in... (it's the Sim axis value)

Pat6874 · 2024-05-29T14:55:51Z

FR: #define TR_VUSBJOYSTICK_CH_SIM "Ail","Prof","Dir","Gaz","Acc","Frein","Gouv","Dpad" #define TR_VUSBJOYSTICK_CIRC_COUTOUT "Aucun","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ" Le mer. 29 mai 2024 à 14:53, Peter Feerick ***@***.***> a écrit :

…

How many chars do we have space for? I assumed 5 based on "Steer" I would try to keep it under 9 characters... this is the space it would fit in... (it's the Sim axis value) image.png (view on web) <https://github.com/EdgeTX/edgetx/assets/5500713/c50be87b-057f-4403-b8f3-3c736900b914> — Reply to this email directly, view it on GitHub <#4626 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A6HE7XKCEVXREEOVDEUUCITZEXFTZAVCNFSM6AAAAABDDWCKNCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZXGM2DGNZVGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

robustini · 2024-05-29T17:59:08Z

IT

#define TR_VUSBJOYSTICK_CH_SIM "Ale","Ele","Dir","Mot","Acc","Fre","Sterz","Dpad"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT "Nessuno","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

HThuren · 2024-05-29T20:35:30Z

DA (insert after line 160)
#define TR_VUSBJOYSTICK_CH_SIM
TR_STICK_NAMES3,TR_STICK_NAMES1,TR_STICK_NAMES0,TR_STICK_NAMES2,"Acc","Brems","Styr","Dpad"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT "Ingen","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

Eldenroot · 2024-05-30T20:02:11Z

CZ:

#define TR_VUSBJOYSTICK_CH_SIM "Ail","Ele","Rud","Thr","Acc","Brk","Steer","Dpad"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT "Žádný","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

Quite difficult to translate some of them to Czech... because somebody uses translated ones. somebody uses English international names...

Some applications with direct HID raw processing expect require D-Pad keys instead of the POV axisw.

zandorsp · 2024-05-31T15:12:56Z

PT:
#define TR_VUSBJOYSTICK_CH_SIM "Ail","Pfd","Lem","Mot","Acc","Brk","Steer","Dpad"
#define TR_VUSBJOYSTICK_CIRC_COUTOUT "Nenh","X-Y, Z-rX","X-Y, rX-rY","X-Y, Z-rZ"

ThomasKuehne changed the title ~~feat(joystick) add support for all Android gamepad features~~ feat(joystick) add support for Android gamepad features Feb 11, 2024

ThomasKuehne mentioned this pull request Feb 12, 2024

FPV simulator DCL - The Game on PS4 Pro does not detected Radiomaster Boxer when connected. #4580

Closed

1 task

ThomasKuehne marked this pull request as ready for review February 18, 2024 20:16

ThomasKuehne added a commit to ThomasKuehne/edgetx-user-manual that referenced this pull request Feb 28, 2024

inital "advanced joystick howto" for EdgeTX/edgetx#4626

ce6d49d

ThomasKuehne mentioned this pull request Feb 28, 2024

"advanced joystick howto" for EdgeTX/edgetx#4626 EdgeTX/edgetx-user-manual#29

Closed

pfeerick added this to the 2.11 milestone Mar 6, 2024

pfeerick self-requested a review March 18, 2024 09:53

ThomasKuehne closed this Apr 5, 2024

ThomasKuehne force-pushed the joystick_android branch from 319e016 to 8ac247e Compare April 5, 2024 20:28

ThomasKuehne reopened this Apr 5, 2024

pfeerick changed the title ~~feat(joystick) add support for Android gamepad features~~ feat(joystick): add support for Android gamepad features May 12, 2024

pfeerick force-pushed the joystick_android branch from 7f15e29 to b003f63 Compare May 19, 2024 03:12

pfeerick force-pushed the joystick_android branch from b003f63 to 10f2f0a Compare May 29, 2024 08:05

pfeerick added enhancement ✨ New feature or request needs:translation labels May 29, 2024

pfeerick approved these changes May 29, 2024

View reviewed changes

ThomasKuehne and others added 10 commits May 31, 2024 09:34

feat(radio) add support for Android gamepad features

9e0767f

feat(radio): add explicit D-Pad keys to USB Joystick

22bc1c8

Some applications with direct HID raw processing expect require D-Pad keys instead of the POV axisw.

chore: formatting

5adca2c

chore: SE translation

4240f8b

chore: update DE

7e14445

chore: update CN/TW

1b279b5

chore: update FR

7d757e8

chore: update IT

d8114f1

chore: update DA

b206ccf

chore: update CZ

49bcbf1

pfeerick force-pushed the joystick_android branch from fcd0b7b to 49bcbf1 Compare May 31, 2024 09:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(joystick): add support for Android gamepad features #4626

feat(joystick): add support for Android gamepad features #4626

ThomasKuehne commented Feb 11, 2024 •

edited by pfeerick

ulfhedlund commented Feb 14, 2024 •

edited

ThomasKuehne commented Feb 17, 2024 •

edited

ThomasKuehne commented Feb 29, 2024

ThomasKuehne commented Apr 5, 2024

pfeerick commented Apr 5, 2024 via email

ThomasKuehne commented Apr 7, 2024

pfeerick left a comment •

edited

pfeerick commented May 29, 2024 •

edited

froqstar commented May 29, 2024 •

edited

zyren commented May 29, 2024 •

edited

pfeerick commented May 29, 2024

Pat6874 commented May 29, 2024 via email

robustini commented May 29, 2024

HThuren commented May 29, 2024

Eldenroot commented May 30, 2024

zandorsp commented May 31, 2024 •

edited

feat(joystick): add support for Android gamepad features #4626

Are you sure you want to change the base?

feat(joystick): add support for Android gamepad features #4626

Conversation

ThomasKuehne commented Feb 11, 2024 • edited by pfeerick

Footnotes

ulfhedlund commented Feb 14, 2024 • edited

ThomasKuehne commented Feb 17, 2024 • edited

ThomasKuehne commented Feb 29, 2024

ThomasKuehne commented Apr 5, 2024

pfeerick commented Apr 5, 2024 via email

ThomasKuehne commented Apr 7, 2024

pfeerick left a comment • edited

Choose a reason for hiding this comment

pfeerick commented May 29, 2024 • edited

froqstar commented May 29, 2024 • edited

zyren commented May 29, 2024 • edited

pfeerick commented May 29, 2024

Pat6874 commented May 29, 2024 via email

robustini commented May 29, 2024

HThuren commented May 29, 2024

Eldenroot commented May 30, 2024

zandorsp commented May 31, 2024 • edited

ThomasKuehne commented Feb 11, 2024 •

edited by pfeerick

ulfhedlund commented Feb 14, 2024 •

edited

ThomasKuehne commented Feb 17, 2024 •

edited

pfeerick left a comment •

edited

pfeerick commented May 29, 2024 •

edited

froqstar commented May 29, 2024 •

edited

zyren commented May 29, 2024 •

edited

zandorsp commented May 31, 2024 •

edited