Event Device Support (`evdev`) #1943

votti · 2022-12-30T14:14:26Z

Background

As described in #1942, a plugin to support to setup listeners to event devices such as USB controller, joysticks or keyboards would be useful.

Implementation

This implementation builds on the EvDevKeyListener and is based on the bluetooth_audio_buttons plugin.

The following details differ from the bluetooth_audio_buttons plugin:

initialize the listeners from the configuration. I have tried to document the format in the docstring. Is there a better place to do so?
rpc command is bound with deference=False. Otherwise plugins, eg next_song, may not be initialized yet upon initialization. Is there a better way?

s-martin · 2022-12-30T14:35:19Z

@pabera @ChisSoc

ghost · 2022-12-30T20:05:56Z

Nice addition!

Regarding the documentation: The best way to go would be to write a Ueer Guide Page. The live in docs/sphinx/userguide. Just create a new .rst file and add to in the index.rst. See the bluetooth doc as an example.

The user guide needs

How to activate this plugin
How to find out the device_name that is needed for the configuration
How to find out the button id
And a complete configuration example, please

Ah, yes, dereference. If I remember correctly this has to do with the order of the loading of the plugins. Try loading your plugin last.

votti · 2022-12-30T20:28:03Z

Thanks for the feedback+ Top, I will look into adding the documentation. @Dereference: i already have put the plugin last, but the only way to get it to run was to add the listeners only when adding them as a "finalize" step. Is the performance hit without dereference really bad enough to worry about this optimization? Cheers!

…

On Fri, Dec 30, 2022, 21:06 Chris ***@***.***> wrote: Nice addition! Regarding the documentation: The best way to go would be to write a Ueer Guide Page. The live in docs/sphinx/userguide. Just create a new .rst file and add to in the index.rst. See the bluetooth doc as an example <https://rpi-jukebox-rfid.readthedocs.io/en/latest/userguide/bluetooth_audio_buttons.html> . The user guide needs - How to activate this plugin - How to find out the device_name that is needed for the configuration - How to find out the button id - And a complete configuration example, please Ah, yes, dereference. If I remember correctly this has to do with the order of the loading of the plugins. Try loading your plugin last. — Reply to this email directly, view it on GitHub <#1943 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA4R2KB5276MQANQHKX3PLTWP46C5ANCNFSM6AAAAAATM5NKVI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

ghost · 2023-01-01T10:59:11Z

Ah yes, finalize it was.

Don't worry about the performance impact. It is negligible.

votti · 2023-01-02T21:08:14Z

I added now a documentation.
It would be great if someone could test it. As a device eg an USB mouse works well.

pabera

I read through your documentation. I found a few typos which I corrected myself rather than calling them out. I committed them to the same branch. I'd like @ChisSoc to do a last check on the Python code.

Great addition. (all though I wonder how my 3 year old would use a USB mouse to rule their Phoniebox 🤔)

src/jukebox/components/controls/event_devices/README.rst

src/jukebox/components/controls/event_devices/__init__.py

votti · 2023-01-07T19:40:42Z

Thanks for the comments, I will address them!

"(all though I wonder how my 3 year old would use a USB mouse to rule their Phoniebox thinking)"

The USB mouse was more a very general illustration that this works with any USB device, not necessarily an endorsement :)
The beter usecase for this is to use a cheap Joystick controller board in order to hook up arcade buttons in via USB in case the GPIO pins are occupied otherwise.
I am using: https://de.aliexpress.com/item/1005001604578101.html?spm=a2g0o.order_list.order_list_main.5.26875c5fq1PFcA&gatewayAdapt=glo2deu

votti · 2023-01-10T20:55:39Z

It seems that flake8 is failing due to flake8 violations in code not touched by this PR.
Schould I do a separare PR fixing all the pre-existing violations or rather fold the fixes into this PR?

pabera · 2023-04-07T21:41:39Z

Schould I do a separare PR fixing all the pre-existing violations or rather fold the fixes into this PR?

A separate PR would be ok.

Would you still be interested in merging this?

AlvinSchiller · 2023-04-08T00:00:46Z

It seems that flake8 is failing due to flake8 violations in code not touched by this PR. Schould I do a separare PR fixing all the pre-existing violations or rather fold the fixes into this PR?

For the fixes see #1989

votti · 2023-08-13T17:20:17Z

Hi @pabera ,

Sorry for being unresponsive, I had quite lot of personal events that diminished my free time.

