Add support for custom providers for braille display auto detection by LeonarddeR · Pull Request #14531 · nvaccess/nvda

LeonarddeR · 2023-01-11T20:46:18Z

Link to issue number:

Summary of the issue:

Currently, USB and Bluetooth devices are supported for braille display detection. Other devices using other protocols or software devices aren't supported. This pr intends to add support for this.

Description of user facing changes

Noone. User shouldn't experience anything different for now.

Description of development approach

Added Chain, a new extension point type that allows to register handlers that return iterables (mainly generators). Calling iter on the Chain returns a generator that iterates over all the handlers.
The braille display detector now relies on a new Chain. By default, functions are registered to the chain that yield usb and bluetooth devices. A custom provider can yield own driver names and device matches that are supported by that particular driver. A potential use case would be implementing automatic detection for displays using BRLTTY, for example. It will also be used to fix Braille does not work on secure Windows screens while normal copy of NVDA is running #2315 (see below)
Added a moveToEnd method on HandlerRegistrar, which allows changing the order of registered handlers. This allows add-ons to give priority to their handlers, which is especially helpful for both Chain and Filter. NVDA Remote should come for the braille viewer, otherwise controlling a system with braille viewer on with a 80 cell display connected to the controller would lower the display size to 40 unnecessarily. This will also be used to register a custom handler to bdDetect.scanForDevices to support auto detection of the user display on the secure screen instance of NVDA, which should come before USB and Bluetooth.
As a bonus, added type hints to extension points. For Filters and Chains, you could provide the value type and then a type checker can check validity.
As another bonus, all features are covered by new tests. So there are tests for the Chain extension point and for the specific use case in bdDetect

Testing strategy:

As this touches braille display auto detection quite a lot, probably merge this early in the 2023.2 cycle.

Known issues with pull request:

bdDetect.Detector does no longer take constructor parameters, rather queueBgScan should be called explicitly. This is because if we queue a scan in the constructor of Detector, the detector could switch to a display and disable detection before the _detector was set on the braille handler. Ideally we should use a lock as well, but that might be something as a follow up for both this pr and #14524. Note that though we're changing the constructor of a public class in bdDetect, the doc string of the class explicitly states that the Detector class should be used by the braille module only. That should be enough warning for users not to use this class and therefore I don't consider this API breaking.

Change log entries:

For Developers

Added a new extension point type called Chain, which can be used to iterate over iterables returned by registered handlers.
Added the bdDetect.scanForDevices extension point. Handlers can be registered that yield BrailleDisplayDriver/DeviceMatch pairs that don't fit in existing categories, like USB or Bluetooth.

Code Review Checklist:

Pull Request description:
- description is up to date
- change log entries
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
API is compatible with existing add-ons.
Documentation:
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
Security precautions taken.

AppVeyorBot · 2023-01-11T21:31:41Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/djkfnqb95vgfbb10/artifacts/output/nvda_snapshot_pr14531-27495,f748e46b.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 23.0,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 20.0,
FINISH_END 0.1

See test results for failed build of commit f748e46ba0

AppVeyorBot · 2023-01-12T07:24:44Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/oc31b3yfua4npxld/artifacts/output/nvda_snapshot_pr14531-27500,52662b1e.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 22.7,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 20.3,
FINISH_END 0.1

See test results for failed build of commit 52662b1e0c

LeonarddeR · 2023-01-12T07:28:14Z

I'm pretty sure all these tests failures are unrelated.

AppVeyorBot · 2023-01-12T08:23:38Z

PASS: Translation comments check.
PASS: Unit tests.
FAIL: Lint check. See test results for more information.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/rrfo82tuqsnjx27c/artifacts/output/nvda_snapshot_pr14531-27501,7a36ab51.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 22.5,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 22.3,
FINISH_END 0.1

See test results for failed build of commit 7a36ab513c

seanbudd · 2023-01-16T03:44:13Z

