Native driver for Freedom Scientific displays

source/bdDetect.py

@@ -163,7 +163,7 @@ class Detector(object):
 	This should only be used by the L{braille} module.
 	"""
 
-	def __init__(self):
+	def __init__(self, usb=True, bluetooth=True, limitToDevices=None):
 		self._BgScanApc = winKernel.PAPCFUNC(self._bgScan)
 		self._btDevsLock = threading.Lock()
 		self._btDevs = None
@@ -172,11 +172,12 @@ def __init__(self):
 		self._stopEvent = threading.Event()
 		self._queuedScanLock = threading.Lock()
 		self._scanQueued = False
-		self._detectUsb = False
-		self._detectBluetooth = False
+		self._detectUsb = usb
+		self._detectBluetooth = bluetooth
+		self._limitToDevices = limitToDevices
 		self._runningApcLock = threading.Lock()
 		# Perform initial scan.
-		self._startBgScan(usb=True, bluetooth=True)
+		self._startBgScan(usb=usb, bluetooth=bluetooth, limitToDevices=limitToDevices)
 
 	@property
 	def _scanQueuedSafe(self):
@@ -190,10 +191,11 @@ def _scanQueuedSafe(self, state):
 		with self._queuedScanLock:
 			self._scanQueued = state
 
-	def _startBgScan(self, usb=False, bluetooth=False):
+	def _startBgScan(self, usb=False, bluetooth=False, limitToDevices=None):
 		with self._queuedScanLock:
 			self._detectUsb = usb
 			self._detectBluetooth = bluetooth
+			self._limitToDevices = limitToDevices
 			if not self._scanQueued:
 				self._scanQueued = True
 				if self._runningApcLock.locked():
@@ -224,11 +226,12 @@ def _bgScan(self, param):
 					self._scanQueued = False
 					detectUsb = self._detectUsb
 					detectBluetooth = self._detectBluetooth
+					limitToDevices = self._limitToDevices
 				if detectUsb:
 					if self._stopEvent.isSet():
 						continue
 					for driver, match in getDriversForConnectedUsbDevices():
-						if self._stopEvent.isSet():
+						if self._stopEvent.isSet() or (self._limitToDevices and driver not in self._limitToDevices):
 							continue
 						if braille.handler.setDisplayByName(driver, detected=match):
 							return
@@ -244,7 +247,7 @@ def _bgScan(self, param):
 							btDevs = self._btDevs
 							btDevsCache = btDevs
 					for driver, match in btDevs:
-						if self._stopEvent.isSet():
+						if self._stopEvent.isSet() or (self._limitToDevices and driver not in self._limitToDevices):
 							continue
 						if btDevsCache is not btDevs:
 							btDevsCache.append((driver, match))
@@ -256,25 +259,28 @@ def _bgScan(self, param):
 						with self._btDevsLock:
 							self._btDevs = btDevsCache
 
-	def rescan(self):
+	def rescan(self, usb=True, bluetooth=True, limitToDevices=None):
 		"""Stop a current scan when in progress, and start scanning from scratch."""
 		self._stopBgScan()
 		with self._btDevsLock:
 			# A Bluetooth com port or HID device might have been added.
 			self._btDevs = None
-		self._startBgScan(usb=True, bluetooth=True)
+		self._startBgScan(usb=usb, bluetooth=bluetooth, limitToDevices=limitToDevices)
 
 	def handleWindowMessage(self, msg=None, wParam=None):
 		if msg == WM_DEVICECHANGE and wParam == DBT_DEVNODES_CHANGED:
-			self.rescan()
+			self.rescan(bluetooth=self._detectBluetooth, limitToDevices=self._limitToDevices)
 
 	def pollBluetoothDevices(self):
 		"""Poll bluetooth devices that might be in range.
 		This does not cancel the current scan."""
+		if not self._detectBluetooth:
+			# Do not poll bluetooth devices at all when bluetooth is disabled.
+			return
 		with self._btDevsLock:
 			if not self._btDevs:
 				return
-		self._startBgScan(bluetooth=True)
+		self._startBgScan(bluetooth=self._detectBluetooth, limitToDevices=self._limitToDevices)
 
 	def terminate(self):
 		appModuleHandler.post_appSwitch.unregister(self.pollBluetoothDevices)
@@ -466,6 +472,20 @@ def driverSupportsAutoDetection(driver):
 
 addBluetoothDevices("eurobraille", lambda m: m.id.startswith("Esys"))
 
+# freedomScientific
+addUsbDevices("freedomScientific", KEY_CUSTOM, {
+	"VID_0F4E&PID_0100", # Focus 1
+	"VID_0F4E&PID_0111", # PAC Mate
+	"VID_0F4E&PID_0112", # Focus 2
+	"VID_0F4E&PID_0114", # Focus Blue
+})
+
+addBluetoothDevices("freedomScientific", lambda m: any(m.id.startswith(prefix) for prefix in (
+	"F14", "Focus 14 BT",
+	"Focus 40 BT",
+	"Focus 80 BT",
+)))
+
 # handyTech
 addUsbDevices("handyTech", KEY_SERIAL, {
 	"VID_0403&PID_6001", # FTDI chip

source/braille.py

@@ -1669,8 +1669,11 @@ def setDisplayByName(self, name, isFallback=False, detected=None):
 				self.display = newDisplay
 			self.displaySize = newDisplay.numCells
 			self.enabled = bool(self.displaySize)
-			if isFallback:
-				self._resumeDetection()
+			if isFallback and self._detectionEnabled:
+				# As this is the fallback display, which is usually noBraille,
+				# we can keep the current display when enabling detection.
+				# Note that in this case, L{_detectionEnabled} is set by L{handleDisplayUnavailable}
+				self.__enableDetection(keepCurrentDisplay=True)
 			elif not detected:
 				config.conf["braille"]["display"] = name
 			else: # detected:
@@ -1684,6 +1687,8 @@ def setDisplayByName(self, name, isFallback=False, detected=None):
 				# We should handle this more gracefully, since this is no reason
 				# to stop a display from loading successfully.
 				log.debugWarning("Error in initial display after display load", exc_info=True)
+			if detected and 'bluetoothName' in detected.deviceInfo:
+				self._enableDetection(bluetooth=False, keepCurrentDisplay=True, limitToDevices=[name])
 			return True
 		except:
 			# For auto display detection, logging an error for every failure is too obnoxious.
@@ -1990,18 +1995,20 @@ def handleDisplayUnavailable(self):
 		log.error("Braille display unavailable. Disabling", exc_info=True)
 		self._detectionEnabled = config.conf["braille"]["display"] == AUTO_DISPLAY_NAME
 		self.setDisplayByName("noBraille", isFallback=True)
-
-	def _enableDetection(self):
+
+	def _enableDetection(self, usb=True, bluetooth=True, keepCurrentDisplay=False, limitToDevices=None):
 		"""Enables automatic detection of braille displays.
 		When auto detection is already active, this will force a rescan for devices.
