352 lines
11 KiB
Python
352 lines
11 KiB
Python
# -*- python-mode -*-
|
|
# -*- coding: UTF-8 -*-
|
|
|
|
## Copyright (C) 2012-2013 Daniel Pavel
|
|
##
|
|
## 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.
|
|
|
|
from __future__ import absolute_import, division, print_function, unicode_literals
|
|
|
|
|
|
from .common import NamedInts as _NamedInts
|
|
from .hidpp10 import REGISTERS as _R, DEVICE_KIND as _DK
|
|
from .settings_templates import RegisterSettings as _RS, FeatureSettings as _FS
|
|
|
|
#
|
|
#
|
|
#
|
|
|
|
from collections import namedtuple
|
|
_DeviceDescriptor = namedtuple('_DeviceDescriptor',
|
|
('name', 'kind', 'wpid', 'codename', 'protocol', 'registers', 'settings'))
|
|
del namedtuple
|
|
|
|
DEVICES = {}
|
|
|
|
def _D(name, codename=None, kind=None, wpid=None, protocol=None, registers=None, settings=None):
|
|
assert name
|
|
|
|
if kind is None:
|
|
kind = (_DK.mouse if 'Mouse' in name
|
|
else _DK.keyboard if 'Keyboard' in name
|
|
else _DK.numpad if 'Number Pad' in name
|
|
else _DK.touchpad if 'Touchpad' in name
|
|
else _DK.trackball if 'Trackball' in name
|
|
else None)
|
|
assert kind is not None, 'descriptor for %s does not have kind set' % name
|
|
|
|
# heuristic: the codename is the last word in the device name
|
|
if codename is None and ' ' in name:
|
|
codename = name.split(' ')[-1]
|
|
assert codename is not None, 'descriptor for %s does not have codename set' % name
|
|
|
|
if protocol is not None:
|
|
# ? 2.0 devices should not have any registers
|
|
if protocol < 2.0:
|
|
assert settings is None or all(s._rw.kind == 1 for s in settings)
|
|
else:
|
|
assert registers is None
|
|
assert settings is None or all(s._rw.kind == 2 for s in settings)
|
|
|
|
if wpid:
|
|
for w in wpid if isinstance(wpid, tuple) else (wpid, ):
|
|
if protocol > 1.0:
|
|
assert w[0:1] == '4', '%s has protocol %0.1f, wpid %s' % (name, protocol, w)
|
|
else:
|
|
if w[0:1] == '1':
|
|
assert kind == _DK.mouse, '%s has protocol %0.1f, wpid %s' % (name, protocol, w)
|
|
elif w[0:1] == '2':
|
|
assert kind in (_DK.keyboard, _DK.numpad), '%s has protocol %0.1f, wpid %s' % (name, protocol, w)
|
|
|
|
device_descriptor = _DeviceDescriptor(name=name, kind=kind,
|
|
wpid=wpid, codename=codename, protocol=protocol,
|
|
registers=registers, settings=settings)
|
|
|
|
assert codename not in DEVICES, 'duplicate codename in device descriptors: %s' % (DEVICES[codename], )
|
|
DEVICES[codename] = device_descriptor
|
|
|
|
if wpid:
|
|
if not isinstance(wpid, tuple):
|
|
wpid = (wpid, )
|
|
|
|
for w in wpid:
|
|
assert w not in DEVICES, 'duplicate wpid in device descriptors: %s' % (DEVICES[w], )
|
|
DEVICES[w] = device_descriptor
|
|
|
|
#
|
|
#
|
|
#
|
|
|
|
_PERFORMANCE_MX_DPIS = _NamedInts.range(0x81, 0x8F, lambda x: str((x - 0x80) * 100))
|
|
|
|
#
|
|
#
|
|
#
|
|
|
|
# Some HID++1.0 registers and HID++2.0 features can be discovered at run-time,
|
|
# so they are not specified here.
|
|
#
|
|
# For known registers, however, please do specify them here -- avoids
|
|
# unnecessary communication with the device and makes it easier to make certain
|
|
# decisions when querying the device's state.
|
|
#
|
|
# Specify a negative value to blacklist a certain register for a device.
|
|
#
|
|
# Usually, state registers (battery, leds, some features, etc) are only used by
|
|
# HID++ 1.0 devices, while HID++ 2.0 devices use features for the same
|
|
# functionalities. This is a rule that's been discovered by trial-and-error,
|
|
# so it may change in the future.
|
|
|
|
# Well-known registers (in hex):
|
|
# * 00 - notification flags (all devices)
|
|
# 01 - mice: smooth scrolling
|
|
# 07 - battery status
|
|
# 09 - keyboards: FN swap (if it has the FN key)
|
|
# 0D - battery charge
|
|
# a device may have either the 07 or 0D register available;
|
|
# no known device uses both
|
|
# 51 - leds
|
|
# 63 - mice: DPI
|
|
# * F1 - firmware info
|
|
# Some registers appear to be universally supported, no matter the HID++ version
|
|
# (marked with *). The rest may or may not be supported, and their values may or
|
|
# may not mean the same thing across different devices.
|
|
|
|
# The 'codename' and 'kind' fields are usually guessed from the device name,
|
|
# but in some cases (like the Logitech Cube) that heuristic fails and they have
|
|
# to be specified.
|
|
#
|
|
# The 'protocol' and 'wpid' fields are optional (they can be discovered at
|
|
# runtime), but specifying them here speeds up device discovery and reduces the
|
|
# USB traffic Solaar has to do to fully identify peripherals.
|
|
# Same goes for HID++ 2.0 feature settings (like _feature_fn_swap).
|
|
#
|
|
# The 'registers' field indicates read-only registers, specifying a state. These
|
|
# are valid (AFAIK) only to HID++ 1.0 devices.
|
|
# The 'settings' field indicates a read/write register; based on them Solaar
|
|
# generates, at runtime, the settings controls in the device panel. HID++ 1.0
|
|
# devices may only have register-based settings; HID++ 2.0 devices may only have
|
|
# feature-based settings.
|
|
|
|
# Keyboards
|
|
|
|
_D('Wireless Keyboard K230', protocol=2.0, wpid='400D')
|
|
_D('Wireless Keyboard K270', protocol=1.0,
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('Wireless Keyboard MK330')
|
|
_D('Wireless Compact Keyboard K340', protocol=1.0, wpid='2007',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('Wireless Wave Keyboard K350', protocol=1.0, wpid='200A',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('Wireless Keyboard K360', protocol=2.0, wpid='4004',
|
|
settings=[
|
|
_FS.fn_swap()
|
|
],
|
|
)
|
|
_D('Wireless Touch Keyboard K400', protocol=2.0, wpid=('400E', '4024'),
|
|
settings=[
|
|
_FS.fn_swap()
|
|
],
|
|
)
|
|
_D('Wireless Touch Keyboard K400 Plus', protocol=2.0, wpid='404D',
|
|
settings=[
|
|
_FS.new_fn_swap()
|
|
],
|
|
)
|
|
_D('Wireless Keyboard K520', protocol=1.0, wpid='2011',
|
|
registers=(_R.battery_status, ),
|
|
settings=[
|
|
_RS.fn_swap(),
|
|
],
|
|
)
|
|
_D('Number Pad N545', protocol=1.0, wpid='2006',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('Wireless Keyboard MK550')
|
|
_D('Wireless Keyboard MK700', protocol=1.0, wpid='2008',
|
|
registers=(_R.battery_status, ),
|
|
settings=[
|
|
_RS.fn_swap(),
|
|
],
|
|
)
|
|
_D('Wireless Solar Keyboard K750', protocol=2.0, wpid='4002',
|
|
settings=[
|
|
_FS.fn_swap()
|
|
],
|
|
)
|
|
_D('Wireless Illuminated Keyboard K800', protocol=1.0, wpid='2010',
|
|
registers=(_R.battery_status, _R.three_leds, ),
|
|
settings=[
|
|
_RS.fn_swap(),
|
|
_RS.hand_detection(),
|
|
],
|
|
)
|
|
_D('Illuminated Living-Room Keyboard K830', protocol=2.0, wpid='4032',
|
|
settings=[
|
|
_FS.new_fn_swap()
|
|
],
|
|
)
|
|
|
|
# Mice
|
|
|
|
_D('Wireless Mouse M175', protocol=2.0, wpid='4008')
|
|
_D('Wireless Mouse M185')
|
|
_D('Wireless Mouse M187', protocol=2.0, wpid='4019')
|
|
_D('Wireless Mouse M215', protocol=1.0, wpid='1020')
|
|
_D('Wireless Mouse M235')
|
|
_D('Wireless Mouse M305', protocol=1.0, wpid='101F',
|
|
registers=(_R.battery_status, ),
|
|
settings=[
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
_D('Wireless Mouse M310', protocol=1.0, wpid='1024',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('Wireless Mouse M315')
|
|
_D('Wireless Mouse M317')
|
|
_D('Wireless Mouse M325', protocol=2.0, wpid='400A',
|
|
settings=[
|
|
_FS.smooth_scroll(),
|
|
])
|
|
_D('Wireless Mouse M345', protocol=2.0, wpid='4017')
|
|
_D('Wireless Mouse M350', protocol=1.0, wpid='101C',
|
|
registers=(_R.battery_charge, ),
|
|
)
|
|
_D('Wireless Mouse M505', codename='M505/B605', protocol=1.0, wpid='101D',
|
|
registers=(_R.battery_charge, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
_D('Wireless Mouse M510', protocol=1.0, wpid='1025',
|
|
registers=(_R.battery_status, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
_D('Couch Mouse M515', protocol=2.0, wpid='4007')
|
|
_D('Wireless Mouse M525', protocol=2.0, wpid='4013')
|
|
_D('Touch Mouse M600', protocol=2.0, wpid='401A')
|
|
_D('Marathon Mouse M705', protocol=1.0, wpid='101B',
|
|
registers=(_R.battery_charge, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
_D('Zone Touch Mouse T400')
|
|
_D('Touch Mouse T620', protocol=2.0)
|
|
_D('Logitech Cube', kind=_DK.mouse, protocol=2.0)
|
|
_D('Anywhere Mouse MX', codename='Anywhere MX', protocol=1.0, wpid='1017',
|
|
registers=(_R.battery_charge, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
_D('Performance Mouse MX', codename='Performance MX', protocol=1.0, wpid='101A',
|
|
registers=(_R.battery_status, _R.three_leds, ),
|
|
settings=[
|
|
_RS.dpi(choices=_PERFORMANCE_MX_DPIS),
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
|
|
_D('Wireless Mouse MX Master', codename='MX Master', protocol=4.5, wpid='4041')
|
|
|
|
_D('G7 Cordless Laser Mouse', codename='G7', protocol=1.0, wpid='1002',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('G700 Gaming Mouse', codename='G700', protocol=1.0, wpid='1023',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
|
|
# Trackballs
|
|
|
|
_D('Wireless Trackball M570')
|
|
|
|
# Touchpads
|
|
|
|
_D('Wireless Rechargeable Touchpad T650', protocol=2.0, wpid='4101')
|
|
_D('Wireless Touchpad', codename='Wireless Touch', protocol=2.0, wpid='4011')
|
|
|
|
#
|
|
# Classic Nano peripherals (that don't support the Unifying protocol).
|
|
# A wpid is necessary to properly identify them.
|
|
#
|
|
|
|
_D('VX Nano Cordless Laser Mouse', codename='VX Nano', protocol=1.0, wpid=('100B', '100F'),
|
|
registers=(_R.battery_charge, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
_D('V450 Nano Cordless Laser Mouse', codename='V450 Nano', protocol=1.0, wpid='1011',
|
|
registers=(_R.battery_charge, ),
|
|
)
|
|
_D('V550 Nano Cordless Laser Mouse', codename='V550 Nano', protocol=1.0, wpid='1013',
|
|
registers=(_R.battery_charge, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
|
|
# Mini receiver mice
|
|
|
|
_D('MX610 Laser Cordless Mouse', codename='MX610', protocol=1.0, wpid='1001',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('MX620 Laser Cordless Mouse', codename='MX620', protocol=1.0, wpid=('100A', '1016'),
|
|
registers=(_R.battery_charge, ),
|
|
)
|
|
_D('MX610 Left-Handled Mouse', codename='MX610L', protocol=1.0, wpid='1004',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('V400 Laser Cordless Mouse', codename='V400', protocol=1.0, wpid='1003',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('V450 Laser Cordless Mouse', codename='V450', protocol=1.0, wpid='1005',
|
|
registers=(_R.battery_status, ),
|
|
)
|
|
_D('VX Revolution', codename='VX Revolution', kind=_DK.mouse, protocol=1.0, wpid=('1006', '100D'),
|
|
registers=(_R.battery_charge, ),
|
|
)
|
|
_D('MX Air', codename='MX Air', protocol=1.0, kind=_DK.mouse, wpid=('1007', '100E'),
|
|
registers=(_R.battery_charge, ),
|
|
)
|
|
_D('MX Revolution', codename='MX Revolution', protocol=1.0, kind=_DK.mouse, wpid=('1008', '100C'),
|
|
registers=(_R.battery_charge, ),
|
|
)
|
|
_D('MX 1100 Cordless Laser Mouse', codename='MX 1100', protocol=1.0, kind=_DK.mouse, wpid='1014',
|
|
registers=(_R.battery_charge, ),
|
|
settings=[
|
|
_RS.smooth_scroll(),
|
|
_RS.side_scroll(),
|
|
],
|
|
)
|
|
|
|
# Some exotics...
|
|
|
|
_D('Fujitsu Sonic Mouse', codename='Sonic', protocol=1.0, wpid='1029')
|