155 lines
5.1 KiB
Python
155 lines
5.1 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 .i18n import _
|
|
from . import hidpp10 as _hidpp10
|
|
from . import hidpp20 as _hidpp20
|
|
from .settings import (
|
|
KIND as _KIND,
|
|
Setting as _Setting,
|
|
RegisterRW as _RegisterRW,
|
|
FeatureRW as _FeatureRW,
|
|
BooleanValidator as _BooleanV,
|
|
ChoicesValidator as _ChoicesV,
|
|
)
|
|
|
|
_DK = _hidpp10.DEVICE_KIND
|
|
_R = _hidpp10.REGISTERS
|
|
_F = _hidpp20.FEATURE
|
|
|
|
#
|
|
# pre-defined basic setting descriptors
|
|
#
|
|
|
|
def register_toggle(name, register,
|
|
true_value=_BooleanV.default_true, false_value=_BooleanV.default_false,
|
|
mask=_BooleanV.default_mask, write_returns_value=False,
|
|
label=None, description=None, device_kind=None):
|
|
rw = _RegisterRW(register)
|
|
validator = _BooleanV(true_value=true_value, false_value=false_value, mask=mask, write_returns_value=write_returns_value)
|
|
return _Setting(name, rw, validator, label=label, description=description, device_kind=device_kind)
|
|
|
|
|
|
def register_choices(name, register, choices,
|
|
kind=_KIND.choice, write_returns_value=False,
|
|
label=None, description=None, device_kind=None):
|
|
assert choices
|
|
rw = _RegisterRW(register)
|
|
validator = _ChoicesV(choices, write_returns_value=write_returns_value)
|
|
return _Setting(name, rw, validator, kind=kind, label=label, description=description, device_kind=device_kind)
|
|
|
|
|
|
def feature_toggle(name, feature,
|
|
read_function_id=_FeatureRW.default_read_fnid, write_function_id=_FeatureRW.default_write_fnid,
|
|
true_value=_BooleanV.default_true, false_value=_BooleanV.default_false,
|
|
mask=_BooleanV.default_mask, write_returns_value=False,
|
|
label=None, description=None, device_kind=None):
|
|
rw = _FeatureRW(feature, read_function_id, write_function_id)
|
|
validator = _BooleanV(true_value=true_value, false_value=false_value, mask=mask, write_returns_value=write_returns_value)
|
|
return _Setting(name, rw, validator, label=label, description=description, device_kind=device_kind)
|
|
|
|
#
|
|
# common strings for settings
|
|
#
|
|
|
|
_SMOOTH_SCROLL = ('smooth-scroll', _("Smooth Scrolling"),
|
|
_("High-sensitivity mode for vertical scroll with the wheel."))
|
|
_DPI = ('dpi', _("Sensitivity (DPI)"), None)
|
|
_FN_SWAP = ('fn-swap', _("Swap Fx function"),
|
|
_("When set, the F1..F12 keys will activate their special function,\n"
|
|
"and you must hold the FN key to activate their standard function.")
|
|
+ '\n\n' +
|
|
_("When unset, the F1..F12 keys will activate their standard function,\n"
|
|
"and you must hold the FN key to activate their special function."))
|
|
|
|
#
|
|
#
|
|
#
|
|
|
|
def _register_fn_swap(register=_R.keyboard_fn_swap, true_value=b'\x00\x01', mask=b'\x00\x01'):
|
|
return register_toggle(_FN_SWAP[0], register, true_value=true_value, mask=mask,
|
|
label=_FN_SWAP[1], description=_FN_SWAP[2],
|
|
device_kind=_DK.keyboard)
|
|
|
|
def _register_smooth_scroll(register=_R.mouse_smooth_scroll, true_value=0x40, mask=0x40):
|
|
return register_toggle(_SMOOTH_SCROLL[0], register, true_value=true_value, mask=mask,
|
|
label=_SMOOTH_SCROLL[1], description=_SMOOTH_SCROLL[2],
|
|
device_kind=_DK.mouse)
|
|
|
|
def _register_dpi(register=_R.mouse_dpi, choices=None):
|
|
return register_choices(_DPI[0], register, choices,
|
|
label=_DPI[1], description=_DPI[2],
|
|
device_kind=_DK.mouse)
|
|
|
|
|
|
def _feature_fn_swap():
|
|
return feature_toggle(_FN_SWAP[0], _F.FN_INVERSION,
|
|
write_returns_value=True,
|
|
label=_FN_SWAP[1], description=_FN_SWAP[2],
|
|
device_kind=_DK.keyboard)
|
|
|
|
|
|
#
|
|
#
|
|
#
|
|
|
|
from collections import namedtuple
|
|
_SETTINGS_LIST = namedtuple('_SETTINGS_LIST', [
|
|
'fn_swap',
|
|
'smooth_scroll',
|
|
'dpi',
|
|
'hand_detection',
|
|
'typing_illumination',
|
|
])
|
|
del namedtuple
|
|
|
|
RegisterSettings = _SETTINGS_LIST(
|
|
fn_swap=_register_fn_swap,
|
|
smooth_scroll=_register_smooth_scroll,
|
|
dpi=_register_dpi,
|
|
hand_detection=None,
|
|
typing_illumination=None,
|
|
)
|
|
FeatureSettings = _SETTINGS_LIST(
|
|
fn_swap=_feature_fn_swap,
|
|
smooth_scroll=None,
|
|
dpi=None,
|
|
hand_detection=None,
|
|
typing_illumination=None,
|
|
)
|
|
|
|
del _SETTINGS_LIST
|
|
|
|
#
|
|
#
|
|
#
|
|
|
|
def check_feature_settings(device, already_known):
|
|
"""Try to auto-detect device settings by the HID++ 2.0 features they have."""
|
|
if device.features is None:
|
|
return
|
|
if device.protocol and device.protocol < 2.0:
|
|
return
|
|
if not any(s.name == _FN_SWAP[0] for s in already_known) and _F.FN_INVERSION in device.features:
|
|
fn_swap = FeatureSettings.fn_swap()
|
|
already_known.append(fn_swap(device))
|