-		self._handlers = collections.OrderedDict()
+		self._handlers = OrderedDict[
+			HandlerKeyT,
+			Union[BoundMethodWeakref[HandlerT], AnnotatableWeakref[HandlerT]]


this type also might be worth turning into a named variable, as it is used repeatedly

Same issue as abbove, nesting TypeVars in variables doesn't seem to be respected by PyRight.

seanbudd · 2023-02-13T23:28:55Z

@LeonarddeR can you address merge conflicts now that #14524 is merged

LeonarddeR · 2023-02-14T06:26:46Z

@LeonarddeR can you address merge conflicts now that #14524 is merged

Done.

AppVeyorBot · 2023-02-14T07:14:30Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/2280awctno7fn7x4/artifacts/output/nvda_snapshot_pr14531-27695,35813eaf.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 23.2,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 23.0,
FINISH_END 0.2

See test results for failed build of commit 35813eaf81

into bdDetectCustomYield

Fix for #14531 Summary of the issue: Error 'property' object is not iterable when enabling autodetect for the first time with Bluetooth on. Description of user facing changes None Description of development approach The detector was trying to save the bdDefsCache on the _DeviceInfoFfetcher class (not the instance).

As part of Pull request #14531, I ordered display order in bdDetect alphabetically. However, it seems that querying Albatross first has a major negative impact on detecting other displays using the same Serial to USB converter (see Pull request #13045) Description of user facing changes Handy Tech displays such as the Modular Evolution instantly auto detect again. Description of development approach Restored the order, Albatross is last in the dictionary again. I'm pretty unhappy with how these displays work, but it looks like it's a design thing in the displays itself.

LeonarddeR and others added 9 commits January 10, 2023 07:25

Save me

f2bbe8b

Add Chain

580f116

Rwrite bdDetect

34bff44

Use extension points

09b082d

Add tests

3a6e19a

Type hints

15f7486

Typing

0e7b09f

bdDetect

fc3d7f0

Last changes

b798c88

LeonarddeR added 2 commits January 12, 2023 07:38

Add forgotten bdDetect test

83574be

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

5654d16

LeonarddeR marked this pull request as ready for review January 12, 2023 07:26

LeonarddeR requested a review from a team as a code owner January 12, 2023 07:26

LeonarddeR requested a review from seanbudd January 12, 2023 07:26

LeonarddeR added the merge-early Merge Early in a developer cycle label Jan 12, 2023

Rename kwargs of private API

c64d24c

CyrilleB79 mentioned this pull request Jan 12, 2023

System tests regularly fail #14533

Closed

Lint

547b185

seanbudd self-assigned this Jan 12, 2023

seanbudd added this to the 2023.2 milestone Jan 13, 2023

seanbudd reviewed Jan 16, 2023

View reviewed changes

Comment thread source/extensionPoints/__init__.py Outdated

seanbudd reviewed Jan 16, 2023

View reviewed changes

Comment thread source/extensionPoints/__init__.py Outdated

seanbudd reviewed Jan 16, 2023

View reviewed changes

LeonarddeR commented Jan 16, 2023

View reviewed changes

Comment thread source/bdDetect.py Outdated

LeonarddeR commented Jan 16, 2023

View reviewed changes

Comment thread source/bdDetect.py Outdated

LeonarddeR commented Jan 16, 2023

View reviewed changes

Comment thread source/bdDetect.py Outdated

LeonarddeR added 3 commits January 16, 2023 19:06

Review actions

5881915

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

e0911b0

Ensure handlers are called by adding a _called kwarg

dec0073

LeonarddeR marked this pull request as ready for review January 17, 2023 15:52

LeonarddeR requested a review from seanbudd January 17, 2023 15:52

seanbudd reviewed Jan 18, 2023

View reviewed changes

Comment thread source/bdDetect.py

Comment thread source/bdDetect.py Outdated

Comment thread source/bdDetect.py Outdated

Comment thread source/bdDetect.py Outdated

LeonarddeR added 2 commits January 18, 2023 07:55

Review actions

9348709

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

6927751

seanbudd approved these changes Jan 18, 2023

View reviewed changes

seanbudd added the blocked label Jan 18, 2023

LeonarddeR added 2 commits January 25, 2023 19:18

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

9d637d6

Lint

0ea06d0

seanbudd removed the blocked label Feb 13, 2023

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

9eb5374

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

75d273a

seanbudd added 3 commits February 14, 2023 15:53

Merge branch 'bdDetectCustomYield' of https://github.com/leonardder/nvda

5662ab2

into bdDetectCustomYield

Merge remote-tracking branch 'origin/master' into bdDetectCustomYield

a47510c

update changes

ef11930

seanbudd merged commit 58a66fb into nvaccess:master Feb 14, 2023

LeonarddeR mentioned this pull request Feb 15, 2023

Braille does not work on secure Windows screens while normal copy of NVDA is running #2315

Closed

LeonarddeR added a commit to LeonarddeR/nvda that referenced this pull request Feb 16, 2023

Fixup nvaccess#14531: TypeError: 'property' object is not iterable

d5d62a4

LeonarddeR mentioned this pull request Feb 16, 2023

Fixup #14531: TypeError: 'property' object is not iterable #14642

Merged

6 tasks

lukaszgo1 mentioned this pull request Feb 25, 2023

NVDA plays error sound when switching windows in alpha when braille is set to automatic #14673

Closed

LeonarddeR mentioned this pull request Mar 1, 2023

Fixup #14531: Make Albatross again the last driver in detection order #14686

Merged

6 tasks

LeonarddeR deleted the bdDetectCustomYield branch August 23, 2025 06:27

Uh oh!

Conversation

LeonarddeR commented Jan 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Jan 11, 2023

Uh oh!

AppVeyorBot commented Jan 12, 2023

Uh oh!

LeonarddeR commented Jan 12, 2023

Uh oh!

AppVeyorBot commented Jan 12, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seanbudd Jan 16, 2023

Choose a reason for hiding this comment

Uh oh!

LeonarddeR Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seanbudd commented Feb 13, 2023

Uh oh!

LeonarddeR commented Feb 14, 2023

Uh oh!

AppVeyorBot commented Feb 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LeonarddeR commented Jan 11, 2023 •

edited

Loading