Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support BrailleHID protocol to BrailleEdge device #16279

Merged
merged 21 commits into from
Mar 15, 2024

Conversation

EdKweon
Copy link
Contributor

@EdKweon EdKweon commented Mar 8, 2024

Link to issue number:

Summary of the issue:

Add support BrailleHID protocol to BrailleEdge device

Description of user facing changes

User can use BrailleEdge device using BrailleHID protocol. NVDA keys remain unchanged.

Description of development approach

Five new keys have been added. On the front edge, starting from the left, there is the leftCursor key, in the center there is the home key, and on the far right there is the rightCursor key. On the top surface, there are control and alt keys on both sides of the spacebar. Additional gesture key mappings can be added to the gesture map based on user demand.

Testing strategy:

Unit test, Lint test, System test.

Known issues with pull request:

No.

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.

@EdKweon EdKweon requested a review from a team as a code owner March 8, 2024 08:58
@EdKweon
Copy link
Contributor Author

EdKweon commented Mar 8, 2024

NVDA gesture and key remain unchanged. There are no updated in userGuide.
Thanks!

@AppVeyorBot
Copy link

See test results for failed build of commit 3377ac025c

Copy link
Collaborator

@LeonarddeR LeonarddeR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this is a custom HID protocol, i.e. not the generic protocol as used by the hidBrailleStandard driver?

source/brailleDisplayDrivers/hims.py Outdated Show resolved Hide resolved
EdKweon and others added 2 commits March 11, 2024 09:08
Co-authored-by: Leonard de Ruijter <3049216+LeonarddeR@users.noreply.github.com>
@EdKweon
Copy link
Contributor Author

EdKweon commented Mar 11, 2024

@LeonarddeR

I assume this is a custom HID protocol, i.e. not the generic protocol as used by the hidBrailleStandard driver?

We use hidBrailleStandard driver in device. Is there any reason you think so?

@AppVeyorBot
Copy link

See test results for failed build of commit 2eae9a19cf

@LeonarddeR
Copy link
Collaborator

We use hidBrailleStandard driver in device.

In that case, what is the point of changing the hims driver?

@EdKweon
Copy link
Contributor Author

EdKweon commented Mar 11, 2024

We use hidBrailleStandard driver in device.

In that case, what is the point of changing the hims driver?

The intention is to support HID rather than to change it. There are users who want HID support. Our device driver testing has been completed on iPhones and MacBooks, so validation for the current device driver is complete.
If I have misunderstood or provided a different response, please let me know, and I would appreciate the opportunity to correct it. Thank you.

source/brailleDisplayDrivers/hims.py Outdated Show resolved Hide resolved
source/brailleDisplayDrivers/hims.py Outdated Show resolved Hide resolved
source/brailleDisplayDrivers/hims.py Outdated Show resolved Hide resolved
user_docs/en/changes.t2t Outdated Show resolved Hide resolved
@seanbudd seanbudd marked this pull request as draft March 14, 2024 04:53
EdKweon and others added 2 commits March 14, 2024 14:57
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
EdKweon and others added 2 commits March 14, 2024 15:00
@EdKweon EdKweon marked this pull request as ready for review March 14, 2024 06:05
user_docs/en/changes.t2t Outdated Show resolved Hide resolved
@seanbudd seanbudd merged commit 722f810 into nvaccess:master Mar 15, 2024
1 check was pending
@nvaccessAuto nvaccessAuto added this to the 2024.2 milestone Mar 15, 2024
@EdKweon EdKweon deleted the Add_BrailleHID_to_BrailleEdge branch March 15, 2024 03:45
@EdKweon EdKweon restored the Add_BrailleHID_to_BrailleEdge branch March 15, 2024 04:08
EdKweon added a commit to EdKweon/nvda that referenced this pull request Mar 15, 2024
@EdKweon EdKweon deleted the Add_BrailleHID_to_BrailleEdge branch March 15, 2024 04:23
@EdKweon
Copy link
Contributor Author

EdKweon commented Mar 15, 2024

@seanbudd
I'm really sorry for not check about error before merge. There are error in class with non defined class member variable. I made a another pull reqeust about this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants