Feature request: keyboard layout #66

eternal-sorrow · 2018-10-28T16:25:33Z

Would be really nice to have the module showing current keyboard layout. Or maybe a help to write the custom module script with this capability.

harishkrupo · 2018-10-31T19:03:59Z

Create a custom module with something like this in a script and run it in the exec: ?
setxkbmap -query | grep layout | cut -f2 -d":" | tr -d '[:space:]'

eternal-sorrow · 2018-11-01T11:47:54Z

@harishkrupo it doesn't work. It always shows us (my default layout) even when I use another layout.

harishkrupo · 2018-11-02T01:44:11Z

okay, will need to check. How do you pick a different layout?

alecmev · 2018-11-02T11:51:23Z

@harishkrupo If you're using Sway: https://github.com/swaywm/sway/wiki#input-configuration

harishkrupo · 2018-11-04T22:23:49Z

I have opened a PR for this issue: #85

ghost · 2018-12-24T12:08:21Z

if somebody needs it:

"custom/lang": {
    "exec": "swaymsg -t get_inputs|grep -4 'AT T'|tail -1|sed 's/.*: //;s/\"//g'|cut -c 1-2|tr '[a-z]' '[A-Z]'",
    "interval": 1
},

Note: grep -4 'AT T' finds my particular keyboard, you probably want to change values in the script

this polls it every second, but ideally it should work as in pulseaudio module, to update whenever layout updates.
for that it needs some integration with wlroots/sway or something, and values like "name": "AT T" to identify which exact keyboard to use

harishkrupo · 2018-12-24T12:35:33Z

@rvi64 Thanks!
Similar suggestions here:

There is an ongoing work to create a new protocol to get this information. See here
Unfortunately, I got busy with some other work . :(
I will try to start work on this again.

ghost · 2019-04-01T13:17:37Z

here's a version without jq, only unix utils, shows EN by default, and first two upper case letters otherwise

  "custom/lang": {
    "exec": "swaymsg -t get_inputs | grep layout_name | grep -v En | awk 'END{if(NR == 0){print \"EN\"}else{print toupper(substr($2,2,2))}}'",
    "interval": 1,
    "format": "{} "
  },

krtko1 · 2019-05-15T20:34:32Z

here's a another version with only unix utils, shows proper language two letters shortcut

.config/waybar/modules/layout.sh

#!/bin/bash

KEYBOARD=$(swaymsg -pt get_config | awk '{if ($1 == "input") {name=$2}; if($1 == "xkb_layout") {print name; exit}}')

ACTIVE_LANGUAGE=$(swaymsg -t get_inputs | grep -5 $KEYBOARD | tail -1 | sed 's/.*"\(.*\)".*$/\1/gi')

MANPAGE=$(man --where xkeyboard-config)
case `file -bi $MANPAGE | grep -o "^[^/]*/[^;]*"` in
    'application/x-gzip') CAT='zcat';;
    'application/x-bzip2') CAT='bzcat';;
    'application/x-tar') CAT='tar -O -xf';;
    'application/x-xz') CAT='xzcat';;
    'text/plain') CAT='cat';;
esac

$CAT $MANPAGE | awk -F'[\t(]' -v var="$ACTIVE_LANGUAGE" 'index($0,var)>=1 {print $1; exit}'

.config/waybar/config

    "custom/layout": {
        "exec": "~/.config/waybar/modules/layout.sh",
        "interval": 1,
        "format": "{} "
    }

EDIT: add support for other man formats. Sadly /usr/share/X11/xkb/rules/evdev.xml is not contain needed informations

eternal-sorrow · 2019-05-15T22:25:17Z

gzip: skipping: /usr/share/man/man7/xkeyboard-config.7.bz2 unrecognized format

You assume that man page is compressed with gzip.

Also, don't you think, parsing man isn't the right way to do this? The right way is parsing /usr/share/X11/xkb/rules/evdev.xml I guess.

krtko1 · 2019-05-16T12:54:54Z

@eternal-sorrow
EDIT2: I change to script to not start every time

.config/waybar/modules/layout.sh

#!/bin/bash
  
KEYBOARD=$(swaymsg -pt get_config | awk '{if ($1 == "input") {name=$2}; if($1 == "xkb_layout") {print name; exit}}')

