Support multi-line braille displays in HidBrailleDriver by alexmoon · Pull Request #17001 · nvaccess/nvda

alexmoon · 2024-08-13T16:18:53Z

Link to issue number:

Summary of the issue:

Multi-line braille displays using the HID standard driver only support the first line of cells.

Description of user facing changes

Users with multi-line braille displays that connect using the HidBrailleDriver will now be able to use all cells of their display.

Description of development approach

HidBrailleDriver._cellValueCaps is now a list of all braille cell controls in the device. numRows is set to the length of that list and numCols is set to the ReportCount of each element of the list. In display, the cells are split across the elements of _cellValueCaps.

Testing strategy:

Tested against Tactile Engineering's Cadence tablet. Manual testing only due to required hardware interactions.

Known issues with pull request:

Multi-line braille displays with an irregular shape (i.e. not all braille rows are the same length) are not supported. I'm not aware of any actual hardware that would be affected by this.
Multi-line braille displays will ignore "Number of Braille Cells" controls. This is because those controls will operate per-row and in general will give the usable display area an irregular shape. I'm not aware of any multi-line HID standard braille displays that use the "Number of Braille Cells" control.

Code Review Checklist:

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

Summary by CodeRabbit

New Features
- Enhanced functionality for multi-line braille displays, allowing full utilization of display lines with the Standard HID braille driver.
- Improved accessibility for users relying on braille output.
Improvements
- Respect for command line options during updates.
- Updated eSpeak NG library to support additional languages.
Bug Fixes
- Enhanced detection and management of connected braille display devices for better performance.

coderabbitai · 2024-08-13T16:19:02Z

Walkthrough

The recent updates enhance the NVDA screen reader's support for multi-line braille displays, allowing full utilization of braille cells across multiple rows. Key changes include a refined detection and management system for braille display capabilities, improving accessibility. The driver now supports various device configurations, enhancing both functionality and logging for diagnostics.

Changes

Files	Change Summary
`source/brailleDisplayDrivers/hidBrailleStandard.py`	Updated initialization of display properties, enhanced device detection logic, and refactored methods for better handling of multi-line displays.

Assessment against linked issues

Objective	Addressed	Explanation
Support multi-line braille displays (#16993)	✅
Detect all braille row capabilities	✅
Set numRows/numCols appropriately	✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

AppVeyorBot · 2024-08-13T16:53:15Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: Lint check. See test results and lint artifacts for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/nfr9kd7fb9wqpq9p/artifacts/output/nvda_snapshot_pr17001-33351,4ed175a8.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 12.2,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.3,
FINISH_END 0.2

See test results for failed build of commit 4ed175a856

seanbudd

Thanks @alexmoon for breaking the ice for support for multi-line braille!

Just some minor suggestions

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

AppVeyorBot · 2024-08-14T01:39:19Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: Lint check. See test results and lint artifacts for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/u94o9nmut0qa7uy2/artifacts/output/nvda_snapshot_pr17001-33357,b6326d35.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 11.9,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.2,
FINISH_END 0.2

See test results for failed build of commit b6326d3508

LeonarddeR · 2024-08-14T07:21:40Z

Cc @bramd as you have some experience with multiline displays.

seanbudd

Approved, pending @michaelDCurran's thoughts

AppVeyorBot · 2024-08-15T16:53:17Z

Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit 94f064cc92

michaelDCurran

The display method is much easier to follow now, thanks.

Support multi-line braille displays in HidBrailleDriver

425e2e9

alexmoon requested a review from a team as a code owner August 13, 2024 16:18

alexmoon requested a review from SaschaCowley August 13, 2024 16:18

coderabbitai Bot reviewed Aug 13, 2024

View reviewed changes

Comment thread source/brailleDisplayDrivers/hidBrailleStandard.py

Fix CI

cda119a

seanbudd requested changes Aug 13, 2024

View reviewed changes

alexmoon and others added 2 commits August 13, 2024 21:03

Apply suggestions from code review

7449a35

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

log.warn -> log.warning

9c79139

seanbudd reviewed Aug 14, 2024

View reviewed changes

Comment thread source/brailleDisplayDrivers/hidBrailleStandard.py Outdated

Comment thread source/brailleDisplayDrivers/hidBrailleStandard.py Outdated

Changes suggested by code review

08b231c

michaelDCurran requested changes Aug 14, 2024

View reviewed changes

Comment thread source/brailleDisplayDrivers/hidBrailleStandard.py

seanbudd approved these changes Aug 14, 2024

View reviewed changes

michaelDCurran approved these changes Aug 15, 2024

View reviewed changes

Rewrite HidBrailleDriver.display for clarity

f692a23

michaelDCurran approved these changes Aug 15, 2024

View reviewed changes

seanbudd approved these changes Aug 15, 2024

View reviewed changes

seanbudd merged commit 83b2e0a into nvaccess:master Aug 15, 2024

seanbudd deleted the multiline-hid branch August 15, 2024 23:55

github-actions Bot added this to the 2024.4 milestone Aug 15, 2024

Uh oh!

Conversation

alexmoon commented Aug 13, 2024 • edited by coderabbitai Bot 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:

Code Review Checklist:

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AppVeyorBot commented Aug 13, 2024

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AppVeyorBot commented Aug 14, 2024

Uh oh!

LeonarddeR commented Aug 14, 2024

Uh oh!

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

AppVeyorBot commented Aug 15, 2024

Uh oh!

michaelDCurran left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

alexmoon commented Aug 13, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 13, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)