1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
|
# Copyright © 2016 Red Hat, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
import libevdev
import os
import ctypes
import errno
from ctypes import c_char_p
from ctypes import c_int
from ctypes import c_uint
from ctypes import c_void_p
from ctypes import c_long
from ctypes import c_int32
from ctypes import c_uint16
from typing import BinaryIO, Tuple
try:
from typing import Self
except ImportError:
from typing_extensions import Self
READ_FLAG_SYNC = 0x1
READ_FLAG_NORMAL = 0x2
READ_FLAG_FORCE_SYNC = 0x4
READ_FLAG_BLOCKING = 0x8
class _InputAbsinfo(ctypes.Structure):
_fields_ = [
("value", c_int32),
("minimum", c_int32),
("maximum", c_int32),
("fuzz", c_int32),
("flat", c_int32),
("resolution", c_int32),
]
class _InputEvent(ctypes.Structure):
_fields_ = [
("sec", c_long),
("usec", c_long),
("type", c_uint16),
("code", c_uint16),
("value", c_int32),
]
class _LibraryWrapper:
"""
Base class for wrapping a shared library. Do not use directly.
"""
_lib = None # The shared library, shared between instances of the class
# List of API prototypes, must be set by the subclass
_api_prototypes = {
# "function_name" : {
# "argtypes": [c_void_p, c_char_p, etc. ], # arguments
# "restype": c_void_p, # return type
# "restype": c_void_p, # return type
# }
}
def __init__(self):
super().__init__()
self._load()
@classmethod
def _load(cls) -> ctypes.CDLL:
if cls._lib is not None:
return cls._lib
cls._lib = cls._cdll()
for name, attrs in cls._api_prototypes.items():
func = getattr(cls._lib, name)
func.argtypes = attrs["argtypes"]
func.restype = attrs["restype"]
# default name is the libevdev name minus the libevdev prefix
# This makes all functions hidden and require
# one-by-one-mapping
prefix = len("libevdev")
pyname = dict.get(attrs, "name", name[prefix:])
setattr(cls, pyname, func)
return cls._lib
@staticmethod
def _cdll() -> ctypes.CDLL:
"""Override in subclass"""
raise NotImplementedError
class Libevdev(_LibraryWrapper):
"""
This class provides a wrapper around the libevdev C library.
The API is modelled closely after the C API. API documentation in this
document only lists the specific behavior of the Python API. For
information on the behavior of libevdev itself, see
https://www.freedesktop.org/software/libevdev/doc/latest/
Properties in this class are read-write unless specified otherwise.
.. warning::
Do not use this class directly
"""
@staticmethod
def _cdll() -> ctypes.CDLL:
return ctypes.CDLL("libevdev.so.2", use_errno=True)
_api_prototypes = {
# const char *libevdev_event_type_get_name(unsigned int type);
"libevdev_event_type_get_name": {"argtypes": (c_uint,), "restype": c_char_p},
# int libevdev_event_type_from_name(const char *name);
"libevdev_event_type_from_name": {"argtypes": (c_char_p,), "restype": c_int},
# const char *libevdev_event_code_get_name(unsigned int type, unsigned int code);
"libevdev_event_code_get_name": {
"argtypes": (
c_uint,
c_uint,
),
"restype": c_char_p,
},
# int libevdev_event_code_from_name(unsigned int type, const char *name);
"libevdev_event_code_from_name": {
"argtypes": (
c_uint,
c_char_p,
),
"restype": c_int,
},
# const char *libevdev_event_value_get_name(unsigned int type, unsigned int code, int value);
"libevdev_event_value_get_name": {
"argtypes": (
c_uint,
c_uint,
c_int,
),
"restype": c_char_p,
},
# int libevdev_event_value_from_name(unsigned int type, unsigned int code, const char *name);
"libevdev_event_value_from_name": {
"argtypes": (
c_uint,
c_uint,
c_char_p,
),
"restype": c_int,
},
# const char *libevdev_property_get_name(unsigned int prop);
"libevdev_property_get_name": {
"argtypes": (c_uint,),
"restype": c_char_p,
},
# int libevdev_property_from_name(const char *name);
"libevdev_property_from_name": {"argtypes": (c_char_p,), "restype": c_int},
# void libevdev_event_type_get_max(int)
"libevdev_event_type_get_max": {
"argtypes": (c_int,),
"restype": c_int,
},
# struct libevdev *libevdev_new(void);
"libevdev_new": {
"argtypes": (),
"restype": c_void_p,
},
# struct libevdev *libevdev_free(struct libevdev *);
"libevdev_free": {
"argtypes": (c_void_p,),
"restype": None,
},
###############################
# Simple getters and setters #
###############################
# const char * libevdev_get_name(struct libevdev *);
"libevdev_get_name": {
"argtypes": (c_void_p,),
"restype": c_char_p,
},
# void libevdev_set_name(struct libevdev *, const char*);
"libevdev_set_name": {
"argtypes": (c_void_p, c_char_p),
"restype": None,
},
# const char * libevdev_get_phys(struct libevdev *);
"libevdev_get_phys": {
"argtypes": (c_void_p,),
"restype": c_char_p,
},
# void libevdev_set_phys(struct libevdev *, const char*);
"libevdev_set_phys": {
"argtypes": (c_void_p, c_char_p),
"restype": None,
},
# const char * libevdev_get_uniq(struct libevdev *);
"libevdev_get_uniq": {
"argtypes": (c_void_p,),
"restype": c_char_p,
},
# void libevdev_set_uniq(struct libevdev *, const char*);
"libevdev_set_uniq": {
"argtypes": (c_void_p, c_char_p),
"restype": None,
},
# int libevdev_get_driver_version(struct libevdev *);
"libevdev_get_driver_version": {
"argtypes": (c_void_p,),
"restype": c_int,
},
# void libevdev_set_clock_id(struct libevdev *, int)
"libevdev_set_clock_id": {
"argtypes": (c_void_p, c_int),
"restype": c_int,
},
###############################
# Custom getters and setters #
###############################
# int libevdev_get_id_bustype(struct libevdev *)
"libevdev_get_id_bustype": {
"argtypes": (c_void_p,),
"restype": c_int,
},
# int libevdev_get_id_vendor(struct libevdev *)
"libevdev_get_id_vendor": {
"argtypes": (c_void_p,),
"restype": c_int,
},
# int libevdev_get_id_product(struct libevdev *)
"libevdev_get_id_product": {
"argtypes": (c_void_p,),
"restype": c_int,
},
# int libevdev_get_id_version(struct libevdev *)
"libevdev_get_id_version": {
"argtypes": (c_void_p,),
"restype": c_int,
},
# void libevdev_set_id_bustype(struct libevdev *, int)
"libevdev_set_id_bustype": {
"argtypes": (c_void_p, c_int),
"restype": None,
},
# void libevdev_set_id_vendor(struct libevdev *, int)
"libevdev_set_id_vendor": {
"argtypes": (c_void_p, c_int),
"restype": None,
},
# void libevdev_set_id_product(struct libevdev *, int)
"libevdev_set_id_product": {
"argtypes": (c_void_p, c_int),
"restype": None,
},
# void libevdev_set_id_version(struct libevdev *, int)
"libevdev_set_id_version": {
"argtypes": (c_void_p, c_int),
"restype": None,
},
# int libevdev_set_fd(struct libevdev *, int)
"libevdev_set_fd": {
"argtypes": (c_void_p, c_int),
"restype": c_int,
},
# int libevdev_change_fd(struct libevdev *, int)
"libevdev_change_fd": {
"argtypes": (c_void_p, c_int),
"restype": c_int,
},
# int libevdev_get_fd(struct libevdev *)
"libevdev_get_fd": {
"argtypes": (c_void_p,),
"restype": c_int,
},
# int libevdev_grab(struct libevdev *)
"libevdev_grab": {
"argtypes": (c_void_p, c_int),
"restype": c_int,
},
# const struct input_absinfo *libevdev_get_abs_info(struct libevdev*, int code)
"libevdev_get_abs_info": {
"argtypes": (c_void_p, c_int),
"restype": ctypes.POINTER(_InputAbsinfo),
},
# We don't need to wrap libevdev_set_abs_info(), we get the same
# using get_abs_info and overwrite the values.
#
# const struct input_absinfo *libevdev_get_abs_info(struct libevdev*, int code)
"libevdev_kernel_set_abs_info": {
"argtypes": (c_void_p, c_int, ctypes.POINTER(_InputAbsinfo)),
"restype": (c_int),
},
# int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int, enum libevdev_led_value);
"libevdev_kernel_set_led_value": {
"argtypes": (c_void_p, c_int, c_int),
"restype": (c_int),
},
##########################
# Various has_ functions #
##########################
"libevdev_has_property": {"argtypes": (c_void_p, c_int), "restype": (c_int)},
"libevdev_has_event_type": {"argtypes": (c_void_p, c_int), "restype": (c_int)},
"libevdev_has_event_code": {
"argtypes": (c_void_p, c_int, c_int),
"restype": (c_int),
},
##########################
# Other functions #
##########################
"libevdev_set_event_value": {
"argtypes": (c_void_p, c_int, c_int, c_int),
"restype": (c_int),
},
"libevdev_get_event_value": {
"argtypes": (c_void_p, c_int, c_int),
"restype": (c_int),
},
"libevdev_enable_event_type": {
"argtypes": (c_void_p, c_int),
"restype": (c_int),
},
"libevdev_enable_event_code": {
"argtypes": (c_void_p, c_int, c_int, c_void_p),
"restype": (c_int),
},
"libevdev_disable_event_type": {
"argtypes": (c_void_p, c_int),
"restype": (c_int),
},
"libevdev_disable_event_code": {
"argtypes": (c_void_p, c_int, c_int),
"restype": (c_int),
},
"libevdev_enable_property": {
"argtypes": (c_void_p, c_int),
"restype": (c_int),
},
"libevdev_next_event": {
"argtypes": (c_void_p, c_uint, ctypes.POINTER(_InputEvent)),
"restype": c_int,
},
"libevdev_get_num_slots": {
"argtypes": (c_void_p,),
"restype": c_int,
},
"libevdev_get_current_slot": {
"argtypes": (c_void_p,),
"restype": c_int,
},
"libevdev_get_slot_value": {
"argtypes": (c_void_p, c_uint, c_uint),
"restype": c_int,
},
"libevdev_set_slot_value": {
"argtypes": (c_void_p, c_uint, c_uint, c_int),
"restype": c_int,
},
"libevdev_has_event_pending": {
"argtypes": (c_void_p,),
"restype": c_int,
},
}
def __init__(self, fd: BinaryIO | None = None):
"""
:param fd: A file-like object
Create a new libevdev instance. If a file is given this call is
equivalent to ``libevdev_new_from_fd()``, otherwise it is equivalent
to ``libevdev_new()``::
fd = open("/dev/input/event0", "rb")
l = libevdev.Libevdev(fd)
# l now represents the device on event0
l2 = libevdev.Libevdev()
l2.name = "test device"
l2.enable("EV_REL", "REL_X")
# l2 is an unbound device with the REL_X bit set
"""
super().__init__()
self._ctx = self._new()
self._file = None
if fd is not None:
self.fd = fd
def __del__(self):
if hasattr(self, "_ctx"):
self._free(self._ctx)
@property
def name(self) -> str:
"""
:return: A string with the device's kernel name.
"""
return self._get_name(self._ctx).decode("iso8859-1")
@name.setter
def name(self, name: str | None):
if name is None:
name = ""
return self._set_name(self._ctx, name.encode("iso8859-1"))
@property
def phys(self) -> str | None:
"""
:return: A string with the device's kernel phys or None.
"""
phys = self._get_phys(self._ctx)
if not phys:
return None
return phys.decode("iso8859-1")
@phys.setter
def phys(self, phys: str | None):
# libevdev issue: phys may be NULL, but can't be set to NULL
if phys is None:
phys = ""
return self._set_phys(self._ctx, phys.encode("iso8859-1"))
@property
def uniq(self) -> str | None:
"""
:return: A string with the device's kernel uniq or None.
"""
uniq = self._get_uniq(self._ctx)
if not uniq:
return None
return uniq.decode("iso8859-1")
@uniq.setter
def uniq(self, uniq):
# libevdev issue: uniq may be NULL, but can't be set to NULL
if uniq is None:
uniq = ""
return self._set_uniq(self._ctx, uniq.encode("iso8859-1"))
@property
def driver_version(self) -> int:
"""
:note: Read-only
"""
return self._get_driver_version(self._ctx)
@property
def id(self) -> dict[str, int]:
"""
:return: A dict with the keys 'bustype', 'vendor', 'product', 'version'.
When used as a setter, only existing keys are applied to the
device. For example, to update the product ID only::
ctx = Libevdev()
id["property"] = 1234
ctx.id = id
This is a combined version of the libevdev calls
``libevdev_get_id_busytype()``, ``libevdev_get_id_vendor()``,
``libevdev_get_id_product()``, ``libevdev_get_id_version()`` and the
respective setters.
"""
bus = self._get_id_bustype(self._ctx)
vdr = self._get_id_vendor(self._ctx)
pro = self._get_id_product(self._ctx)
ver = self._get_id_version(self._ctx)
return {"bustype": bus, "vendor": vdr, "product": pro, "version": ver}
@id.setter
def id(self, vals: dict[str, int]):
if "bustype" in vals:
self._set_id_bustype(self._ctx, vals["bustype"])
if "vendor" in vals:
self._set_id_vendor(self._ctx, vals["vendor"])
if "product" in vals:
self._set_id_product(self._ctx, vals["product"])
if "version" in vals:
self._set_id_version(self._ctx, vals["version"])
def set_clock_id(self, clock: int) -> int:
"""
:param clock: time.CLOCK_MONOTONIC
:return: a negative errno on failure or 0 on success.
"""
return self._set_clock_id(self._ctx, clock)
@property
def fd(self) -> BinaryIO | None:
"""
:return: The file-like object used during constructor or in the most
recent assignment to self.fd.
When assigned the first time and no file has been passed to the
constructor, the assignment is equivalent to ``libevdev_set_fd()``.
Subsequently, any assignments are equivalent to
``libevdev_change_fd``::
fd = open("/dev/input/event0", "rb")
l = libevdev.Libevdev(fd)
assert(l.fd == fd)
fd2 = open("/dev/input/event0", "rb")
l.fd = fd2
assert(l.fd == fd2)
l = libevdev.Libevdev()
l.fd = fd
assert(l.fd == fd)
l.fd = fd2
assert(l.fd == fd2)
:note: libevdev uses the ``fileno()`` of the object.
"""
return self._file
@fd.setter
def fd(self, fileobj: BinaryIO):
try:
fd = fileobj.fileno()
except AttributeError:
raise libevdev.InvalidFileError
if self._file is None:
r = self._set_fd(self._ctx, fd)
else:
r = self._change_fd(self._ctx, fd)
if r != 0:
raise OSError(-r, os.strerror(-r))
# sanity check:
if self._get_fd(self._ctx) != fd:
print("FIXME: fileno() != get_fd()")
self._file = fileobj
def grab(self, enable_grab=True):
"""
:param enable_grab: True to grab, False to ungrab
:return: 0 on success or a negative errno on failure
"""
# libevdev doesn't use 0/1 here but numbered values
if enable_grab:
mode = 3
else:
mode = 4
r = self._grab(self._ctx, mode)
if r != 0:
raise OSError(-r, os.strerror(-r))
def absinfo(
self,
code: int | str,
new_values: dict[str, int] | None = None,
kernel: bool = False,
) -> dict[str, int] | None:
"""
:param code: the ABS_<*> code as integer or as string
:param new_values: a dict with the same keys as the return values.
:param kernel: If True, assigning new values corresponds to ``libevdev_kernel_set_abs_info``
:return: a dictionary with the keys "value", "min", "max",
"resolution", "fuzz", "flat"; ``None`` if the code does not exist on
this device
:note: The returned value is a copy of the value returned by
libevdev. Changing a value in the dictionary does not change the
matching property. To change the device, reassign the
dictionary to the absinfo code.
This is different to the libevdev behavior.
"""
if not isinstance(code, int):
if not code.startswith("ABS_"):
raise ValueError()
code = self.event_to_value("EV_ABS", code)
absinfo = self._get_abs_info(self._ctx, code)
if not absinfo:
return None
if new_values is not None:
if "minimum" in new_values:
absinfo.contents.minimum = new_values["minimum"]
if "maximum" in new_values:
absinfo.contents.maximum = new_values["maximum"]
if "value" in new_values:
absinfo.contents.value = new_values["value"]
if "fuzz" in new_values:
absinfo.contents.fuzz = new_values["fuzz"]
if "flat" in new_values:
absinfo.contents.flat = new_values["flat"]
if "resolution" in new_values:
absinfo.contents.resolution = new_values["resolution"]
if kernel:
rc = self._kernel_set_abs_info(self._ctx, code, absinfo)
if rc != 0:
raise OSError(-rc, os.strerror(-rc))
return {
"value": absinfo.contents.value,
"minimum": absinfo.contents.minimum,
"maximum": absinfo.contents.maximum,
"fuzz": absinfo.contents.fuzz,
"flat": absinfo.contents.flat,
"resolution": absinfo.contents.resolution,
}
@classmethod
def property_to_name(cls, prop) -> str | None:
"""
:param prop: the numerical property value
:return: A string with the property name or ``None``
This function is the equivalent to ``libevdev_property_get_name()``
"""
name = cls._property_get_name(prop)
if not name:
return None
return name.decode("iso8859-1")
@classmethod
def property_to_value(cls, prop) -> int | None:
"""
:param prop: the property name as string
:return: The numerical property value or ``None``
This function is the equivalent to ``libevdev_property_from_name()``
"""
v = cls._property_from_name(prop.encode("iso8859-1"))
if v == -1:
return None
return v
@classmethod
def type_max(cls, type) -> int | None:
"""
:param type: the EV_<*> event type
:return: the maximum code for this type or ``None`` if the type is
invalid
"""
if not isinstance(type, int):
type = cls.event_to_value(type)
m = cls._event_type_get_max(type)
return m if m > -1 else None
@classmethod
def event_to_name(cls, event_type, event_code=None, event_value=None) -> str | None:
"""
:param event_type: the numerical event type value
:param event_code: optional, the numerical event code value
:param event_value: optional, the numerical event value
:return: the event code name if a code is given otherwise the event
type name.
This function is the equivalent to ``libevdev_event_value_get_name()``,
``libevdev_event_code_get_name()``, and ``libevdev_event_type_get_name()``
"""
if event_code is not None and event_value is not None:
name = cls._event_value_get_name(event_type, event_code, event_value)
elif event_code is not None:
name = cls._event_code_get_name(event_type, event_code)
else:
name = cls._event_type_get_name(event_type)
if not name:
return None
return name.decode("iso8859-1")
@classmethod
def event_to_value(
cls, event_type, event_code=None, event_value=None
) -> int | None:
"""
:param event_type: the event type as string
:param event_code: optional, the event code as string
:param event_value: optional, the numerical event value
:return: the event code value if a code is given otherwise the event
type value.
This function is the equivalent to ``libevdev_event_value_from_name()``,
``libevdev_event_code_from_name()`` and ``libevdev_event_type_from_name()``
"""
if event_code is not None and event_value is not None:
if not isinstance(event_type, int):
event_type = cls.event_to_value(event_type)
if not isinstance(event_code, int):
event_code = cls.event_to_value(event_type, event_code)
v = cls._event_value_from_name(
event_type, event_code, event_value.encode("iso8859-1")
)
elif event_code is not None:
if not isinstance(event_type, int):
event_type = cls.event_to_value(event_type)
v = cls._event_code_from_name(event_type, event_code.encode("iso8859-1"))
else:
v = cls._event_type_from_name(event_type.encode("iso8859-1"))
if v == -1:
return None
return v
def has_property(self, prop: int | str) -> bool:
"""
:param prop: a property, either as integer or string
:return: True if the device has the property, False otherwise
"""
if not isinstance(prop, int):
prop = self.property_to_value(prop)
r = self._has_property(self._ctx, prop)
return bool(r)
def has_event(
self, event_type: int | str, event_code: int | str | None = None
) -> bool:
"""
:param event_type: the event type, either as integer or as string
:param event_code: optional, the event code, either as integer or as
string
:return: True if the device has the type and/or code, False otherwise
"""
if not isinstance(event_type, int):
event_type = self.event_to_value(event_type)
if event_code is None:
r = self._has_event_type(self._ctx, event_type)
else:
if not isinstance(event_code, int):
event_code = self.event_to_value(event_type, event_code)
r = self._has_event_code(self._ctx, event_type, event_code)
return bool(r)
def _code(self, t: int | str, c: int | str | None) -> Tuple[int, int]:
"""
Resolves a type+code tuple, either of which could be integer or
string. Returns a (t, c) tuple in integers
"""
if not isinstance(t, int):
tv = self.event_to_value(t)
else:
tv = t
if c is not None and not isinstance(c, int):
cv = self.event_to_value(t, c)
else:
cv = c
return (tv, cv)
def event_value(
self, event_type: int | str, event_code: int | str, new_value: int | None = None
) -> int | None:
"""
:param event_type: the event type, either as integer or as string
:param event_code: the event code, either as integer or as string
:param new_value: optional, the value to set to
:return: the current value of type + code, or ``None`` if it doesn't
exist on this device
"""
t, c = self._code(event_type, event_code)
if not self.has_event(t, c):
return None
if new_value is not None:
self._set_event_value(self._ctx, t, c, new_value)
v = self._get_event_value(self._ctx, t, c)
return v
@property
def num_slots(self) -> int | None:
"""
:return: the number of slots on this device or ``None`` if this device
does not support slots
:note: Read-only
"""
s = self._get_num_slots(self._ctx)
return s if s >= 0 else None
@property
def current_slot(self) -> int | None:
"""
:return: the current of slots on this device or ``None`` if this device
does not support slots
:note: Read-only
"""
s = self._get_current_slot(self._ctx)
return s if s >= 0 else None
def slot_value(
self, slot: int, event_code: int | str, new_value: int | None = None
) -> int | None:
"""
:param slot: the numeric slot number
:param event_code: the ABS_<*> event code, either as integer or string
:param new_value: optional, the value to set this slot to
:return: the current value of the slot's code, or ``None`` if it doesn't
exist on this device
"""
t, c = self._code("EV_ABS", event_code)
if new_value is not None:
self._set_slot_value(self._ctx, slot, c, new_value)
v = self._get_slot_value(self._ctx, slot, c)
return v
def enable(
self,
event_type: int | str,
event_code: int | str | None = None,
data: dict[str, int] | int | None = None,
):
"""
:param event_type: the event type, either as integer or as string
:param event_code: optional, the event code, either as integer or as string
:param data: if event_code is not ``None``, data points to the
code-specific information.
If event_type is EV_ABS, then data must be a dictionary as returned
from absinfo. Any keys missing are replaced with 0, i.e. the
following example is valid and results in a fuzz/flat/resolution of
zero::
ctx = Libevdev()
abs = { "minimum" : 0,
"maximum" : 100 }
ctx.enable("EV_ABS", "ABS_X", data)
If event_type is EV_REP, then data must be an integer.
"""
t, c = self._code(event_type, event_code)
if c is None:
self._enable_event_type(self._ctx, t)
else:
if t == 0x03: # EV_ABS
assert isinstance(data, dict)
absinfo = _InputAbsinfo(
data.get("value", 0),
data.get("minimum", 0),
data.get("maximum", 0),
data.get("fuzz", 0),
data.get("flat", 0),
data.get("resolution", 0),
)
data_arg = ctypes.pointer(absinfo)
elif t == 0x14: # EV_REP
assert isinstance(data, int)
data_arg = ctypes.pointer(c_int(data))
else:
data_arg = None
self._enable_event_code(self._ctx, t, c, data_arg)
def disable(self, event_type: int | str, event_code: int | str | None = None):
"""
:param event_type: the event type, either as integer or as string
:param event_code: optional, the event code, either as integer or as string
"""
t, c = self._code(event_type, event_code)
if c is None:
self._disable_event_type(self._ctx, t)
else:
self._disable_event_code(self._ctx, t, c)
def enable_property(self, prop: int | str):
"""
:param prop: the property as integer or string
"""
if not isinstance(prop, int):
prop = self.property_to_value(prop)
self._enable_property(self._ctx, prop)
def set_led(self, led: int | str, on: bool):
"""
:param led: the LED_<*> name
:on: True to turn the LED on, False to turn it off
"""
t, c = self._code("EV_LED", led)
which = 3 if on else 4
self._kernel_set_led_value(self._ctx, c, which)
def next_event(self, flags: int = READ_FLAG_NORMAL) -> _InputEvent | None:
"""
:param flags: a set of libevdev read flags. May be omitted to use
the normal mode.
:return: the next event or ``None`` if no event is available
Event processing should look like this::
fd = open("/dev/input/event0", "rb")
ctx = libevdev.Libevdev(fd)
ev = ctx.next_event()
if ev is None:
print("no event available right now")
elif ev.matches("EV_SYN", "SYN_DROPPED"):
sync_ev = ctx.next_event(libevdev.READ_FLAG_SYNC)
while ev is not None:
print("First event in sync sequence")
sync_ev = ctx.next_event(libevdev.READ_FLAG_SYNC)
print("sync complete")
"""
ev = _InputEvent()
rc = self._next_event(self._ctx, flags, ctypes.byref(ev))
if rc == -errno.EAGAIN:
return None
if rc < 0:
raise OSError(-rc, os.strerror(-rc))
return ev
class _UinputDevice(ctypes.Structure):
pass
class UinputDevice(_LibraryWrapper):
"""
This class provides a wrapper around the libevdev C library
.. warning::
Do not use this class directly
"""
@staticmethod
def _cdll() -> ctypes.CDLL:
return ctypes.CDLL("libevdev.so.2", use_errno=True)
_api_prototypes = {
# int libevdev_uinput_create_from_device(const struct libevdev *, int, struct libevdev_uinput **)
"libevdev_uinput_create_from_device": {
"argtypes": (
c_void_p,
c_int,
ctypes.POINTER(ctypes.POINTER(_UinputDevice)),
),
"restype": c_int,
},
# int libevdev_uinput_destroy(const struct libevdev *)
"libevdev_uinput_destroy": {
"argtypes": (c_void_p,),
"restype": None,
},
# const char* libevdev_uinput_get_devnode(const struct libevdev *)
"libevdev_uinput_get_devnode": {
"argtypes": (c_void_p,),
"restype": c_char_p,
},
# const char* libevdev_uinput_get_syspath(const struct libevdev *)
"libevdev_uinput_get_syspath": {
"argtypes": (c_void_p,),
"restype": c_char_p,
},
# int libevdev_uinput_write_event(const struct libevdev *, uint, uint, int)
"libevdev_uinput_write_event": {
"argtypes": (c_void_p, c_uint, c_uint, c_int),
"restype": c_int,
},
}
def __init__(self, source: Libevdev, fileobj: BinaryIO | None = None):
"""
Create a new uinput device based on the source libevdev device. The
uinput device will mirror all capabilities from the source device.
:param source: A libevdev device with all capabilities set.
:param fileobj: A file-like object to the /dev/uinput node. If None,
libevdev will open the device in managed mode. See the libevdev
documentation for details.
"""
super().__init__()
self._fileobj = fileobj
if fileobj is None:
fd = -2 # UINPUT_OPEN_MANAGED
else:
fd = fileobj.fileno()
self._uinput_device = ctypes.POINTER(_UinputDevice)()
rc = self._uinput_create_from_device(
source._ctx, fd, ctypes.byref(self._uinput_device)
)
if rc != 0:
raise OSError(-rc, os.strerror(-rc))
def __enter__(self) -> Self:
return self
def __exit__(self, *_):
if self._uinput_device is not None:
self._uinput_destroy(self._uinput_device)
self._uinput_device = None
def __del__(self):
if self._uinput_device is not None:
self._uinput_destroy(self._uinput_device)
self._uinput_device = None
@property
def fd(self) -> BinaryIO | None:
"""
:return: the file-like object used in the constructor.
"""
return self._fileobj
def write_event(self, type: int, code: int, value: int) -> None:
self._uinput_write_event(self._uinput_device, type, code, value)
@property
def devnode(self) -> str:
"""
Return a string with the /dev/input/eventX device node
"""
devnode = self._uinput_get_devnode(self._uinput_device)
return devnode.decode("iso8859-1")
@property
def syspath(self) -> str:
"""
Return a string with the /dev/input/eventX device node
"""
syspath = self._uinput_get_syspath(self._uinput_device)
return syspath.decode("iso8859-1")
|