#!/usr/bin/env python3 # # 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. # import binascii import calendar import enum import inspect import logging import os import threading import time import uuid import errno from gi.repository import GObject from .drawing import Drawing from .uhid import UHIDDevice logger = logging.getLogger('tuhi.wacom') NORDIC_UART_SERVICE_UUID = '6e400001-b5a3-f393-e0a9-e50e24dcca9e' NORDIC_UART_CHRC_TX_UUID = '6e400002-b5a3-f393-e0a9-e50e24dcca9e' NORDIC_UART_CHRC_RX_UUID = '6e400003-b5a3-f393-e0a9-e50e24dcca9e' WACOM_LIVE_SERVICE_UUID = '00001523-1212-efde-1523-785feabcd123' WACOM_CHRC_LIVE_PEN_DATA_UUID = '00001524-1212-efde-1523-785feabcd123' WACOM_OFFLINE_SERVICE_UUID = 'ffee0001-bbaa-9988-7766-554433221100' WACOM_OFFLINE_CHRC_PEN_DATA_UUID = 'ffee0003-bbaa-9988-7766-554433221100' MYSTERIOUS_NOTIFICATION_SERVICE_UUID = '3a340720-c572-11e5-86c5-0002a5d5c51b' MYSTERIOUS_NOTIFICATION_CHRC_UUID = '3a340721-c572-11e5-86c5-0002a5d5c51b' @enum.unique class Protocol(enum.Enum): UNKNOWN = 'unknown' SPARK = 'spark' SLATE = 'slate' INTUOS_PRO = 'intuos-pro' @enum.unique class DeviceMode(enum.Enum): REGISTER = 1 LISTEN = 2 LIVE = 3 wacom_live_rdesc_template = [ 0x05, 0x0d, # Usage Page (Digitizers) 0 0x09, 0x01, # Usage (Digitizer) 2 0xa1, 0x01, # Collection (Application) 4 0x85, 0x01, # .Report ID (1) 6 0x09, 0x20, # .Usage (Stylus) 8 0xa1, 0x00, # .Collection (Physical) 10 0x09, 0x32, # ..Usage (In Range) 12 0x15, 0x00, # ..Logical Minimum (0) 14 0x25, 0x01, # ..Logical Maximum (1) 16 0x95, 0x01, # ..Report Count (1) 18 0x75, 0x01, # ..Report Size (1) 20 0x81, 0x02, # ..Input (Data,Var,Abs) 22 0x95, 0x07, # ..Report Count (7) 24 0x81, 0x03, # ..Input (Cnst,Var,Abs) 26 0x05, 0x01, # ..Usage Page (Generic Desktop) 28 0x09, 0x30, # ..Usage (X) 30 0x75, 0x10, # ..Report Size (16) 32 0x95, 0x01, # ..Report Count (1) 34 0x55, 0x0d, # ..Unit Exponent (-3) 36 0x65, 0x11, # ..Unit (Centimeter,SILinear) 38 0x37, 'x_min', # ..Physical Minimum (TBD) 40 0x47, 'x_max', # ..Physical Maximum (TBD) 45 0x17, 'x_min', # ..Logical Minimum (TBD) 50 0x27, 'x_max', # ..Logical Maximum (TBD) 55 0x81, 0x02, # ..Input (Data,Var,Abs) 60 0x09, 0x31, # ..Usage (Y) 62 0x37, 'y_min', # ..Physical Minimum (TBD) 64 0x47, 'y_max', # ..Physical Maximum (TBD) 69 0x17, 'y_min', # ..Logical Minimum (TBD) 74 0x27, 'y_max', # ..Logical Maximum (TBD) 79 0x81, 0x02, # ..Input (Data,Var,Abs) 84 0x05, 0x0d, # ..Usage Page (Digitizers) 86 0x15, 0x00, # ..Logical Minimum (0) 88 0x09, 0x30, # ..Usage (Tip Pressure) 90 0x27, 'pressure', # ..Logical Maximum (TBD) 92 0x81, 0x02, # ..Input (Data,Var,Abs) 97 0xc0, # .End Collection 99 0xc0, # End Collection 100 ] def flatten(items): '''flatten an array of mixed int and arrays into a simple array of int''' for item in items: if isinstance(item, int): yield item else: yield from flatten(item) def signed_char_to_int(v): return int.from_bytes([v], byteorder='little', signed=True) def b2hex(bs): '''Convert bytes() to a two-letter hex string in the form "1a 2b c3"''' hx = binascii.hexlify(bs).decode('ascii') return ' '.join([''.join(s) for s in zip(hx[::2], hx[1::2])]) def list2hex(l): '''Converts a list of integers to a two-letter hex string in the form "1a 2b c3"''' return ' '.join([f'{x:02x}' for x in l]) def list2hexlist(l): '''Converts a list of integers to a two-letter prefixed hex string in the form "[0x1a, 0x32, 0xab]"''' return '[' + ', '.join([f'{x:#04x}' for x in l]) + ']' class DataLogger(object): ''' A wrapper to log data transfer between the device and Tuhi. Use as:: logger = DataLogger() logger.nordic.send([1, 2, 3...]) logger.nordic.recv([1, 2, 3...]) This uses a logger for stdout, but it also writes the log files to disk for future re-use. ''' class _Nordic(object): source = 'NORDIC' def __init__(self, parent): self.parent = parent def recv(self, data): return self.parent._recv(self.source, data) def send(self, data): return self.parent._send(self.source, data) class _Pen(object): source = 'PEN' def __init__(self, parent): self.parent = parent def recv(self, data): return self.parent._recv(self.source, data) class _Mysterious(object): source = 'MYSTERIOUS' def __init__(self, parent): self.parent = parent def recv(self, data): return self.parent._recv(self.source, data) commands = { 0xb1: 'start/stop live', 0xb6: 'set time', 0xb7: 'get firmware', 0xb9: 'read battery info', 0xbb: 'get/set name', 0xc1: 'check for data', 0xc3: 'start reading', 0xc5: 'fetch data', 0xc8: 'end of data', 0xca: 'ack transaction', 0xcc: 'fetch data', 0xea: 'get dimensions', 0xe5: 'finish registering', 0xe6: 'check connection', 0xdb: 'get name', } def __init__(self, bluez_device): import xdg.BaseDirectory self.logger = logging.getLogger('tuhi.fw') self.device = bluez_device self.btaddr = bluez_device.address self.logdir = os.path.join(xdg.BaseDirectory.xdg_data_home, 'tuhi', self.btaddr) os.makedirs(self.logdir, exist_ok=True) bluez_device.connect('connected', self._on_bluez_connected) bluez_device.connect('disconnected', self._on_bluez_disconnected) self.nordic = DataLogger._Nordic(self) self.pen = DataLogger._Pen(self) self.mysterious = DataLogger._Mysterious(self) self.logfile = None def _on_bluez_connected(self, bluez_device): self._init_file() def _on_bluez_disconnected(self, bluez_device): self._close_file() def _init_file(self): if self.logfile is not None: return timestamp = time.strftime('%Y%m%d-%H%M%S') fname = f'log-{timestamp}.yaml' path = os.path.join(self.logdir, fname) self.logfile = open(path, 'w+') self.logfile.write(f'name: {self.device.name}\n') self.logfile.write(f'bluetooth: {self.btaddr}\n') self.logfile.write(f'time: {time.strftime("%Y-%m-%d %H:%M:%S")}\n') self.logfile.write(f'data:\n') def _close_file(self): if self.logfile is None: return self.logfile.write(f'# closed at {time.strftime("%Y-%m-%d %H:%M:%S")}') self.logfile.close() self.logfile = None def _recv(self, source, data): if source in ['NORDIC', 'PEN']: def _convert(values): return list2hex(values) convert = _convert else: def _convert(values): return binascii.hexlify(bytes(values)) convert = _convert self.logger.debug(f'{self.btaddr}: RX {source} <-- {convert(data)}') self._init_file() if data[0] in self.commands: self.logfile.write(f'# {self.commands[data[0]]}\n') self.logfile.write(f' - recv: {list2hexlist(data)}\n') if source != 'NORDIC': self.logfile.write(f' source: {source}') def _send(self, source, data): command = data[0] arguments = data[1:] if data[0] in self.commands: self.logger.debug(f'command: {self.commands[data[0]]}') self.logger.debug(f'{self.btaddr}: TX {source} --> {command:02x} / {len(arguments):02x} / {list2hex(arguments)}') self._init_file() if data[0] in self.commands: self.logfile.write(f'# {self.commands[data[0]]}\n') self.logfile.write(f' - send: {list2hexlist(data)}\n') if source != 'NORDIC': self.logfile.write(f' source: {source}') class NordicData(list): '''A set of bytes as expected by the Nordic controller on the device. First byte is the opcode, second byte is the length, rest is data. This is an abstraction of a list. Instantiate with the full raw data, the list contents will just be the data bytes. ''' def __init__(self, bs): super().__init__(bs[2:]) self.opcode = bs[0] self.length = bs[1] class WacomException(Exception): errno = errno.ENOSYS class WacomEEAGAINException(WacomException): errno = errno.EAGAIN class WacomWrongModeException(WacomException): errno = errno.EBADE class WacomNotRegisteredException(WacomException): errno = errno.EACCES class WacomTimeoutException(WacomException): errno = errno.ETIME class WacomCorruptDataException(WacomException): errno = errno.EPROTO class WacomPacket(GObject.Object): ''' A single protocol packet of variable length. The protocol format is a single-byte bitmask followed by up to 8 bytes (depending on the number of 1-bits in the bitmask). Each byte represents the matching bit in the bitmask, i.e. the data is non-sparse. If the bitmask has 0x1 and/or 0x2 set, those two bytes make up the opcode of the command. So the possible layouts are: | bitmask | opcode1 | opcode2 | payload ... | bitmask | opcode1 | payload ... | bitmask | opcode2 | payload ... | bitmask | payload On most normal packets containing motion data, the opcode is not present. Attributes: bitmask .. single byte with a bitmask denoting the contents opcode ... the 16-bit opcode or None for 'special' packets. Note that the opcode is converted into an integer from the little-endian protocol format bytes .... a list of the payload bytes as sent by the device. This is a non-sparse list matching the number of set bits in the bitmask. it does not include the bitmask. args ..... a sparse list of the payload bytes, expanded to match the bitmask so that args[x] is the value for each bit x in bitmask. it does not include the bitmask. length ... length of the packet in bytes, including bitmask ''' def __init__(self, data): self.bitmask = data[0] nbytes = bin(self.bitmask).count('1') self.bytes = data[1:1 + nbytes] self.length = nbytes + 1 # for the bitmask idx = 0 # 2-byte opcode, but only if the bitmask is set for either byte opcode = 0 if self.bitmask & 0x1: opcode |= self.bytes[idx] idx += 1 if self.bitmask & 0x2: opcode |= self.bytes[idx] << 8 idx += 1 self.opcode = opcode if opcode else None self.args = [] vals = self.bytes.copy() mask = self.bitmask while mask != 0: self.args.append(vals.pop(0) if mask & 0x1 else 0x00) mask >>= 1 def __repr__(self): debug_data = [] debug_data.append(f'{self.bitmask:02x} ({self.bitmask:08b}) |') if self.opcode: debug_data.append(f'{self.opcode:04x} |') else: debug_data.append(f' |') for i in range(2, 8): # start at 2 to skip the opcode if self.bitmask & (1 << i): debug_data.append(f'{self.args[i]:02x}') else: debug_data.append(' ') return " ".join(debug_data) class WacomPacketHandler(GObject.Object): def process(self, packet, drawing): raise NotImplementedError('This method must be implemented in the subclass') class WacomPacketHandlerEndOfSequence(WacomPacketHandler): def process(self, packet, drawing): if bytes(packet.args) != b'\xff\xff\xff\xff\xff\xff\xff\xff': return False logger.info(f'end of sequence') return True class WacomPacketHandlerEndOfStroke(WacomPacketHandler): def process(self, packet, drawing): if bytes(packet.args) != b'\x00\x00\xff\xff\xff\xff\xff\xff': return False logger.info(f'end of stroke') drawing.current_stroke.seal() return True class WacomPacketHandlerStrokePrefixSlate(WacomPacketHandler): def process(self, packet, drawing): if packet.opcode != 0xeeff: return False # some sort of headers time_offset = int.from_bytes(packet.bytes[4:], byteorder='little') logger.info(f'time offset since boot: {time_offset * 0.005} secs') drawing.new_stroke() return True class WacomPacketHandlerStrokePrefixIntuosPro(WacomPacketHandler): def process(self, packet, drawing): if packet.opcode != 0x03fa: return False t = WacomProtocolIntuosPro.time_from_bytes(packet.bytes[2:]) t = time.strftime("%y%m%d%H%M%S", t) logger.info(f'stroke time: {t}') drawing.new_stroke() return True class WacomPacketHandlerStrokeTimestampIntuosPro(WacomPacketHandler): def process(self, packet, drawing): if packet.opcode != 0xc3fa: return False # First stroke timestamp, note this is less than the drawing's # timestamp # ff fa c3 <6-byte-timestamp> t = WacomProtocolIntuosPro.time_from_bytes(packet.bytes[2:]) t = time.strftime("%y%m%d%H%M%S", t) logger.info(f'stroke time: {t}') return True class WacomPacketHandlerUnknownFixedStrokeDataIntuosPro(WacomPacketHandler): def process(self, packet, drawing): if packet.opcode != 0x870a: return False # Unclear what this header is expected_bytes = b'\xff\x0a\x87\x75\x80\x28\x42\x00\x10' if bytes(packet.bytes) != expected_bytes: logger.debug(f'Missing header, got {packet.bytes}') return True class WacomProtocolLowLevelComm(GObject.Object): ''' Internal class to handle the communication with the Wacom device. No-one should directly instanciate this. :param device: the BlueZDevice object that is this wacom device ''' def __init__(self, device): GObject.Object.__init__(self) self.device = device self.nordic_answer = [] self.fw_logger = DataLogger(device) self.nordic_event = threading.Semaphore(value=0) device.connect_gatt_value(NORDIC_UART_CHRC_RX_UUID, self._on_nordic_data_received) def _on_nordic_data_received(self, name, value): self.fw_logger.nordic.recv(value) self.nordic_answer += value self.nordic_event.release() def send_nordic_command(self, command, arguments): chrc = self.device.characteristics[NORDIC_UART_CHRC_TX_UUID] data = [command, len(arguments), *arguments] self.fw_logger.nordic.send(data) chrc.write_value(data) def check_nordic_incoming(self): answer = self.nordic_answer length = answer[1] args = answer[2:] if length > len(args): raise WacomException(f'error while processing answer, should get an answer of size {length} instead of {len(args)}') self.nordic_answer = self.nordic_answer[length + 2:] # opcode + len return NordicData(answer) def wait_nordic_data(self, expected_opcode, timeout=None): if not self.nordic_event.acquire(timeout=timeout): # timeout raise WacomTimeoutException(f'{self.device.name}: Timeout while reading data') data = self.check_nordic_incoming() # logger.debug(f'received {data.opcode:02x} / {data.length:02x} / {b2hex(bytes(data))}') if isinstance(expected_opcode, list): if data.opcode not in expected_opcode: raise WacomException(f'unexpected opcode: {data.opcode:02x}') else: if data.opcode != expected_opcode: raise WacomException(f'unexpected opcode: {data.opcode:02x}') return data def check_ack(self, data): if len(data) != 1: str_b = binascii.hexlify(bytes(data)) raise WacomException(f'unexpected data: {str_b}') if data[0] == 0x01: raise WacomWrongModeException(f'wrong device mode') elif data[0] == 0x02: raise WacomEEAGAINException(f'unexpected answer: {data[0]:02x}') elif data[0] == 0x05: raise WacomCorruptDataException(f'invalid opcode') elif data[0] == 0x07: raise WacomNotRegisteredException(f'wrong device, please re-register') elif data[0] != 0x00: raise WacomException(f'unknown error: {data[0]:02x}') def send_nordic_command_sync(self, command, expected_opcode=0xb3, arguments=None): if arguments is None: arguments = [0x00] self.send_nordic_command(command, arguments) if expected_opcode is None: return None args = self.wait_nordic_data(expected_opcode, 5) if expected_opcode == 0xb3: # generic ACK self.check_ack(args) return args class WacomRegisterHelper(WacomProtocolLowLevelComm): ''' Class used to register a device. This class is only useful for the very first register commands and attempts to detect the type of device based on the responses. Once register_device has finished, the correct protocol is returned. This may later be used for init_protocol() to instantiate the right class. ''' __gsignals__ = { # Signal sent when the device requires the user to press the # physical button 'button-press-required': (GObject.SignalFlags.RUN_FIRST, None, ()), } @classmethod def is_spark(cls, device): return MYSTERIOUS_NOTIFICATION_CHRC_UUID not in device.characteristics def register_device(self, uuid): protocol = Protocol.UNKNOWN args = [int(i) for i in binascii.unhexlify(uuid)] if self.is_spark(self.device): # The spark replies with b3 01 01 when in pairing mode # Usually that triggers a WacomWrongModeException but here it's # expected try: self.send_nordic_command_sync(command=0xe6, arguments=args) except WacomWrongModeException: # this is expected pass # The "press button now command" on the spark self.send_nordic_command(command=0xe3, arguments=[0x01]) protocol = Protocol.SPARK else: # Slate requires a button press in response to e7 directly self.send_nordic_command(command=0xe7, arguments=args) logger.info('Press the button now to confirm') self.emit('button-press-required') # Wait for the button confirmation event, or any error data = self.wait_nordic_data([0xe4, 0xb3, 0x53], 10) if protocol == Protocol.UNKNOWN: if data.opcode == 0xe4: protocol = Protocol.SLATE elif data.opcode == 0x53: protocol = Protocol.INTUOS_PRO else: raise WacomException(f'unexpected opcode to register reply: {data.opcode:02x}') return protocol class WacomProtocolBase(WacomProtocolLowLevelComm): ''' Internal class to handle the basic communications with the Wacom device. No-one should directly instanciate this. :param device: the BlueZDevice object that is this wacom device :param uuid: the UUID {to be} assigned to the device ''' protocol = Protocol.UNKNOWN __gsignals__ = { # Signal sent for each single drawing that becomes available. The # drawing is the signal's argument 'drawing': (GObject.SignalFlags.RUN_FIRST, None, (GObject.TYPE_PYOBJECT,)), # battery level in %, boolean for is-charging "battery-status": (GObject.SignalFlags.RUN_FIRST, None, (GObject.TYPE_INT, GObject.TYPE_BOOLEAN)), } def __init__(self, device, uuid): super().__init__(device) self._uuid = uuid self._timestamp = 0 self.pen_data_buffer = [] self._uhid_device = None self._last_pen_data_time = time.time() - 5 # initialize this in the past device.connect_gatt_value(WACOM_CHRC_LIVE_PEN_DATA_UUID, self._on_pen_data_changed) device.connect_gatt_value(WACOM_OFFLINE_CHRC_PEN_DATA_UUID, self._on_pen_data_received) # Instantiate all packet_handlers from our current object and its # parent classes self.packet_handlers = [] parents = inspect.getmro(self.__class__) child = None for cls in parents: if cls.__name__ == 'WacomProtocolBase': break if (child is not None and child.packet_handlers and child.packet_handlers == cls.packet_handlers): raise NotImplementedError(f'Subclass {child} must override packet_handlers') for handler in cls.packet_handlers: h = handler() self.packet_handlers.append(h) child = cls @GObject.property def dimensions(self): return (self.width, self.height) def _on_pen_data_changed(self, name, value): logger.debug(binascii.hexlify(bytes(value))) if value[0] == 0x10: pressure = int.from_bytes(value[2:4], byteorder='little') buttons = int(value[10]) logger.debug(f'New Pen Data: pressure: {pressure}, button: {buttons}') elif value[0] == 0xa2: # entering proximity event length = value[1] # timestamp is now in ms timestamp = int.from_bytes(value[4:], byteorder='little') * 5 self._timestamp = timestamp logger.debug(f'Pen entered proximity, timestamp: {timestamp}') elif value[0] == 0xa1: # data event length = value[1] if length % 6 != 0: logger.error(f'wrong data: {binascii.hexlify(bytes(value))}') return data = value[2:] while data: if bytes(data) == b'\xff\xff\xff\xff\xff\xff': logger.debug(f'Pen left proximity') if self._uhid_device is not None: self._uhid_device.call_input_event([1, 0, 0, 0, 0, 0, 0, 0]) else: x = int.from_bytes(data[0:2], byteorder='little') y = int.from_bytes(data[2:4], byteorder='little') pressure = int.from_bytes(data[4:6], byteorder='little') logger.debug(f'New Pen Data: ({x},{y}), pressure: {pressure}') if self._uhid_device is not None: self._uhid_device.call_input_event([1, 1, *data[:6]]) data = data[6:] self._timestamp += 5 def _on_pen_data_received(self, name, data): self.fw_logger.pen.recv(data) self.pen_data_buffer.extend(data) self._last_pen_data_time = time.time() def check_connection(self): args = [int(i) for i in binascii.unhexlify(self._uuid)] self.send_nordic_command_sync(command=0xe6, arguments=args) def e3_command(self): self.send_nordic_command_sync(command=0xe3) def time_to_bytes(self): # Device time is UTC current_time = time.strftime('%y%m%d%H%M%S', time.gmtime()) return [int(i) for i in binascii.unhexlify(current_time)] @classmethod def time_from_bytes(self, data): assert len(data) >= 6 str_timestamp = ''.join([f'{d:02x}' for d in data]) return time.strptime(str_timestamp, '%y%m%d%H%M%S') def set_time(self): args = self.time_to_bytes() self.send_nordic_command_sync(command=0xb6, arguments=args) def read_time(self): data = self.send_nordic_command_sync(command=0xb6, expected_opcode=0xbd) ts = self.time_from_bytes(data) logger.debug(f'device time: UTC {time.strftime("%y%m%d%H%M%S", ts)}') tdelta = time.mktime(time.gmtime()) - time.mktime(ts) if abs(tdelta) > 300: logger.error(f'device time is out by more than 5 minutes') def get_battery_info(self): data = self.send_nordic_command_sync(command=0xb9, expected_opcode=0xba) return int(data[0]), data[1] == 1 def get_firmware_version(self, arg): data = self.send_nordic_command_sync(command=0xb7, expected_opcode=0xb8, arguments=(arg,)) fw = ''.join([hex(d)[2:] for d in data[1:]]) return fw.upper() def get_name(self): data = self.send_nordic_command_sync(command=0xbb, expected_opcode=0xbc) return bytes(data) def get_dimensions(self, arg): possible_args = { 'width': 3, 'height': 4, } args = [possible_args[arg], 0x00] data = self.send_nordic_command_sync(command=0xea, expected_opcode=0xeb, arguments=args) if len(data) != 6: str_data = binascii.hexlify(bytes(data)) raise WacomCorruptDataException(f'unexpected answer for get_dimensions: {str_data}') return int.from_bytes(data[2:4], byteorder='little') def ec_command(self): args = [0x06, 0x00, 0x00, 0x00, 0x00, 0x00] self.send_nordic_command_sync(command=0xec, arguments=args) def start_live(self, fd): self.send_nordic_command_sync(command=0xb1) logger.debug(f'Starting wacom live mode on fd: {fd}') rdesc = wacom_live_rdesc_template[:] for i, v in enumerate(rdesc): if isinstance(v, str): v = getattr(self, v) rdesc[i] = list(int.to_bytes(v, 4, 'little', signed=True)) uhid_device = UHIDDevice(fd) uhid_device.rdesc = list(flatten(rdesc)) uhid_device.name = self.device.name uhid_device.info = (5, 0x056a, 0x0001) uhid_device.create_kernel_device() self._uhid_device = uhid_device def stop_live(self): args = [0x02] self.send_nordic_command_sync(command=0xb1, arguments=args) def b1_command(self): args = [0x01] self.send_nordic_command_sync(command=0xb1, arguments=args) def is_data_available(self): data = self.send_nordic_command_sync(command=0xc1, expected_opcode=0xc2) n = int.from_bytes(data[0:2], byteorder='big') logger.debug(f'Drawings available: {n}') return n > 0 def get_stroke_data(self): data = self.send_nordic_command_sync(command=0xc5, expected_opcode=[0xc7, 0xcd]) # FIXME: Sometimes the 0xc7 is missing on the spark? Not in any of # the btsnoop logs but I only rarely get a c7 response here count = 0 if data.opcode == 0xc7: count = int.from_bytes(data[0:4], byteorder='little') data = self.wait_nordic_data(0xcd, 5) # logger.debug(f'cc returned {data} ') str_timestamp = ''.join([f'{d:02x}' for d in data]) timestamp = time.strptime(str_timestamp, '%y%m%d%H%M%S') return count, timestamp def start_reading(self): data = self.send_nordic_command_sync(command=0xc3, expected_opcode=0xc8) if data[0] != 0xbe: raise WacomException(f'unexpected answer: {data[0]:02x}') def wait_nordic_unless_pen_data(self, opcode, timeout=None): data = None while data is None: try: data = self.wait_nordic_data(opcode, timeout) except WacomTimeoutException: # timeout is a time in seconds here if time.time() - self._last_pen_data_time < timeout: # we timed out, but we are still fetching offline pen data continue raise return data def wait_for_end_read(self): data = self.wait_nordic_unless_pen_data(0xc8, 5) if data[0] != 0xed: raise WacomException(f'unexpected answer: {data[0]:02x}') data = self.wait_nordic_data(0xc9, 5) crc = data crc = int(binascii.hexlify(bytes(crc)), 16) pen_data = self.pen_data_buffer self.pen_data_buffer = [] if crc != binascii.crc32(bytes(pen_data)): logger.error("CRCs don't match") return pen_data def retrieve_data(self): try: self.check_connection() self.e3_command() self.set_time() battery, charging = self.get_battery_info() if charging: logger.debug(f'device is plugged in and charged at {battery}%') else: logger.debug(f'device is discharging: {battery}%') self.emit('battery-status', battery, charging) if self.read_offline_data() == 0: logger.info('no data to retrieve') except WacomEEAGAINException: logger.warning('no data, please make sure the LED is blue and the button is pressed to switch it back to green') def ack_transaction(self): self.send_nordic_command_sync(command=0xca, expected_opcode=None) def get_coordinate(self, bitmask, n, data, v, dv): # drop the first 2 bytes as they are not valuable here bitmask >>= 2 data = data[2:] is_rel = False full_coord_bitmask = 0b11 << (2 * n) delta_coord_bitmask = 0b10 << (2 * n) if (bitmask & full_coord_bitmask) == full_coord_bitmask: v = int.from_bytes(data[2 * n:2 * n + 2], byteorder='little') dv = 0 elif bitmask & delta_coord_bitmask: dv += signed_char_to_int(data[2 * n + 1]) is_rel = True return v, dv, is_rel def parse_pen_data_prefix(self, data): expected_prefix = b'\x62\x38\x62\x74' prefix = data[:4] offset = len(prefix) # not sure if we really need this check if bytes(prefix) != expected_prefix: logger.debug(f'Expected pen data prefix {expected_prefix} but got {prefix}') return False, 0 return True, offset def parse_pen_data(self, data, timestamp): ''' :param timestamp: a tuple with 9 entries, corresponding to the local time ''' x, y, p = 0, 0, 0 dx, dy, dp = 0, 0, 0 timestamp = int(calendar.timegm(timestamp)) stroke = None success, offset = self.parse_pen_data_prefix(data) if not success: return None drawing = Drawing(self.device.name, (self.width, self.height), timestamp) while offset < len(data): packet = WacomPacket(data[offset:]) logger.debug(f'packet: {packet}') offset += packet.length has_handler = False for handler in self.packet_handlers: if handler.process(packet, drawing): has_handler = True break if has_handler: continue stroke = drawing.current_stroke if stroke is None: stroke = drawing.new_stroke() x, dx, xrel = self.get_coordinate(packet.bitmask, 0, packet.args, x, dx) y, dy, yrel = self.get_coordinate(packet.bitmask, 1, packet.args, y, dy) p, dp, prel = self.get_coordinate(packet.bitmask, 2, packet.args, p, dp) x += dx y += dy p += dp xr = '*' if xrel else '' yr = '*' if yrel else '' pr = '*' if prel else '' logger.info(f'point at {x},{y} ({dx:+}{xr}, {dy:+}{yr}) with pressure {p} ({dp:+}{pr})') if packet.bitmask & 0b00111100 == 0: continue stroke.new_abs((x, y), p) drawing.seal() return drawing def read_offline_data(self): self.b1_command() transaction_count = 0 while self.is_data_available(): count, timestamp = self.get_stroke_data() logger.info(f'receiving {count} bytes drawn on UTC {time.strftime("%y%m%d%H%M%S", timestamp)}') self.start_reading() pen_data = self.wait_for_end_read() str_pen = binascii.hexlify(bytes(pen_data)) logger.info(f'received {str_pen}') drawing = self.parse_pen_data(pen_data, timestamp) if drawing: self.emit('drawing', drawing) self.ack_transaction() transaction_count += 1 return transaction_count def set_name(self, name): # On the Spark, the name needs a trailing linebreak, otherwise the # firmware gets confused. args = [ord(c) for c in name] + [0x0a] data = self.send_nordic_command_sync(command=0xbb, arguments=args) return bytes(data) def register_device_finish(self): self.send_nordic_command_sync(command=0xe5, arguments=None) self.set_time() self.read_time() name = self.get_name() logger.info(f'device name is {name}') fw_high = self.get_firmware_version(0) fw_low = self.get_firmware_version(1) logger.info(f'firmware is {fw_high}-{fw_low}') def live_mode(self, mode, uhid): try: if mode: self.check_connection() self.start_live(uhid) else: self.stop_live() except WacomEEAGAINException: logger.warning("no data, please make sure the LED is blue and the button is pressed to switch it back to green") class WacomProtocolSpark(WacomProtocolBase): ''' Subclass to handle the communication oddities with the Wacom Spark-like devices. :param device: the BlueZDevice object that is this wacom device :param uuid: the UUID {to be} assigned to the device ''' width = 21600 x_min = 2500 x_max = 20600 height = 14800 y_min = 800 y_max = 14300 pressure = 2047 protocol = Protocol.SPARK packet_handlers = [WacomPacketHandlerEndOfStroke, WacomPacketHandlerEndOfSequence] class WacomProtocolSlate(WacomProtocolSpark): ''' Subclass to handle the communication oddities with the Wacom Slate-like devices. :param device: the BlueZDevice object that is this wacom device :param uuid: the UUID {to be} assigned to the device ''' width = 21600 x_min = 2500 x_max = 20600 height = 14800 y_min = 500 y_max = 14300 pressure = 2047 protocol = Protocol.SLATE packet_handlers = [WacomPacketHandlerStrokePrefixSlate] def __init__(self, device, uuid): super().__init__(device, uuid) device.connect_gatt_value(MYSTERIOUS_NOTIFICATION_CHRC_UUID, self._on_mysterious_data_received) def live_mode(self, mode, uhid): # Slate tablet has two models A5 and A4 # Here, we read real tablet dimensions before # starting live mode self.width = self.get_dimensions('width') self.height = self.get_dimensions('height') self.notify('dimensions') self.x_max = self.width - 1000 self.y_max = self.height - 500 return super().live_mode(mode, uhid) def _on_mysterious_data_received(self, name, value): self.fw_logger.mysterious.recv(value) def ack_transaction(self): self.send_nordic_command_sync(command=0xca) def is_data_available(self): data = self.send_nordic_command_sync(command=0xc1, expected_opcode=0xc2) n = int.from_bytes(data[0:2], byteorder='little') logger.debug(f'Drawings available: {n}') return n > 0 def get_stroke_data(self): data = self.send_nordic_command_sync(command=0xcc, expected_opcode=0xcf) # logger.debug(f'cc returned {data} ') count = int.from_bytes(data[0:4], byteorder='little') timestamp = self.time_from_bytes(data[4:]) return count, timestamp def register_device_finish(self): self.set_time() self.read_time() self.ec_command() name = self.get_name() logger.info(f'device name is {name}') w = self.get_dimensions('width') h = self.get_dimensions('height') logger.debug(f'dimensions: {w}x{h}') if self.width != w or self.height != h: logger.error(f'incompatible dimensions: {w}x{h}') self.notify('dimensions') fw_high = self.get_firmware_version(0) fw_low = self.get_firmware_version(1) logger.info(f'firmware is {fw_high}-{fw_low}') battery, charging = self.get_battery_info() if charging: logger.debug(f'device is plugged in and charged at {battery}%') else: logger.debug(f'device is discharging: {battery}%') self.emit('battery-status', battery, charging) def retrieve_data(self): try: self.check_connection() self.set_time() battery, charging = self.get_battery_info() if charging: logger.debug(f'device is plugged in and charged at {battery}%') else: logger.debug(f'device is discharging: {battery}%') self.emit('battery-status', battery, charging) self.width = w = self.get_dimensions('width') self.height = h = self.get_dimensions('height') self.notify('dimensions') logger.debug(f'dimensions: {w}x{h}') fw_high = self.get_firmware_version(0) fw_low = self.get_firmware_version(1) logger.debug(f'firmware is {fw_high}-{fw_low}') self.ec_command() if self.read_offline_data() == 0: logger.info('no data to retrieve') except WacomEEAGAINException: logger.warning('no data, please make sure the LED is blue and the button is pressed to switch it back to green') def wait_for_end_read(self): data = self.wait_nordic_unless_pen_data(0xc8, 5) if data[0] != 0xed: raise WacomException(f'unexpected answer: {data[0]:02x}') crc = data[1:] crc.reverse() crc = int(binascii.hexlify(bytes(crc)), 16) pen_data = self.pen_data_buffer self.pen_data_buffer = [] if crc != binascii.crc32(bytes(pen_data)): raise WacomCorruptDataException("CRCs don't match") return pen_data class WacomProtocolIntuosPro(WacomProtocolSlate): ''' Subclass to handle the communication oddities with the Wacom IntuosPro-like devices. :param device: the BlueZDevice object that is this wacom device :param uuid: the UUID {to be} assigned to the device ''' width = 44800 x_min = 0 x_max = 44800 height = 29600 y_min = 0 y_max = 29600 pressure = 4095 protocol = Protocol.INTUOS_PRO packet_handlers = [WacomPacketHandlerStrokePrefixIntuosPro, WacomPacketHandlerStrokeTimestampIntuosPro, WacomPacketHandlerUnknownFixedStrokeDataIntuosPro] def __init__(self, device, uuid): super().__init__(device, uuid) def time_to_bytes(self): t = int(time.time()) return list(t.to_bytes(length=4, byteorder='little')) + [0x00, 0x00] @classmethod def time_from_bytes(self, data): seconds = int.from_bytes(data[0:4], byteorder='little') return time.localtime(seconds) # set_time is identical to spark/slate except the timestamp format def read_time(self): data = self.send_nordic_command_sync(command=0xd6, expected_opcode=0xbd) # Last two bytes are unknown ts = time.strftime('%y-%m-%d %H:%M:%S', self.time_from_bytes(data)) logger.debug(f'b6 returned: {ts}') def get_firmware_version(self, arg): data = self.send_nordic_command_sync(command=0xb7, expected_opcode=0xb8, arguments=(arg,)) fw = ''.join([chr(d) for d in data[1:]]) return fw def get_name(self): data = self.send_nordic_command_sync(command=0xdb, expected_opcode=0xbc) return bytes(data) def set_name(self, name): args = [ord(c) for c in name] data = self.send_nordic_command_sync(command=0xbb, arguments=args) return bytes(data) def check_connection(self): args = [int(i) for i in binascii.unhexlify(self._uuid)] self.send_nordic_command_sync(command=0xe6, expected_opcode=[0x50, 0x51], arguments=args) def parse_pen_data_prefix(self, data): expected_prefix = b'\x67\x82\x69\x65' prefix = data[:4] offset = len(prefix) # not sure if we really need this check if bytes(prefix) != expected_prefix: logger.debug(f'Expected pen data prefix {expected_prefix} but got {prefix}') return False, 0 # This is the time the button was pressed after drawing, i.e. the # end of the drawing t = self.time_from_bytes(data[offset:]) offset += 6 # Confirmed it's LE for at least 2 bytes (that was fun...), but # could be 4 or more. Are 0xffff strokes enough for everybody? nstrokes = int.from_bytes(data[offset:offset + 2], byteorder='little') offset += 2 logger.debug(f'Drawing timestamp: {t}, {nstrokes} strokes') # Can't have enough zeroes. They'll come in handy one day expected_header = b'\x00\x00\x00\x00' data_header = data[offset:offset + len(expected_header)] if bytes(data_header) != expected_header: logger.debug(f'Missing zeroes, got {data_header}') offset += 4 return True, offset class WacomDevice(GObject.Object): ''' Class to communicate with the Wacom device. Communication is handled in a separate thread. :param device: the BlueZDevice object that is this wacom device ''' __gsignals__ = { # Signal sent for each single drawing that becomes available. The # drawing is the signal's argument 'drawing': (GObject.SignalFlags.RUN_FIRST, None, (GObject.TYPE_PYOBJECT,)), # Signal sent when a device connection (register or listen) is # complete. Carries the exception object or None on success 'done': (GObject.SignalFlags.RUN_FIRST, None, (GObject.TYPE_PYOBJECT, )), # Signal sent when the device requires the user to press the # physical button 'button-press-required': (GObject.SignalFlags.RUN_FIRST, None, ()), # battery level in %, boolean for is-charging "battery-status": (GObject.SignalFlags.RUN_FIRST, None, (GObject.TYPE_INT, GObject.TYPE_BOOLEAN)), } def __init__(self, device, config=None): GObject.Object.__init__(self) self._device = device self.thread = None self._is_running = False self._config = None self._wacom_protocol = None self._sync_state = 0 try: self._config = config.devices[device.address] except KeyError: # unregistered device self._uuid = None else: self._uuid = self._config['uuid'] # retrieve the protocol from the config file protocol = Protocol.UNKNOWN try: protocol = next(p for p in Protocol if p.value == self._config['Protocol']) except StopIteration: logger.error(f'Unknown protocol in configuration: {self._config["Protocol"]}') raise WacomCorruptDataException(f'Unknown Protocol {self._config["Protocol"]}') if protocol == Protocol.UNKNOWN: raise WacomCorruptDataException(f'Missing Protocol entry from config file. Please delete config file and re-register device') self._init_protocol(protocol) def _init_protocol(self, protocol): protocols = { Protocol.SPARK: WacomProtocolSpark, Protocol.SLATE: WacomProtocolSlate, Protocol.INTUOS_PRO: WacomProtocolIntuosPro, } if protocol not in protocols: raise WacomCorruptDataException(f'Protocol "{protocol}" not implemented') pclass = protocols[protocol] self._wacom_protocol = pclass(self._device, self._uuid) logger.debug(f'{self._device.name} is using protocol {protocol}') self._wacom_protocol.connect( 'drawing', lambda protocol, drawing, self: self.emit('drawing', drawing), self) self._wacom_protocol.connect( 'battery-status', lambda prot, percent, is_charging, self: self.emit('battery-status', percent, is_charging), self) self._wacom_protocol.connect('notify::dimensions', self._on_dimensions) @GObject.Property def dimensions(self): return self._wacom_protocol.dimensions def _on_dimensions(self, protocol, pspec): self.notify('dimensions') @GObject.Property def uuid(self): assert self._uuid is not None return self._uuid @GObject.Property def protocol(self): assert self._wacom_protocol is not None return self._wacom_protocol.protocol @GObject.Property def sync_state(self): return self._sync_state @sync_state.setter def sync_state(self, state): self._sync_state = state def register_device(self): self._uuid = uuid.uuid4().hex[:12] logger.debug(f'{self._device.address}: registering device, assigned {self.uuid}') wp = WacomRegisterHelper(self._device) s = wp.connect('button-press-required', lambda protocol, self: self.emit('button-press-required'), self) protocol = wp.register_device(self._uuid) wp.disconnect(s) del wp self._init_protocol(protocol) self._wacom_protocol.register_device_finish() logger.info('registration completed') self.notify('uuid') def _run(self, *args, **kwargs): if self._is_running: logger.error(f'{self._device.address}: already synching, ignoring this request') return mode = args[0] logger.debug(f'{self._device.address}: starting') self._is_running = True exception = None try: if mode == DeviceMode.LIVE: assert self._wacom_protocol is not None self._wacom_protocol.live_mode(args[1], args[2]) elif mode == DeviceMode.REGISTER: self.register_device() else: assert self._wacom_protocol is not None self.sync_state = 1 self._wacom_protocol.retrieve_data() self.sync_state = 0 except WacomException as e: logger.error(f'**** Exception: {e} ****') exception = e self.sync_state = 0 finally: self._is_running = False self.emit('done', exception) def start_listen(self): self.thread = threading.Thread(target=self._run, args=(DeviceMode.LISTEN,)) self.thread.start() def start_live(self, uhid_fd): self.thread = threading.Thread(target=self._run, args=(DeviceMode.LIVE, True, uhid_fd)) self.thread.start() def stop_live(self): self.thread = threading.Thread(target=self._run, args=(DeviceMode.LIVE, False, -1)) self.thread.start() def start_register(self): self.thread = threading.Thread(target=self._run, args=(DeviceMode.REGISTER,)) self.thread.start()