minor clean-ups in texts

This commit is contained in:
Daniel Pavel 2012-12-12 20:44:29 +02:00
parent 8b90e99658
commit 17698bfeae
3 changed files with 23 additions and 13 deletions

View File

@ -102,7 +102,10 @@ class ReceiverListener(_listener.EventsListener):
def _status_changed(self, device, alert=_status.ALERT.NONE, reason=None): def _status_changed(self, device, alert=_status.ALERT.NONE, reason=None):
if _log.isEnabledFor(_DEBUG): if _log.isEnabledFor(_DEBUG):
_log.debug("status_changed %s: %s (%X) %s", device, None if device is None else device.status, alert, reason or '') _log.debug("status_changed %s: %s %s (%X) %s", device,
None if device is None else 'active' if device.status else 'inactive',
None if device is None else device.status,
alert, reason or '')
if self.status_changed_callback: if self.status_changed_callback:
r = self.receiver or DUMMY r = self.receiver or DUMMY
if device is None or device.kind is None: if device is None or device.kind is None:

View File

@ -53,7 +53,7 @@ def _show_about_window(action):
about.set_authors(('Daniel Pavel http://github.com/pwr',)) about.set_authors(('Daniel Pavel http://github.com/pwr',))
try: try:
about.add_credit_section('Testing', ('Douglas Wagner',)) about.add_credit_section('Testing', ('Douglas Wagner', 'Julien Gascard'))
about.add_credit_section('Technical specifications\nprovided by', about.add_credit_section('Technical specifications\nprovided by',
('Julien Danjou http://julien.danjou.info/blog/2012/logitech-unifying-upower',)) ('Julien Danjou http://julien.danjou.info/blog/2012/logitech-unifying-upower',))
except TypeError: except TypeError:
@ -64,7 +64,7 @@ def _show_about_window(action):
pass pass
about.set_website('http://pwr.github.com/Solaar/') about.set_website('http://pwr.github.com/Solaar/')
about.set_website_label('Solaar Wiki') about.set_website_label('Solaar')
about.run() about.run()
about.destroy() about.destroy()

View File

@ -67,7 +67,7 @@ def receivers():
if d.driver == 'logitech-djreceiver': if d.driver == 'logitech-djreceiver':
yield d yield d
# apparently there are TWO product ids possible for the UR # apparently there are TWO product ids possible for the UR?
for d in _hid.enumerate(0x046d, 0xc532, 2): for d in _hid.enumerate(0x046d, 0xc532, 2):
if d.driver == 'logitech-djreceiver': if d.driver == 'logitech-djreceiver':
yield d yield d
@ -124,8 +124,7 @@ def write(handle, devnumber, data):
:param devnumber: attached device number. :param devnumber: attached device number.
:param data: data to send, up to 5 bytes. :param data: data to send, up to 5 bytes.
The first two (required) bytes of data must be the feature index for the The first two (required) bytes of data must be the SubId and address.
device, and a function code for that feature.
:raises NoReceiver: if the receiver is no longer available, i.e. has :raises NoReceiver: if the receiver is no longer available, i.e. has
been physically removed from the machine, or the kernel driver has been been physically removed from the machine, or the kernel driver has been
@ -151,8 +150,7 @@ def read(handle, timeout=DEFAULT_TIMEOUT):
"""Read some data from the receiver. Usually called after a write (feature """Read some data from the receiver. Usually called after a write (feature
call), to get the reply. call), to get the reply.
If any data was read in the given timeout, returns a tuple of :returns: a tuple of (devnumber, message data), or `None`
(code, devnumber, message data).
:raises NoReceiver: if the receiver is no longer available, i.e. has :raises NoReceiver: if the receiver is no longer available, i.e. has
been physically removed from the machine, or the kernel driver has been been physically removed from the machine, or the kernel driver has been
@ -164,6 +162,14 @@ def read(handle, timeout=DEFAULT_TIMEOUT):
def _read(handle, timeout): def _read(handle, timeout):
"""Read an incoming packet from the receiver.
:returns: a tuple of (report_id, devnumber, data), or `None`.
:raises NoReceiver: if the receiver is no longer available, i.e. has
been physically removed from the machine, or the kernel driver has been
unloaded. The handle will be closed automatically.
"""
try: try:
data = _hid.read(int(handle), _MAX_READ_SIZE, timeout) data = _hid.read(int(handle), _MAX_READ_SIZE, timeout)
except Exception as reason: except Exception as reason:
@ -185,7 +191,10 @@ def _read(handle, timeout):
def _skip_incoming(handle): def _skip_incoming(handle):
"""Read anything already in the input buffer.""" """Read anything already in the input buffer.
Used by request() and ping() before their write.
"""
ihandle = int(handle) ihandle = int(handle)
while True: while True:
@ -249,9 +258,7 @@ def make_event(devnumber, data):
def request(handle, devnumber, request_id, *params): def request(handle, devnumber, request_id, *params):
"""Makes a feature call to a device and waits for a matching reply. """Makes a feature call to a device and waits for a matching reply.
This function will skip all incoming messages and events not related to the This function will wait for a matching reply indefinitely.
device we're requesting for, or the feature specified in the initial
request; it will also wait for a matching reply indefinitely.
:param handle: an open UR handle. :param handle: an open UR handle.
:param devnumber: attached device number. :param devnumber: attached device number.
@ -259,7 +266,7 @@ def request(handle, devnumber, request_id, *params):
:param params: parameters for the feature call, 3 to 16 bytes. :param params: parameters for the feature call, 3 to 16 bytes.
:returns: the reply data, or ``None`` if some error occured. :returns: the reply data, or ``None`` if some error occured.
""" """
assert type(request_id) == int assert isinstance(request_id, int)
if devnumber != 0xFF and request_id < 0x8000: if devnumber != 0xFF and request_id < 0x8000:
timeout = _DEVICE_REQUEST_TIMEOUT timeout = _DEVICE_REQUEST_TIMEOUT
# for HID++ 2.0 feature request, randomize the swid to make it easier to # for HID++ 2.0 feature request, randomize the swid to make it easier to