I rebased the PR to the latest dev branch, so the flake8 should be fixed and the cosmetic issues should be addressed.

pabera · 2023-08-14T22:33:39Z

I have fixed the flake8 issue in another PR (#2057). If you pull all changes again, you should be able to pass flake8 properly

This implements an "event device" listener plugin, that enables the user to configure the phoniebox to respond to events from an "event device" (device under /dev/input). This incluces eg button presses from an USB controller or keyboard.

Includes a detailed how-to as well as example config

This is an actual usecase in case someone wants to setup a device and figure out the button ids by looking at the logs

- Remove duplicated section as suggested - Add Zero Delay Arcade USB Encoder usecase

votti · 2023-08-15T20:46:03Z

Hi there,
I rebased again and run flake8 locally - now all looks clean on my side.

votti · 2023-08-15T20:47:56Z

I also found by chance that in the old Jukebox there was already an implementation/reference about this: https://github.com/MiczFlor/RPi-Jukebox-RFID/blob/develop/components/controls/buttons_usb_encoder/README.md?plain=1
Should I link this in the readme?

s-martin · 2023-12-04T21:16:03Z

@votti would you mind rebasing latest changes from future3/develop? Biggest change is probably that docs are now markdown.

I think then we could merge this PR

votti · 2024-01-17T22:39:31Z

@pabera I am away for holidays so no access to a pi. However I just managed to get the docker dev environment (including evdev devices) runing, so I may be able to work on it till the end of the week.

No hard feelings if this does not make the next release. I think having the configuration file in a final form before merging it is really important.

This is tighly modeled after gpio. In contrast to GPIO, this is a list of devices containing each one or more input/output devices. Eg a Joystick has keys but potentially also rumble or leds. Currently only very simply input devices (buttons) are supported. This structer should enable to extend this easily.

As suggested this should be a separate file, similar to the gpioz config

Now the config for evdev is akin to GPIO. The big difference is that multiple devices with each multiple input/output devices are supported. Note that the backend is still the old event device listener backend. Thus to support more features, the backend would need to be quite drastically overhauled.

votti · 2024-01-18T23:28:09Z

I now aligned the configuration structure with gpio.yaml.
In contrast to gpio, multiple devices each with their own input/output_devices are supported.
Note that currently only input_devices the Button type with the on_press action is implemented.

While extending the config to such new functionalities is now easy, this code is still relying on the pre-existing EventDeviceListener code backend. Expanding this mechanisms to support more features (eg long press etc) will require significant changes on this backend.

This functionality has been tested now in the Docker environment as I currently dont have access to my raspi. However due to the generic nature of the matter, I would expect no issues.

" Investigate why I indicated that the evdev module should be listed last." - I did not find a good reason after trying also different orders. Maybe I just meant that while it looks in the provided example that it should be the first entry, it actually just should be appended.

The attribute 'device_request' of EvDevKeyListener is now called 'device_name_request'

Fails if there is no device_name and setts proper default for 'exact'

This is required for some tests. Following the instructions from issue MiczFlor#2050 Specifically: MiczFlor#2050 (comment)

This reverts commit 75161b5. As this was not working

Currently it is hard to install zmq (MiczFlor#2050) and for CI pytest `zmq` is not available. As the test do not really require `jukebox.publishing` running, mocking it in the test avoids it being imported. Thus the tests do not require `zmq` to be installed.

votti · 2024-01-19T16:54:38Z

I now also added some tests and fixed some bugs/edge cases found during testing.

One issue I encountered is that zmq is not installed for the Github CI testing.
First I tried to fix the Github CI but then decided to better just use mocks to make my tests independent of zmq.

I will add an issue that it would be nice to eventually have zmq also in our github action workflow used for testing (done: #2219 )

pabera · 2024-01-19T22:16:39Z

resources/default-settings/evdev.example.yaml

@@ -0,0 +1,59 @@
+devices: # A list of evdev devices each containing one or multiple input/output devices
+  joystick: # A nickname for a device
+    device_name: DragonRise Inc.   Generic   USB # Device name


Is this just a pretty name or actually relevant to access/call the device?

The 'device_name' is relevant as it is used to get the device number (in contrast to the nickname line 2 which is cosmetic).

The docs contain a section how to look it up: https://github.com/MiczFlor/RPi-Jukebox-RFID/blob/49839adb01019cb296d67dc29c06cd9a6af0bc62/documentation/builders/event-devices.md#identifying-the-device_name

pabera · 2024-01-19T22:23:51Z

test/evdev/test_evdev_init.py

@@ -0,0 +1,185 @@
+""" Tests for the evdev __init__ module


I like the fact that you have put effort into tests as well. It keeps pushing the bar. It's something we haven't pushed for in the past but indeed allows to be more confident when others make changes in the future.

s-martin · 2024-02-18T21:14:44Z

Could be merged?

votti · 2024-02-19T21:28:50Z

Let me know if there is anything still required from my side!
If not I would appreciate if this would be merged before it diverges again from the main develop/future3 branch.

pabera

Approved.

Last question @votti .. How do you execute the tests in this scenario?

votti · 2024-02-20T15:25:57Z

The tests are executed as part of the standard "pytest" call.
eg: https://github.com/MiczFlor/RPi-Jukebox-RFID/actions/runs/7951763478/job/21705563833?pr=1943#step:5:30
in the ci:

test/evdev/test_evdev_init.py::TestInputDevicesToKeyMapping::test_mapping_with_missing_key_code PASSED [ 24%]
test/evdev/test_evdev_init.py::TestInputDevicesToKeyMapping::test_mapping_with_missing_type PASSED [ 27%]
test/evdev/test_evdev_init.py::TestInputDevicesToKeyMapping::test_mapping_with_supported_input_type_and_key_code PASSED [ 29%]
test/evdev/test_evdev_init.py::TestInputDevicesToKeyMapping::test_mapping_with_unsupported_action PASSED [ 32%]
test/evdev/test_evdev_init.py::TestInputDevicesToKeyMapping::test_mapping_with_unsupported_input_type PASSED [ 35%]
test/evdev/test_evdev_init.py::TestParseDeviceConfig::test_parse_device_config PASSED [ 37%]
test/evdev/test_evdev_init.py::TestParseDeviceConfig::test_parse_device_config_missing_device_name PASSED [ 40%]
test/evdev/test_evdev_init.py::TestParseDeviceConfig::test_parse_device_config_missing_exact PASSED [ 43%]
test/evdev/test_evdev_init.py::

s-martin added enhancement future3 Relates to future3 development labels Dec 30, 2022

s-martin linked an issue Dec 30, 2022 that may be closed by this pull request

🚀 | Add Event Device plugin to support USB controllers #1942

Closed

votti force-pushed the future3/evdev_plugin branch from f06fcb5 to 4bd118d Compare December 30, 2022 14:39

votti force-pushed the future3/evdev_plugin branch from ef0b487 to fde2478 Compare January 4, 2023 21:04

pabera reviewed Jan 4, 2023

View reviewed changes

src/jukebox/components/controls/event_devices/README.rst Outdated Show resolved Hide resolved

src/jukebox/components/controls/event_devices/__init__.py Outdated Show resolved Hide resolved

votti force-pushed the future3/evdev_plugin branch from b17d531 to a01c6f0 Compare August 13, 2023 15:40

votti and others added 6 commits August 15, 2023 22:33

Add event device plugin

5c1cb16

This implements an "event device" listener plugin, that enables the user to configure the phoniebox to respond to events from an "event device" (device under /dev/input). This incluces eg button presses from an USB controller or keyboard.

Adds documentation for the event device plugin

87e8aa1

Includes a detailed how-to as well as example config

Allow empty button config

f1caebf

This is an actual usecase in case someone wants to setup a device and figure out the button ids by looking at the logs

Update README.rst

0408775

Improve README

5243583

- Remove duplicated section as suggested - Add Zero Delay Arcade USB Encoder usecase

Give more meaningfull name to listener thread variable

a93104b

votti force-pushed the future3/evdev_plugin branch from a01c6f0 to a93104b Compare August 15, 2023 20:39

s-martin mentioned this pull request Dec 28, 2023

Barcode Scanner instead of RFID Reader #562

Closed

Update to markdown docs and merge develop

23b107c

Add example how to access evdev in docker

38b4cd4

pre-commit fix Vito Zanotelli added 2 commits January 18, 2024 22:34

Move evdev config to separate file

90de6a4

As suggested this should be a separate file, similar to the gpioz config

pabera modified the milestones: v3.5, v3.6 Jan 18, 2024

pre-commit fix Vito Zanotelli added 2 commits January 18, 2024 23:53

Update documentation for new evdev config format

62171ef

pre-commit fix Vito Zanotelli added 8 commits January 19, 2024 00:33

Fix wrong reference

d77a69b

Fix bug to correctly check supported input device type

4274e92

Add more tests for evdev init

a3b328b

Fix wrong attribute name

3773556

The attribute 'device_request' of EvDevKeyListener is now called 'device_name_request'

Validate input config better

2df6adf

Fails if there is no device_name and setts proper default for 'exact'

Add pyzmq installation for github action

75161b5

This is required for some tests. Following the instructions from issue MiczFlor#2050 Specifically: MiczFlor#2050 (comment)

Revert "Add pyzmq installation for github action"

51d9915

This reverts commit 75161b5. As this was not working

pabera reviewed Jan 19, 2024

View reviewed changes

s-martin approved these changes Jan 29, 2024

View reviewed changes

Merge branch 'future3/develop' into future3/evdev_plugin

bc6610c

pabera mentioned this pull request Feb 5, 2024

Release v3.5.1 #2241

Merged

2 tasks

AlvinSchiller mentioned this pull request Feb 14, 2024

Release v3.6.0 #2258

Open

Merge branch 'future3/develop' into future3/evdev_plugin

f807152

pabera approved these changes Feb 20, 2024

View reviewed changes

s-martin merged commit 07208e6 into MiczFlor:future3/develop Feb 20, 2024
19 checks passed

s-martin mentioned this pull request Feb 20, 2024

🚀 | Add Event Device plugin to support USB controllers #1942

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Event Device Support (`evdev`) #1943

Event Device Support (`evdev`) #1943

votti commented Dec 30, 2022

s-martin commented Dec 30, 2022

ghost commented Dec 30, 2022

votti commented Dec 30, 2022 via email

ghost commented Jan 1, 2023

votti commented Jan 2, 2023

pabera left a comment

votti commented Jan 7, 2023 •

edited

Loading

votti commented Jan 10, 2023

pabera commented Apr 7, 2023

AlvinSchiller commented Apr 8, 2023

votti commented Aug 13, 2023

pabera commented Aug 14, 2023 •

edited

Loading

votti commented Aug 15, 2023

votti commented Aug 15, 2023

s-martin commented Dec 4, 2023 •

edited

Loading

votti commented Jan 17, 2024

votti commented Jan 18, 2024 •

edited

Loading

votti commented Jan 19, 2024 •

edited

Loading

pabera Jan 19, 2024

votti Jan 29, 2024

pabera Jan 19, 2024

s-martin commented Feb 18, 2024

votti commented Feb 19, 2024

pabera left a comment

votti commented Feb 20, 2024 •

edited

Loading

Event Device Support (evdev) #1943

Event Device Support (evdev) #1943

Conversation

votti commented Dec 30, 2022

Background

Implementation

s-martin commented Dec 30, 2022

ghost commented Dec 30, 2022

votti commented Dec 30, 2022 via email

ghost commented Jan 1, 2023

votti commented Jan 2, 2023

pabera left a comment

Choose a reason for hiding this comment

votti commented Jan 7, 2023 • edited Loading

votti commented Jan 10, 2023

pabera commented Apr 7, 2023

AlvinSchiller commented Apr 8, 2023

votti commented Aug 13, 2023

pabera commented Aug 14, 2023 • edited Loading

votti commented Aug 15, 2023

votti commented Aug 15, 2023

s-martin commented Dec 4, 2023 • edited Loading

votti commented Jan 17, 2024

votti commented Jan 18, 2024 • edited Loading

votti commented Jan 19, 2024 • edited Loading

pabera Jan 19, 2024

Choose a reason for hiding this comment

votti Jan 29, 2024

Choose a reason for hiding this comment

pabera Jan 19, 2024

Choose a reason for hiding this comment

s-martin commented Feb 18, 2024

votti commented Feb 19, 2024

pabera left a comment

Choose a reason for hiding this comment

votti commented Feb 20, 2024 • edited Loading

Event Device Support (`evdev`) #1943

Event Device Support (`evdev`) #1943

votti commented Jan 7, 2023 •

edited

Loading

pabera commented Aug 14, 2023 •

edited

Loading

s-martin commented Dec 4, 2023 •

edited

Loading

votti commented Jan 18, 2024 •

edited

Loading

votti commented Jan 19, 2024 •

edited

Loading

votti commented Feb 20, 2024 •

edited

Loading