+		This should also be executed when auto detection should be resumed due to loss of display connectivity.
 		"""
 		if self._detectionEnabled and self._detector:
-			self._detector.rescan()
+			self._detector.rescan(usb=usb, bluetooth=bluetooth, limitToDevices=limitToDevices)
 			return
 		_BgThread.start()
-		config.conf["braille"]["display"] = AUTO_DISPLAY_NAME
-		self.setDisplayByName("noBraille", isFallback=True)
-		self._detector = bdDetect.Detector()
+		if not keepCurrentDisplay:
+			config.conf["braille"]["display"] = AUTO_DISPLAY_NAME
+			self.setDisplayByName("noBraille", isFallback=True)
+		self._detector = bdDetect.Detector(usb=usb, bluetooth=bluetooth, limitToDevices=limitToDevices)
 		self._detectionEnabled = True
 
 	def _disableDetection(self):
@@ -2013,14 +2020,6 @@ def _disableDetection(self):
 			self._detector = None
 		self._detectionEnabled = False
 
-	def _resumeDetection(self):
-		"""Resumes automatic detection of braille displays.
-		This is executed when auto detection should be resumed due to loss of display connectivity.
-		"""
-		if not self._detectionEnabled or self._detector:
-			return
-		self._detector = bdDetect.Detector()
-
 class _BgThread:
 	"""A singleton background thread used for background writes and raw braille display I/O.
 	"""