532 lines
21 KiB
Python
532 lines
21 KiB
Python
## Copyright (C) 2012-2013 Daniel Pavel
|
|
## Copyright (C) 2014-2024 Solaar Contributors https://pwr-solaar.github.io/Solaar/
|
|
##
|
|
## This program is free software; you can redistribute it and/or modify
|
|
## it under the terms of the GNU General Public License as published by
|
|
## the Free Software Foundation; either version 2 of the License, or
|
|
## (at your option) any later version.
|
|
##
|
|
## This program is distributed in the hope that it will be useful,
|
|
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
## GNU General Public License for more details.
|
|
##
|
|
## You should have received a copy of the GNU General Public License along
|
|
## with this program; if not, write to the Free Software Foundation, Inc.,
|
|
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
import errno
|
|
import logging
|
|
import time
|
|
|
|
from dataclasses import dataclass
|
|
from typing import Callable
|
|
from typing import Optional
|
|
from typing import Protocol
|
|
from typing import cast
|
|
|
|
import hidapi
|
|
|
|
from solaar.i18n import _
|
|
from solaar.i18n import ngettext
|
|
|
|
from . import base
|
|
from . import exceptions
|
|
from . import hidpp10
|
|
from . import hidpp10_constants
|
|
from .common import Alert
|
|
from .common import Notification
|
|
from .device import Device
|
|
from .hidpp10_constants import Registers
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
_hidpp10 = hidpp10.Hidpp10()
|
|
_IR = hidpp10_constants.INFO_SUBREGISTERS
|
|
|
|
|
|
class LowLevelInterface(Protocol):
|
|
def open_path(self, path):
|
|
...
|
|
|
|
def ping(self, handle, number, long_message=False):
|
|
...
|
|
|
|
def request(self, handle, devnumber, request_id, *params, **kwargs):
|
|
...
|
|
|
|
def close(self, handle):
|
|
...
|
|
|
|
|
|
low_level_interface = cast(LowLevelInterface, base)
|
|
|
|
|
|
@dataclass
|
|
class Pairing:
|
|
"""Information about the current or most recent pairing"""
|
|
|
|
lock_open: bool = False
|
|
discovering: bool = False
|
|
counter: Optional[int] = None
|
|
device_address: Optional[bytes] = None
|
|
device_authentication: Optional[int] = None
|
|
device_kind: Optional[int] = None
|
|
device_name: Optional[str] = None
|
|
device_passkey: Optional[str] = None
|
|
new_device: Optional[Device] = None
|
|
error: Optional[any] = None
|
|
|
|
|
|
class Receiver:
|
|
"""A generic Receiver instance, mostly implementing the interface used on Unifying, Nano, and LightSpeed receivers"
|
|
The paired devices are available through the sequence interface.
|
|
"""
|
|
|
|
read_register: Callable = hidpp10.read_register
|
|
write_register: Callable = hidpp10.write_register
|
|
number = 0xFF
|
|
kind = None
|
|
|
|
def __init__(self, receiver_kind, product_info, handle, path, product_id, setting_callback=None):
|
|
assert handle
|
|
self.isDevice = False # some devices act as receiver so we need a property to distinguish them
|
|
self.handle = handle
|
|
self.path = path
|
|
self.product_id = product_id
|
|
self.setting_callback = setting_callback # for changes to settings
|
|
self.status_callback = None # for changes to other potentially visible aspects
|
|
self.receiver_kind = receiver_kind
|
|
self.serial = None
|
|
self.max_devices = None
|
|
self._firmware = None
|
|
self._remaining_pairings = None
|
|
self._devices = {}
|
|
self.name = product_info.get("name", "Receiver")
|
|
self.may_unpair = product_info.get("may_unpair", False)
|
|
self.re_pairs = product_info.get("re_pairs", False)
|
|
self.notification_flags = None
|
|
self.pairing = Pairing()
|
|
self.initialize(product_info)
|
|
hidpp10.set_configuration_pending_flags(self, 0xFF)
|
|
|
|
def initialize(self, product_info: dict):
|
|
# read the receiver information subregister, so we can find out max_devices
|
|
serial_reply = self.read_register(Registers.RECEIVER_INFO, _IR.receiver_information)
|
|
if serial_reply:
|
|
self.serial = serial_reply[1:5].hex().upper()
|
|
self.max_devices = serial_reply[6]
|
|
if self.max_devices <= 0 or self.max_devices > 6:
|
|
self.max_devices = product_info.get("max_devices", 1)
|
|
else: # handle receivers that don't have a serial number specially (i.e., c534)
|
|
self.serial = None
|
|
self.max_devices = product_info.get("max_devices", 1)
|
|
|
|
def close(self):
|
|
handle, self.handle = self.handle, None
|
|
for _n, d in self._devices.items():
|
|
if d:
|
|
d.close()
|
|
self._devices.clear()
|
|
return handle and base.close(handle)
|
|
|
|
def __del__(self):
|
|
self.close()
|
|
|
|
def changed(self, alert=Alert.NOTIFICATION, reason=None):
|
|
"""The status of the device had changed, so invoke the status callback"""
|
|
if self.status_callback is not None:
|
|
self.status_callback(self, alert=alert, reason=reason)
|
|
|
|
@property
|
|
def firmware(self):
|
|
if self._firmware is None and self.handle:
|
|
self._firmware = _hidpp10.get_firmware(self)
|
|
return self._firmware
|
|
|
|
# how many pairings remain (None for unknown, -1 for unlimited)
|
|
def remaining_pairings(self, cache=True):
|
|
if self._remaining_pairings is None or not cache:
|
|
ps = self.read_register(Registers.RECEIVER_CONNECTION)
|
|
if ps is not None:
|
|
ps = ord(ps[2:3])
|
|
self._remaining_pairings = ps - 5 if ps >= 5 else -1
|
|
return self._remaining_pairings
|
|
|
|
def enable_connection_notifications(self, enable=True):
|
|
"""Enable or disable device (dis)connection notifications on this
|
|
receiver."""
|
|
if not self.handle:
|
|
return False
|
|
|
|
if enable:
|
|
set_flag_bits = hidpp10_constants.NOTIFICATION_FLAG.wireless | hidpp10_constants.NOTIFICATION_FLAG.software_present
|
|
else:
|
|
set_flag_bits = 0
|
|
ok = _hidpp10.set_notification_flags(self, set_flag_bits)
|
|
if ok is None:
|
|
logger.warning("%s: failed to %s receiver notifications", self, "enable" if enable else "disable")
|
|
return None
|
|
|
|
flag_bits = _hidpp10.get_notification_flags(self)
|
|
flag_names = None if flag_bits is None else tuple(hidpp10_constants.NOTIFICATION_FLAG.flag_names(flag_bits))
|
|
if logger.isEnabledFor(logging.INFO):
|
|
logger.info("%s: receiver notifications %s => %s", self, "enabled" if enable else "disabled", flag_names)
|
|
return flag_bits
|
|
|
|
def device_codename(self, n):
|
|
codename = self.read_register(Registers.RECEIVER_INFO, _IR.device_name + n - 1)
|
|
if codename:
|
|
codename = codename[2 : 2 + ord(codename[1:2])]
|
|
return codename.decode("ascii")
|
|
|
|
def notify_devices(self):
|
|
"""Scan all devices."""
|
|
if self.handle:
|
|
if not self.write_register(Registers.RECEIVER_CONNECTION, 0x02):
|
|
logger.warning("%s: failed to trigger device link notifications", self)
|
|
|
|
def notification_information(self, number, notification):
|
|
"""Extract information from unifying-style notification"""
|
|
assert notification.address != 0x02
|
|
online = not bool(notification.data[0] & 0x40)
|
|
encrypted = bool(notification.data[0] & 0x20) or notification.address == 0x10
|
|
kind = hidpp10_constants.DEVICE_KIND[notification.data[0] & 0x0F]
|
|
wpid = (notification.data[2:3] + notification.data[1:2]).hex().upper()
|
|
return online, encrypted, wpid, kind
|
|
|
|
def device_pairing_information(self, n: int) -> dict:
|
|
"""Return information from pairing registers (and elsewhere when necessary)"""
|
|
polling_rate = ""
|
|
serial = None
|
|
power_switch = "(unknown)"
|
|
pair_info = self.read_register(Registers.RECEIVER_INFO, _IR.pairing_information + n - 1)
|
|
if pair_info: # a receiver that uses Unifying-style pairing registers
|
|
wpid = pair_info[3:5].hex().upper()
|
|
kind = hidpp10_constants.DEVICE_KIND[pair_info[7] & 0x0F]
|
|
polling_rate = str(pair_info[2]) + "ms"
|
|
elif not self.receiver_kind == "unifying": # may be an old Nano receiver
|
|
device_info = self.read_register(Registers.RECEIVER_INFO, 0x04) # undocumented
|
|
if device_info:
|
|
logger.warning("using undocumented register for device wpid")
|
|
wpid = device_info[3:5].hex().upper()
|
|
kind = hidpp10_constants.DEVICE_KIND[0x00] # unknown kind
|
|
else:
|
|
raise exceptions.NoSuchDevice(number=n, receiver=self, error="read pairing information - non-unifying")
|
|
else:
|
|
raise exceptions.NoSuchDevice(number=n, receiver=self, error="read pairing information")
|
|
pair_info = self.read_register(Registers.RECEIVER_INFO, _IR.extended_pairing_information + n - 1)
|
|
if pair_info:
|
|
power_switch = hidpp10_constants.POWER_SWITCH_LOCATION[pair_info[9] & 0x0F]
|
|
serial = pair_info[1:5].hex().upper()
|
|
else: # some Nano receivers?
|
|
pair_info = self.read_register(0x2D5) # undocumented and questionable
|
|
if pair_info:
|
|
logger.warning("using undocumented register for device serial number")
|
|
serial = pair_info[1:5].hex().upper()
|
|
return {"wpid": wpid, "kind": kind, "polling": polling_rate, "serial": serial, "power_switch": power_switch}
|
|
|
|
def register_new_device(self, number, notification=None):
|
|
if self._devices.get(number) is not None:
|
|
raise IndexError(f"{self}: device number {int(number)} already registered")
|
|
|
|
assert notification is None or notification.devnumber == number
|
|
assert notification is None or notification.sub_id == Notification.DJ_PAIRING
|
|
|
|
try:
|
|
time.sleep(0.05) # let receiver settle
|
|
info = self.device_pairing_information(number)
|
|
if notification is not None:
|
|
online, _e, nwpid, nkind = self.notification_information(number, notification)
|
|
if info["wpid"] is None:
|
|
info["wpid"] = nwpid
|
|
elif nwpid is not None and info["wpid"] != nwpid:
|
|
logger.warning("mismatch on device WPID %s %s", info["wpid"], nwpid)
|
|
if info["kind"] is None:
|
|
info["kind"] = nkind
|
|
elif nkind is not None and info["kind"] != nkind:
|
|
logger.warning("mismatch on device kind %s %s", info["kind"], nkind)
|
|
else:
|
|
online = True
|
|
dev = Device(low_level_interface, self, number, online, pairing_info=info, setting_callback=self.setting_callback)
|
|
if logger.isEnabledFor(logging.INFO):
|
|
logger.info("%s: found new device %d (%s)", self, number, dev.wpid)
|
|
self._devices[number] = dev
|
|
return dev
|
|
except exceptions.NoSuchDevice as e:
|
|
logger.warning("register new device failed for %s device %d error %s", e.receiver, e.number, e.error)
|
|
|
|
logger.warning("%s: looked for device %d, not found", self, number)
|
|
self._devices[number] = None
|
|
|
|
def set_lock(self, lock_closed=True, device=0, timeout=0):
|
|
if self.handle:
|
|
action = 0x02 if lock_closed else 0x01
|
|
reply = self.write_register(Registers.RECEIVER_PAIRING, action, device, timeout)
|
|
if reply:
|
|
return True
|
|
logger.warning("%s: failed to %s the receiver lock", self, "close" if lock_closed else "open")
|
|
|
|
def count(self):
|
|
count = self.read_register(Registers.RECEIVER_CONNECTION)
|
|
return 0 if count is None else ord(count[1:2])
|
|
|
|
def request(self, request_id, *params):
|
|
if bool(self):
|
|
return base.request(self.handle, 0xFF, request_id, *params)
|
|
|
|
def reset_pairing(self):
|
|
self.pairing = Pairing()
|
|
|
|
def __iter__(self):
|
|
connected_devices = self.count()
|
|
found_devices = 0
|
|
for number in range(1, 8): # some receivers have devices past their max # devices
|
|
if found_devices >= connected_devices:
|
|
return
|
|
if number in self._devices:
|
|
dev = self._devices[number]
|
|
else:
|
|
dev = self.__getitem__(number)
|
|
if dev is not None:
|
|
found_devices += 1
|
|
yield dev
|
|
|
|
def __getitem__(self, key):
|
|
if not bool(self):
|
|
return None
|
|
|
|
dev = self._devices.get(key)
|
|
if dev is not None:
|
|
return dev
|
|
|
|
if not isinstance(key, int):
|
|
raise TypeError("key must be an integer")
|
|
if key < 1 or key > 15: # some receivers have devices past their max # devices
|
|
raise IndexError(key)
|
|
|
|
return self.register_new_device(key)
|
|
|
|
def __delitem__(self, key):
|
|
self._unpair_device(key, False)
|
|
|
|
def _unpair_device(self, key, force=False):
|
|
key = int(key)
|
|
|
|
if self._devices.get(key) is None:
|
|
raise IndexError(key)
|
|
|
|
dev = self._devices[key]
|
|
if not dev:
|
|
if key in self._devices:
|
|
del self._devices[key]
|
|
return
|
|
|
|
if self.re_pairs and not force:
|
|
# invalidate the device, but these receivers don't unpair per se
|
|
dev.online = False
|
|
dev.wpid = None
|
|
if key in self._devices:
|
|
del self._devices[key]
|
|
logger.warning("%s removed device %s", self, dev)
|
|
else:
|
|
reply = self._unpair_device_per_receiver(key)
|
|
if reply:
|
|
# invalidate the device
|
|
dev.online = False
|
|
dev.wpid = None
|
|
if key in self._devices:
|
|
del self._devices[key]
|
|
if logger.isEnabledFor(logging.INFO):
|
|
logger.info("%s unpaired device %s", self, dev)
|
|
else:
|
|
logger.error("%s failed to unpair device %s", self, dev)
|
|
raise Exception(f"failed to unpair device {dev.name}: {key}")
|
|
|
|
def _unpair_device_per_receiver(self, key):
|
|
"""Receiver specific unpairing."""
|
|
return self.write_register(Registers.RECEIVER_PAIRING, 0x03, key)
|
|
|
|
def __len__(self):
|
|
return len([d for d in self._devices.values() if d is not None])
|
|
|
|
def __contains__(self, dev):
|
|
if isinstance(dev, int):
|
|
return self._devices.get(dev) is not None
|
|
|
|
return self.__contains__(dev.number)
|
|
|
|
def __eq__(self, other):
|
|
return other is not None and self.kind == other.kind and self.path == other.path
|
|
|
|
def __ne__(self, other):
|
|
return other is None or self.kind != other.kind or self.path != other.path
|
|
|
|
def __hash__(self):
|
|
return self.path.__hash__()
|
|
|
|
def status_string(self):
|
|
count = len(self)
|
|
return (
|
|
_("No paired devices.")
|
|
if count == 0
|
|
else ngettext("%(count)s paired device.", "%(count)s paired devices.", count) % {"count": count}
|
|
)
|
|
|
|
def __str__(self):
|
|
return "<%s(%s,%s%s)>" % (
|
|
self.name.replace(" ", ""),
|
|
self.path,
|
|
"" if isinstance(self.handle, int) else "T",
|
|
self.handle,
|
|
)
|
|
|
|
__repr__ = __str__
|
|
|
|
__bool__ = __nonzero__ = lambda self: self.handle is not None
|
|
|
|
|
|
class BoltReceiver(Receiver):
|
|
"""Bolt receivers use a different pairing prototol and have different pairing registers"""
|
|
|
|
def __init__(self, receiver_kind, product_info, handle, path, product_id, setting_callback=None):
|
|
super().__init__(receiver_kind, product_info, handle, path, product_id, setting_callback)
|
|
|
|
def initialize(self, product_info: dict):
|
|
serial_reply = self.read_register(Registers.BOLT_UNIQUE_ID)
|
|
self.serial = serial_reply.hex().upper()
|
|
self.max_devices = product_info.get("max_devices", 1)
|
|
|
|
def device_codename(self, n):
|
|
codename = self.read_register(Registers.RECEIVER_INFO, _IR.bolt_device_name + n, 0x01)
|
|
if codename:
|
|
codename = codename[3 : 3 + min(14, ord(codename[2:3]))]
|
|
return codename.decode("ascii")
|
|
|
|
def device_pairing_information(self, n: int) -> dict:
|
|
pair_info = self.read_register(Registers.RECEIVER_INFO, _IR.bolt_pairing_information + n)
|
|
if pair_info:
|
|
wpid = (pair_info[3:4] + pair_info[2:3]).hex().upper()
|
|
kind = hidpp10_constants.DEVICE_KIND[pair_info[1] & 0x0F]
|
|
serial = pair_info[4:8].hex().upper()
|
|
return {"wpid": wpid, "kind": kind, "polling": None, "serial": serial, "power_switch": "(unknown)"}
|
|
else:
|
|
raise exceptions.NoSuchDevice(number=n, receiver=self, error="can't read Bolt pairing register")
|
|
|
|
def discover(self, cancel=False, timeout=30):
|
|
"""Discover Logitech Bolt devices."""
|
|
if self.handle:
|
|
action = 0x02 if cancel else 0x01
|
|
reply = self.write_register(Registers.BOLT_DEVICE_DISCOVERY, timeout, action)
|
|
if reply:
|
|
return True
|
|
logger.warning("%s: failed to %s device discovery", self, "cancel" if cancel else "start")
|
|
|
|
def pair_device(self, pair=True, slot=0, address=b"\0\0\0\0\0\0", authentication=0x00, entropy=20):
|
|
"""Pair a Bolt device."""
|
|
if self.handle:
|
|
action = 0x01 if pair is True else 0x03 if pair is False else 0x02
|
|
reply = self.write_register(Registers.BOLT_PAIRING, action, slot, address, authentication, entropy)
|
|
if reply:
|
|
return True
|
|
logger.warning("%s: failed to %s device %s", self, "pair" if pair else "unpair", address)
|
|
|
|
def _unpair_device_per_receiver(self, key):
|
|
"""Receiver specific unpairing."""
|
|
return self.write_register(Registers.BOLT_PAIRING, 0x03, key)
|
|
|
|
|
|
class UnifyingReceiver(Receiver):
|
|
def __init__(self, receiver_kind, product_info, handle, path, product_id, setting_callback=None):
|
|
super().__init__(receiver_kind, product_info, handle, path, product_id, setting_callback)
|
|
|
|
|
|
class NanoReceiver(Receiver):
|
|
def __init__(self, receiver_kind, product_info, handle, path, product_id, setting_callback=None):
|
|
super().__init__(receiver_kind, product_info, handle, path, product_id, setting_callback)
|
|
|
|
|
|
class LightSpeedReceiver(Receiver):
|
|
def __init__(self, receiver_kind, product_info, handle, path, product_id, setting_callback=None):
|
|
super().__init__(receiver_kind, product_info, handle, path, product_id, setting_callback)
|
|
|
|
|
|
class Ex100Receiver(Receiver):
|
|
"""A very old style receiver, somewhat different from newer receivers"""
|
|
|
|
def __init__(self, receiver_kind, product_info, handle, path, product_id, setting_callback=None):
|
|
super().__init__(receiver_kind, product_info, handle, path, product_id, setting_callback)
|
|
|
|
def initialize(self, product_info: dict):
|
|
self.serial = None
|
|
self.max_devices = product_info.get("max_devices", 1)
|
|
|
|
def notification_information(self, number, notification):
|
|
"""Extract information from 27Mz-style notification and device index"""
|
|
assert notification.address == 0x02
|
|
online = True
|
|
encrypted = bool(notification.data[0] & 0x80)
|
|
kind = hidpp10_constants.DEVICE_KIND[_get_kind_from_index(self, number)]
|
|
wpid = "00" + notification.data[2:3].hex().upper()
|
|
return online, encrypted, wpid, kind
|
|
|
|
def device_pairing_information(self, number: int) -> dict:
|
|
wpid = hidapi.find_paired_node_wpid(self.path, number) # extract WPID from udev path
|
|
if not wpid:
|
|
logger.error("Unable to get wpid from udev for device %d of %s", number, self)
|
|
raise exceptions.NoSuchDevice(number=number, receiver=self, error="Not present 27Mhz device")
|
|
kind = hidpp10_constants.DEVICE_KIND[_get_kind_from_index(self, number)]
|
|
return {"wpid": wpid, "kind": kind, "polling": "", "serial": None, "power_switch": "(unknown)"}
|
|
|
|
|
|
def _get_kind_from_index(receiver, index):
|
|
"""Get device kind from 27Mhz device index"""
|
|
# From drivers/hid/hid-logitech-dj.c
|
|
if index == 1: # mouse
|
|
kind = 2
|
|
elif index == 2: # mouse
|
|
kind = 2
|
|
elif index == 3: # keyboard
|
|
kind = 1
|
|
elif index == 4: # numpad
|
|
kind = 3
|
|
else: # unknown device number on 27Mhz receiver
|
|
logger.error("failed to calculate device kind for device %d of %s", index, receiver)
|
|
raise exceptions.NoSuchDevice(number=index, receiver=receiver, error="Unknown 27Mhz device number")
|
|
return kind
|
|
|
|
|
|
receiver_class_mapping = {
|
|
"bolt": BoltReceiver,
|
|
"unifying": UnifyingReceiver,
|
|
"lightspeed": LightSpeedReceiver,
|
|
"nano": NanoReceiver,
|
|
"27Mhz": Ex100Receiver,
|
|
}
|
|
|
|
|
|
class ReceiverFactory:
|
|
@staticmethod
|
|
def create_receiver(device_info, setting_callback=None) -> Optional[Receiver]:
|
|
"""Opens a Logitech Receiver found attached to the machine, by Linux device path."""
|
|
|
|
try:
|
|
handle = base.open_path(device_info.path)
|
|
if handle:
|
|
usb_id = device_info.product_id
|
|
if isinstance(usb_id, str):
|
|
usb_id = int(usb_id, 16)
|
|
try:
|
|
product_info = base.product_information(usb_id)
|
|
except ValueError:
|
|
product_info = {}
|
|
kind = product_info.get("receiver_kind", "unknown")
|
|
rclass = receiver_class_mapping.get(kind, Receiver)
|
|
return rclass(kind, product_info, handle, device_info.path, device_info.product_id, setting_callback)
|
|
except OSError as e:
|
|
logger.exception("open %s", device_info)
|
|
if e.errno == errno.EACCES:
|
|
raise
|
|
except Exception:
|
|
logger.exception("open %s", device_info)
|