Merge a1db542 into dff28c7

Author: FelixGruetzmacher

source/brailleDisplayDrivers/handyTech.py

@@ -110,6 +110,8 @@ def windowProc(self, hwnd: int, msg: int, wParam: int, lParam: int):
 MODEL_MODULAR_80 = b"\x88"
 MODEL_MODULAR_40 = b"\x89"
 MODEL_ACTIVATOR = b"\xA4"
+MODEL_ACTIVATOR_PRO_64 = b"\xA6"
+MODEL_ACTIVATOR_PRO_80 = b"\xA8"
 
 # Key constants
 KEY_B1 = 0x03
@@ -373,6 +375,15 @@ def display(self, cells: List[int]):
 		super(StatusCellMixin, self).display(cells)
 
 
+class ActiveSplitMixin(object):
+	"""Mixin for displays supporting ActiveSplit, i.e. dynamic adjustment of number of cells"""
+
+	def postInit(self):
+		super(ActiveSplitMixin, self).postInit()
+		log.debug("Prevent disconnect/reconnect activity for dynamic length adjustment")
+		self._display.sendExtendedPacket(HT_EXTPKT_NO_RECONNECT)
+
+
 class ModularConnect88(TripleActionKeysMixin, Model):
 	deviceId = MODEL_MODULAR_CONNECT_88
 	genericName = "Modular Connect"
@@ -531,7 +542,14 @@ class Modular80(Modular):
 	numCells = 80
 
 
-class Activator(TimeSyncFirmnessMixin, AtcMixin, JoystickMixin, TripleActionKeysMixin, Model):
+class Activator(
+	ActiveSplitMixin,
+	TimeSyncFirmnessMixin,
+	AtcMixin,
+	JoystickMixin,
+	TripleActionKeysMixin,
+	Model
+):
 	deviceId = MODEL_ACTIVATOR
 	numCells = 40
 	genericName = name = 'Activator'
@@ -545,6 +563,40 @@ def _get_keys(self) -> Dict[int, str]:
 		return keys
 
 
+class ActivatorPro64(
+	ActiveSplitMixin,
+	TimeSyncFirmnessMixin,
+	AtcMixin,
+	TripleActionKeysMixin,
+	Model
+):
+	deviceId = MODEL_ACTIVATOR_PRO_64
+	numCells = 64
+	genericName = name = 'Activator Pro 64'
+
+	def _get_keys(self) -> Dict[int, str]:
+		keys = super().keys
+		keys.update({
+			0x7A: "escape",
+			0x7B: "return",
+		})
+		return keys
+
+
+class ActivatorPro80(ActiveSplitMixin, TimeSyncFirmnessMixin, AtcMixin, TripleActionKeysMixin, Model):
+	deviceId = MODEL_ACTIVATOR_PRO_80
+	numCells = 80
+	genericName = name = 'Activator Pro 80'
+
+	def _get_keys(self) -> Dict[int, str]:
+		keys = super().keys
+		keys.update({
+			0x7A: "escape",
+			0x7B: "return",
+		})
+		return keys
+
+
 def _allSubclasses(cls):
 	"""List all direct and indirect subclasses of cls
 
@@ -569,6 +621,7 @@ def _allSubclasses(cls):
 HT_PKT_NAK = b"\x7D"
 HT_PKT_ACK = b"\x7E"
 HT_PKT_OK = b"\xFE"
+HT_PKT_OK_WITH_LENGTH = b"\xFD"
 HT_PKT_RESET = b"\xFF"
 HT_EXTPKT_BRAILLE = HT_PKT_BRAILLE
 HT_EXTPKT_KEY = b"\x04"
@@ -589,6 +642,7 @@ def _allSubclasses(cls):
 HT_EXTPKT_GET_FIRMNESS = b"\x61"
 HT_EXTPKT_GET_PROTOCOL_PROPERTIES = b"\xC1"
 HT_EXTPKT_GET_FIRMWARE_VERSION = b"\xC2"
+HT_EXTPKT_NO_RECONNECT = b"\xAE"
 
 # HID specific constants
 HT_HID_RPT_OutData = b"\x01" # receive data from device
@@ -637,6 +691,8 @@ def registerAutomaticDetection(cls, driverRegistrar: bdDetect.DriverRegistrar):
 			"VID_1FE4&PID_0093",  # Basic Braille Plus 32
 			"VID_1FE4&PID_0094",  # Basic Braille Plus 40
 			"VID_1FE4&PID_00A4",  # Activator
+			"VID_1FE4&PID_00A6",  # Activator Pro 64
+			"VID_1FE4&PID_00A8",  # Activator Pro 80
 		})
 
 		# Some older HT displays use a HID converter and an internal serial interface
@@ -656,7 +712,7 @@ def registerAutomaticDetection(cls, driverRegistrar: bdDetect.DriverRegistrar):
 			"Braillino BL",
 			"Braille Wave BW",
 			"Easy Braille EBR",
-			"Activator AC",
+			"Activator",
 		)))
 
 	@classmethod
@@ -712,6 +768,9 @@ def __init__(self, port="auto"):
 
 			if self.numCells:
 				# A display responded.
+				if not isinstance(self._model, OldProtocolMixin):
+					self.sendExtendedPacket(HT_EXTPKT_GET_PROTOCOL_PROPERTIES)
+					self._dev.waitForRead(self.timeout)
 				self._model.postInit()
 				log.info("Found {device} connected via {type} ({port})".format(
 					device=self._model.name, type=portType, port=port))
@@ -923,15 +982,18 @@ def _serialOnReceive(self, data: bytes):
 		self._handleInputStream(data, self._dev)
 
 	def _handleInputStream(self, htPacketType: bytes, stream):
-		if htPacketType in (HT_PKT_OK, HT_PKT_EXTENDED):
+		if htPacketType in (HT_PKT_OK, HT_PKT_EXTENDED, HT_PKT_OK_WITH_LENGTH):
 			modelId: bytes = stream.read(1)
 			if not self._model:
 				if modelId not in MODELS:
 					log.debugWarning("Unknown model: %r" % modelId)
 					raise RuntimeError(
 						"The model with ID %r is not supported by this driver" % modelId)
 				self._model = MODELS.get(modelId)(self)
-				self.numCells = self._model.numCells
+				if htPacketType == HT_PKT_OK_WITH_LENGTH:
+					self.numCells = ord(stream.read(1))
+				else:
+					self.numCells = self._model.numCells
 			elif self._model.deviceId != modelId:
 				# Somehow the model ID of this display changed, probably another display
 				# plugged in the same (already open) serial port.
@@ -962,7 +1024,7 @@ def _handleInputStream(self, htPacketType: bytes, stream):
 				# Ignore ATC packets for now
 				pass
 			elif extPacketType == HT_EXTPKT_GET_PROTOCOL_PROPERTIES:
-				pass
+				self.numCells = packet[3]
 			elif isinstance(self._model, TimeSyncFirmnessMixin):
 				if extPacketType == HT_EXTPKT_GET_RTC:
 					self._model.handleTime(packet[1:])

user_docs/en/changes.md

@@ -21,6 +21,8 @@ Unicode CLDR has been updated.
   * This can be useful when reading characters that are unknown to a particular speech synthesizer or braille table and which have a compatible alternative, like the bold and italic characters commonly used on social media.
   * It also allows reading of equations in the Microsoft Word equation editor. (#4631)
   * You can enable this functionality for both speech and braille in their respective settings categories in the NVDA Settings dialog.
+* New Braille features:
+  * Added support for the Help Tech Activator Pro displays.
 
 ### Changes