nrinas/jslisten
1
0
Fork 0
mirror of https://github.com/workinghard/jslisten.git synced 2025-12-13 19:02:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #31 from cgmckeever/README

Browse Source 
Update README
This commit is contained in:
Nikolai Rinas
2021-02-07 18:00:49 +01:00
committed by GitHub
parent 50ead3e340 0a3b4b588d
commit 3c84610b74
2 changed files with 104 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
README.md
View File

@@ -7,13 +7,14 @@
4. [Configuration](#configuration)
5. [Known limitations](#known-limitations)
6. [Multiple key combinations](#multiple-key-combinations)
7. [Version Updates](UPDATES.md)
## Overview
This program listen in the background for gamepad inputs. If a special button combination is getting pressed,
the provided command line will be invoked. It runs a command once defined buttons were pressed. It was developed for Raspbian and PS3 wireless controller but should work everywhere with udev and [joystick](https://sourceforge.net/projects/linuxconsole/) support.
This program listens in the background for gamepad inputs. If a special button combination is getting pressed,
the provided command line will be invoked. It runs a command once defined buttons were pressed. It was developed for Raspbian and PS3 wireless controller but should work everywhere with `udev` and [joystick](https://sourceforge.net/projects/linuxconsole/) support.
## Usage
### Example Use Case
I have a Raspberry Pi. The installed operation system is raspbian. The Kodi package runs pretty well as a media center. The remote control is an App on a smartphone. So no other controller is needed.
@@ -25,59 +26,78 @@ In my configuration Kodi runs as default. Media center is still the primary usag
After searching the internet, I found nothing really interesting. Kodi addon will not work because gamepad support is still missing. EmulationStation addon might work but than ... Kodi solution will be missing. So I had to go one level up to the OS. But even here I found nothing really easy to setup or working. So I decided to write this program. It runs as a daemon in the background and listening in nonblocking mode to /dev/input/js* devices. To make it hotplug capable, it's monitoring the udev signals if no device is present.
<b>Update 12/22/2018:</b>
If you have many different /dev/inputs, you can pass it as an arguement at the startup:
```jslisten --device /dev/input/js0```
** jslisten will also default to listen to the first device found if the defined device is not found.
<b>Update 02/12/2019:</b>
Changed the default service user to "pi" in jslisten.service
Use user root only if it's really required.
<b>Update 02/16/2019:</b>
Added a different mode to easier trigger scripts.
When started with `--mode plain` (the default) the program behaves as used. This is fine if you need the button combination once in a while.
However if you want to activate a script a few times in a short time, lets say to adjust your audio volume or if you have a led stripe installed in your arcade and want to adjust the brightness, then
the `--mode hold` comes in handy.
When started with `--mode hold` and you have at least two buttons defined to enter an action, then you hold down the first one, while tipping the second one. If you have three buttons defined you can
hold the second two and then just tip the third. In a four button set you will have to hold the first three.
As soon as you release any but the last button (according to the order in the `jslisten.cfg`) you will have to press the all buttons again.
So the difference to the plain mode is that once you have entered the engaged/elevated state with a three button set for example, you hold down the first two and can quickly trigger the action by
pressing the third. In plain mode you would have to press all three buttons over again to do audio or brightness adjustment.
Also added `--help` for the command line for a brief summary of options.
## Installation
### Quick Install
```
cd /tmp
git clone git@github.com:workinghard/jslisten.git
cd jslisten
echo "Building jslisten binary"
make
echo "Moving jslisten binary to executable path"
sudo mkdir -p /opt/bin
sudo cp bin/jslisten /opt/bin/jslisten
echo "Copying default config; you will need to modify this file for your use case."
cp /etc/jslisten.cfg ~/.jslisten
echo "Adding jslisten support at boot"
sudo cp utils/jslisten.service /etc/systemd/system
sudo systemctl daemon-reload
sudo systemctl start jslisten.service
sudo systemctl enable jslisten
```
You will need to modify your `~/.jslisten` config file based on your own requirements.
### Step by step
Following example for Raspbian. Should work for many other distributions almost the same way.
* run "# make" to create the binary
* Place the binary to "/opt/bin" (if you change the folder, please update your init script)
* Copy the configuration script to /etc/jslisten.cfg
* Modify the configuration script to your needs
* Copy the service script "utils/jslisten.service" to "/etc/systemd/system"
* Update the systemd daemon: "# systemctl daemon-reload"
* Start the daemon "# systemctl start jslisten.service"
* Make it start at boot "# systemctl enable jslisten"
#### Setting up the service
- run `make` to create the binary
- Place the binary in `/opt/bin`
- If you change the folder, please update the init script
- Copy the configuration script `cp etc/jslisten.cfg /etc/jslisten.cfg`
- This can either live in `/etc/jslisten.cfg` or as `~/.jslisten`
- Modify the configuration script to your needs
- See configuration walkthrough below
#### Testing
- At this point you should have a runable version of `jslisten` that is configured for your use case.
- you can test it by running `jslisten --device /dev/input/js[*]`
- where `[*]` is your deviceID (ie `/dev/input/js0`)
- Once you get it running manually, you can set it to start at boot
#### Start at boot
- Copy the service script `sudo cp utils/jslisten.service /etc/systemd/system`
- make any changes to the `ExecStart` to change joystick devices (defaults to `/dev/input/js0`)
- Update the systemd daemon `sudo systemctl daemon-reload`
- Make it start at boot `sudo systemctl enable jslisten`
- You can start and stop the service via
- Start: `sudo systemctl start jslisten.service`
- Stop: `sudo systemctl stop jslisten.service`
- Status: `sudo systemctl status jslisten.service`
## Configuration
* I assume your joystick setup is already done and you can see with "jstest /dev/input/js0" nice looking key strokes coming up. There are many tutorials out there and you should not proceed if this doesn't work for you!
* Run ./jslisten once to create ~/.jslisten config file or copy utils/jslisten.cfg to /etc
* Think which button combination will work for your gamepad. You can configure up to 4 button combination. In my case i picked "Left Shoulder" + "Right Shoulder" + SELECT. I'm pretty sure i will not need to press this buttons at the same time for any games.
* Get the number ID's for this buttons with jstest (or any other similar program)
* Edit the configuration file (either /etc/jslisten.cfg or ~/.jslisten) and maintain the button ID's and the program which you want to run.
* Make sure this script/program can handle multiple simultanios calls! Even if the daemon will wait till this program ends, you never know... And we like to press key combinations many times, if something doesn't work immediately...
- I assume your joystick setup is already done and you can see activation with `jstest /dev/input/js0`
- There are many tutorials out there and you should not proceed if this doesn't work for you!
- Think which button combination will work for your gamepad. You can configure up to 4 button combination. In my case i picked `Left Shoulder` + `Right Shoulder` + `SELECT`. I'm pretty sure I will not need to press this buttons at the same time for any games.
- Get the number ID's for this buttons with `jstest` (or any other similar program)
- Edit the configuration file (either `/etc/jslisten.cfg` or `~/.jslisten`) and maintain the button ID's and the program which you want to run.
- Make sure this script/program can handle multiple simultanios calls! Even if the daemon will wait till this program ends, you never know... And we like to press key combinations many times, if something doesn't work immediately...
### Example Config
Note that it calls a custom shell script `/opt/bin/modeSwitcher.sh`. You will need to define something like this for your use case.
Here is my config example:
```
[Generic]
program="/opt/bin/modeSwitcher.sh"
@@ -89,12 +109,13 @@ button4=
## Known limitations
* Kodi and X11 are blocking /dev/input/* events. For X11 you can add an exception in /usr/share/X11/xorg.conf.d/10-quirks.conf but Kodi is ... nasty ... As long as they don't implement a nice
unified unput support, my workaround is to revoke the kodi group rights to the input devices. :(
* If you experience any issues, feel free to use '--loglevel debug' option and check syslog.
- Kodi and X11 are blocking `/dev/input/*` events. For X11 you can add an exception in `/usr/share/X11/xorg.conf.d/10-quirks.conf` but Kodi is ... nasty ... As long as they don't implement a nice unified unput support, my workaround is to revoke the kodi group rights to the input devices. :(
- If you experience any issues, feel free to use `--loglevel debug` option when starting the binary (either manually or adding to the `systemctl` [reference above] call) and check syslog.
## Multiple key combinations
You can have different key sets to run different programs:
```
[Generic]
program="/opt/bin/modeSwitcher.sh"

32
UPDATES.md Normal file
View File

@@ -0,0 +1,32 @@
## Update 12/22/2018
If you have many different /dev/inputs, you can pass it as an arguement at the startup:
```jslisten --device /dev/input/js0```
** jslisten will also default to listen to the first device found if the defined device is not found.
## Update 02/12/2019
Changed the default service user to "pi" in jslisten.service
Use user root only if it's really required.
## Update 02/16/2019
Added a different mode to easier trigger scripts.
When started with `--mode plain` (the default) the program behaves as used. This is fine if you need the button combination once in a while.
However if you want to activate a script a few times in a short time, lets say to adjust your audio volume or if you have a led stripe installed in your arcade and want to adjust the brightness, then
the `--mode hold` comes in handy.
When started with `--mode hold` and you have at least two buttons defined to enter an action, then you hold down the first one, while tipping the second one. If you have three buttons defined you can
hold the second two and then just tip the third. In a four button set you will have to hold the first three.
As soon as you release any but the last button (according to the order in the `jslisten.cfg`) you will have to press the all buttons again.
So the difference to the plain mode is that once you have entered the engaged/elevated state with a three button set for example, you hold down the first two and can quickly trigger the action by
pressing the third. In plain mode you would have to press all three buttons over again to do audio or brightness adjustment.
Also added `--help` for the command line for a brief summary of options.