MANPAGE=$(man --where xkeyboard-config)
case `file -bi $MANPAGE | grep -o "^[^/]*/[^;]*"` in
    'application/x-gzip') CAT='zcat';;
    'application/x-bzip2') CAT='bzcat';;
    'application/x-tar') CAT='tar -O -xf';;
    'application/x-xz') CAT='xzcat';;
    'text/plain') CAT='cat';;
esac

while true; do
    ACTIVE_LANGUAGE=$(swaymsg -t get_inputs | grep -5 $KEYBOARD | tail -1 | sed 's/.*"\(.*\)".*$/\1/gi')
    $CAT $MANPAGE | awk -F'[\t(]' -v var="$ACTIVE_LANGUAGE" 'index($0,var)>=1 {print $1; exit}'

    sleep 1
done

.config/waybar/config

    "custom/layout": {
        "exec": "~/.config/waybar/modules/layout.sh", // DO NOT RUN multiple times
        "format": "{} "
    }

eternal-sorrow · 2019-05-17T03:58:56Z

Here's my python version. You'll need the latest git version of acrisci/i3ipc-python installed.
Set KBD_NAME to the name of your keyboard device (see swaymsg -t get_inputs).

#!/usr/bin/env -S python3 -u

import time
import i3ipc

KBD_NAME = "1:1:AT_Translated_Set_2_keyboard"

sway = i3ipc.Connection()

while True:
	inputs = sway.get_inputs()
	keyboard = [i for i in inputs if i['identifier'] == KBD_NAME][0]
	layout = keyboard['xkb_active_layout_name']
	print(layout[:2].lower())
	time.sleep(1)

crabvk · 2019-12-01T12:17:13Z

We can get updates from swaymsg -mrt subscribe (no "interval" setting needed) #85 (comment)

exdeniz · 2019-12-25T07:01:07Z

Here's my python version. You'll need the latest git version of acrisci/i3ipc-python installed.
Set KBD_NAME to the name of your keyboard device (see swaymsg -t get_inputs).

#!/usr/bin/env -S python3 -u

import time
import i3ipc

KBD_NAME = "1:1:AT_Translated_Set_2_keyboard"

sway = i3ipc.Connection()

while True:
	inputs = sway.get_inputs()
	keyboard = [i for i in inputs if i['identifier'] == KBD_NAME][0]
	layout = keyboard['xkb_active_layout_name']
	print(layout[:2].lower())
	time.sleep(1)

Not work for me.

print inputs [<i3ipc.replies.InputReply object at 0x7f988d156dc0>, <i3ipc.replies.InputReply object at 0x7f988d1379d0>, <i3ipc.replies.InputReply object at 0x7f988d137b50>, <i3ipc.replies.InputReply object at 0x7f988cfc0910>, <i3ipc.replies.InputReply object at 0x7f988cd69d60>, <i3ipc.replies.InputReply object at 0x7f988cd69dc0>, <i3ipc.replies.InputReply object at 0x7f988cd69e20>, <i3ipc.replies.InputReply object at 0x7f988cd69e50>, <i3ipc.replies.InputReply object at 0x7f988cd69e80>, <i3ipc.replies.InputReply object at 0x7f988cd69eb0>]
Traceback (most recent call last):
  File "./layout.py", line 13, in <module>
    keyboard = [i for i in inputs if i['identifier'] == KBD_NAME][0]
  File "./layout.py", line 13, in <listcomp>
    keyboard = [i for i in inputs if i['identifier'] == KBD_NAME][0]
TypeError: 'InputReply' object is not subscriptable

eternal-sorrow · 2019-12-25T09:32:30Z

@exdeniz This version is very outdated. It uses polling and old i3ipc API. Use that one #85 (comment) or one of others from that thread.

vyamkovyi · 2020-01-13T18:06:03Z

Sway IPC protocol now has subscribe message type. Here is my Waybar config entry that prints current layout:

"custom/layout": {
    "tooltip": false,
    "exec": "swaymsg -mrt subscribe '[\"input\"]' | jq -r --unbuffered \"select(.change == \\\"xkb_layout\\\") | .input | select(.identifier == \\\"1:1:AT_Translated_Set_2_keyboard\\\" and .type == \\\"keyboard\\\") | .xkb_active_layout_name | .[0:2] | ascii_upcase\""
},

However:

When killed, Waybar disowns sh process and it keeps running until you kill swaymsg -mrt subscribe ["input"] process.
Notice that "1:1:AT_Translated_Set_2_keyboard" - it seems that keyboard identification is a fundamental problem to wayland protocol. There seems to be no reliable way to differentiate between a real keyboard and "keyboards" that are actually power buttons and other special buttons.
Remember to install jq

I would be really happy to see this inside Waybar.

krtko1 · 2020-01-15T00:22:24Z

@Hexawolf I created pull request with waybar module which shows keyboard layout. Yes it still use 1:1:AT_Translated_Set_2_keyboard but only on startup. Also it can show short layout names from /usr/share/X11/xkb/rules/evdev.xml.

vyamkovyi · 2020-01-18T22:14:08Z

One might want to use a more generic version while pull request is still not merged:

"custom/layout": {
    "tooltip": false,
    "exec": "swaymsg -mrt subscribe '[\"input\"]' | jq -r --unbuffered \"select(.change == \\\"xkb_lay
out\\\") | .input | select(.type == \\\"keyboard\\\") | .xkb_active_layout_name | .[0:2] | ascii_upcase\""
}

donnex · 2020-02-16T16:34:50Z

I just built a little bit on the previous answers and uses the following to show flags for layouts in waybar.

"custom/keyboard_layout": {
    "exec": "waybar_sway_keyboard_layout",
    "tooltip": false
}

waybar_sway_keyboard_layout

#!/bin/sh

DEFAULT_LAYOUT="English (US)"

# Kill old instances since waybar don't kill them when exited
[ "$(pgrep -a 'swaymsg' | grep -c '["input"]')" -gt 0 ] &&
  pgrep -a 'swaymsg' | grep '["input"]' | cut -d ' ' -f1 | xargs -r kill

# Sleep for a short while in order to prevent startup issues in waybar
sleep 0.5

keyboard_flag() {
  while read -r layout; do
    if [ "$layout" = "English (US)" ]; then
      layout_waybar="🇺🇸"
    elif [ "$layout" = "Swedish" ]; then
      layout_waybar="🇸🇪"
    else
      layout_waybar="$layout"
    fi

    printf '%s\n' "$layout_waybar"
  done
}

echo "$DEFAULT_LAYOUT" | keyboard_flag
swaymsg -mrt subscribe '["input"]' | jq -r --unbuffered "select(.change == \"xkb_layout\") | .input | select(.type == \"keyboard\") | .xkb_active_layout_name" | keyboard_flag

vyamkovyi · 2020-03-01T06:59:24Z

I made a simple C program for displaying layouts using sway IPC subscription:
https://github.com/Hexawolf/swaylay

BlueGone · 2020-04-10T18:16:30Z

#659 should solve this.

asahaf · 2020-04-11T09:01:35Z

I've a custom python script to get the layout using i3ipc library (python-i3ipc). it subscribes to input changes to get notified when the layout changes without the need to poll in a loop.

xkblayout.py:

#!/usr/bin/env -S python3 -u
# vi:syntax=python


import os
import signal

import i3ipc

pri_layout_code = "EN"
sec_layout_code = "AR"
sec_layout_name = "arabic"
input_event_change = "xkb_layout"

sway_sock_path = os.environ["SWAYSOCK"]
sway = i3ipc.Connection(socket_path=sway_sock_path, auto_reconnect=False)


def on_posix_signal(sig, frame):
    sway.main_quit()


signal.signal(signal.SIGHUP, on_posix_signal)
signal.signal(signal.SIGINT, on_posix_signal)
signal.signal(signal.SIGQUIT, on_posix_signal)
signal.signal(signal.SIGTERM, on_posix_signal)

# print the primary layout as it's the default
print(pri_layout_code)


def on_input_change(conn, event):
    if event.change != input_event_change:
        return
    if event.input.xkb_active_layout_name.lower() == sec_layout_name:
        print(sec_layout_code)
    else:
        print(pri_layout_code)


def on_shutdown_or_reload(conn, event):
    conn.main_quit()


sway.on(i3ipc.Event.INPUT, on_input_change)
sway.on(i3ipc.Event.SHUTDOWN, on_shutdown_or_reload)
sway.on(i3ipc.Event.SHUTDOWN_EXIT, on_shutdown_or_reload)
sway.on(i3ipc.Event.SHUTDOWN_RESTART, on_shutdown_or_reload)
sway.on(i3ipc.Event.BARCONFIG_UPDATE, on_shutdown_or_reload)
sway.main()

make sure you make xkblayout.py executable

config:

.......
.......
"custom/xkblayout": {
        "exec": "path/to/xkblayout.py",
        "format": " {}",
        "tooltip": false
    },
.......
.......

krtko1 · 2020-04-11T09:35:21Z

if I read correctly, #659 also interact just to input change

asahaf · 2020-04-11T10:04:06Z

@krtko1 yes it does subscribe to input change events

mxkrsv · 2020-10-03T11:36:08Z

I rewrote a jq version in sed and embedded it into the single 'exec' object, so it doesn't need any external script execuion:

"exec": "swaymsg --type get_inputs | grep \"xkb_active_layout_name\" | sed -u '1!d; s/^.*xkb_active_layout_name\": \"//; s/ (US)//; s/\",//' && swaymsg --type subscribe --monitor '[\"input\"]' | sed -u 's/^.*xkb_active_layout_name\": \"//; s/\",.*$//; s/ (US)//'",

kblcuk · 2021-01-10T19:38:52Z

FWIW those running Waybar in Sway can just use sway/language: https://github.com/Alexays/Waybar/blob/master/man/waybar-sway-language.5.scd

tigerjack · 2021-01-12T12:39:48Z

FWIW those running Waybar in Sway can just use sway/language: https://github.com/Alexays/Waybar/blob/master/man/waybar-sway-language.5.scd

Great, I just added it and it seems to work. Do you think it would be possible to add also the variant together with the layout name?

Anakael · 2021-04-18T22:57:02Z

Any updates here?

hirmanpour · 2021-07-11T08:55:52Z

Two enhancements to sway/language could be added:

The first is to minimally differentiate between several keyboards belonging to the same language by adding an index to the indicator. For example, I use a standard US keyboard and a US keyboard with dead keys. They both show as EN. In Gnome they would show as EN1 and EN2
The second, perhaps easier to implement, is to offer the formatting option to show the full name of the keyboard used : e.g. "US Intl Keyboard (with dead keys)" could be displayed when hovering on the indicator.

Anakael · 2021-07-11T11:41:15Z

@hirmanpour
I think I can implement the first option.

hirmanpour · 2021-07-23T07:39:40Z

That would be great !

As a side note regarding the first option, according to ArchWiki one can get the current layout with this command:

swaymsg -t get_inputs | jq -r '.[] | select(.identifier == "kbd_identifier") | .xkb_active_layout_name'

But that depends on kbd_identifier, which is different for each computer model.

For a plug-in general solution, one would need, unless a kbd_identifier is manually specified by the end user, to automatically extract the kbd_identifier from the list of inputs (assuming there is only one input with type "keyboard" attached, which seems a reasonable assumption that would work for 99%+ of users), and feed it into this command.

bnjw5jhyxn · 2021-07-23T16:25:35Z

@hirmanpour I might just be in the 1% of users who got unlucky here, but here is the output of

swaymsg -t get_inputs | jq -r '.[] | select(.type == "keyboard") | .identifier'

on my laptop:

0:0:HP_WMI_hotkeys
0:0:HP_Wireless_hotkeys
1:1:AT_Translated_Set_2_keyboard
1032:21248:HP_Wide_Vision_HD_Camera:_HP_Wi
0:1:Power_Button
0:6:Video_Bus
0:1:Power_Button

Anakael · 2021-07-23T16:45:34Z

@hirmanpour
Implemented in #1159

hirmanpour · 2021-07-23T19:23:09Z

@bnjw5jhyxn Oh god ! Lucky one percenter ;-)

Could it be that I might also be the proud owner of 7 keyboards, without knowing it ???

hirmanpour · 2021-07-23T19:27:50Z

@Anakael Many thanks !

gbrlsnchs · 2021-07-28T14:20:07Z

Does this only work for Sway?

Anakael · 2021-07-28T14:50:35Z

@gbrlsnchs
Yes, sway/language works only with sway.

soppelmann · 2021-08-19T14:35:33Z

sway/language currently doesn't differentiate between English layouts.
I use a UK keyboard on my laptop and a US keyboard at home but both show up as EN.
English is the language not the layout. Perhaps a sway/layout would be a better name.

Anakael · 2021-08-19T15:29:50Z

sway/language currently doesn't differentiate between English layouts.
I use a UK keyboard on my laptop and a US keyboard at home but both show up as EN.
English is the language not the layout. Perhaps a sway/layout would be a better name.

Renaming the module name will break compatibility.

Anakael · 2021-08-19T18:36:37Z

sway/language currently doesn't differentiate between English layouts.
I use a UK keyboard on my laptop and a US keyboard at home but both show up as EN.

keyboard != layout.

With last update UK layout should be written as gb for flag {name} and English (UK) for {long} flag.

boredland · 2022-01-08T00:38:19Z

I really like the default sway/language module, but would it be possible to display it conditionally if there is more than one layout configured? otherwise it is wasting that precious space 🌴

keithbowes · 2022-02-26T22:27:32Z

setxkbmap -query | grep layout | cut -f2 -d":" | tr -d '[:space:]'

bash: setxkbmap: Command not found

Hm.

Anakael · 2022-02-27T10:17:31Z

could you try install libxkbcommon?

Alexays added the enhancement New feature or request label Oct 28, 2018

krtko1 mentioned this issue Jan 15, 2020

Add module for keyboard layout #556

Open

BlueGone mentioned this issue Apr 7, 2020

IMPORTANT: 1.0.0 Release 🎉 #650

Closed

Alexays added this to the 1.0.0 milestone Apr 7, 2020

BlueGone mentioned this issue Apr 10, 2020

Keyboard layout module #659

Closed

Arnaudv6 mentioned this issue Jun 13, 2020

[feature] power management button #202

Open

boredland mentioned this issue Jan 8, 2022

show keyboard layout in waybar only if more than one layout configured manjaro-sway/manjaro-sway#183

Open

boredland mentioned this issue Jun 25, 2023

💡 Waybar Rearrangement manjaro-sway/manjaro-sway#541

Closed

1 task

Alexays closed this as completed May 6, 2024

Feature request: keyboard layout #66

Feature request: keyboard layout #66

Comments

eternal-sorrow commented Oct 28, 2018

harishkrupo commented Oct 31, 2018

eternal-sorrow commented Nov 1, 2018

harishkrupo commented Nov 2, 2018

alecmev commented Nov 2, 2018

harishkrupo commented Nov 4, 2018

ghost commented Dec 24, 2018

harishkrupo commented Dec 24, 2018

ghost commented Apr 1, 2019

krtko1 commented May 15, 2019 • edited Loading

eternal-sorrow commented May 15, 2019 • edited Loading

krtko1 commented May 16, 2019

eternal-sorrow commented May 17, 2019

crabvk commented Dec 1, 2019

exdeniz commented Dec 25, 2019

eternal-sorrow commented Dec 25, 2019 • edited Loading

vyamkovyi commented Jan 13, 2020 • edited Loading

krtko1 commented Jan 15, 2020 • edited Loading

vyamkovyi commented Jan 18, 2020

donnex commented Feb 16, 2020

vyamkovyi commented Mar 1, 2020

BlueGone commented Apr 10, 2020

asahaf commented Apr 11, 2020 • edited Loading

krtko1 commented Apr 11, 2020

asahaf commented Apr 11, 2020

mxkrsv commented Oct 3, 2020 • edited Loading

kblcuk commented Jan 10, 2021

tigerjack commented Jan 12, 2021

Anakael commented Apr 18, 2021

hirmanpour commented Jul 11, 2021

Anakael commented Jul 11, 2021

hirmanpour commented Jul 23, 2021

bnjw5jhyxn commented Jul 23, 2021

Anakael commented Jul 23, 2021

hirmanpour commented Jul 23, 2021

hirmanpour commented Jul 23, 2021

gbrlsnchs commented Jul 28, 2021

Anakael commented Jul 28, 2021

soppelmann commented Aug 19, 2021

Anakael commented Aug 19, 2021

Anakael commented Aug 19, 2021

boredland commented Jan 8, 2022 • edited Loading

keithbowes commented Feb 26, 2022

Anakael commented Feb 27, 2022

krtko1 commented May 15, 2019 •

edited

Loading

eternal-sorrow commented May 15, 2019 •

edited

Loading

eternal-sorrow commented Dec 25, 2019 •

edited

Loading

vyamkovyi commented Jan 13, 2020 •

edited

Loading

krtko1 commented Jan 15, 2020 •

edited

Loading

asahaf commented Apr 11, 2020 •

edited

Loading

mxkrsv commented Oct 3, 2020 •

edited

Loading

boredland commented Jan 8, 2022 •

edited

Loading