add bluetooth support for seika notetaker #13191

feerrenrut · 2021-12-24T02:44:45Z

Link to issue number:

fixes #13142

Summary of the issue:

Seika Notetaker can not be autodetected via bluetooth

Description of how this pull request fixes the issue:

Add a way to identify the Seika device when connected by bluetooth

As per #13142 (comment) the bluetooth name for Seika devices should be TSM, a space, then 4 digits.

Testing strategy:

Ask Seika users to test when connected via bluetooth.

Known issues with pull request:

If ALL Seika devices use this bluetooth name, we may not be able to differentiate which driver to use seika vs seika notetaker.

Change log entries:

New features
- Seika Notetaker can now be auto-detected when connected via 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

moyanming · 2021-12-24T05:21:44Z

Hi, @feerrenrut
The Bluetooth name of the Seika is "TS5 abcd", where "abcd" is a four-digit number.
Seika: TS5, a space, and a four-digit number.
Seika Notetaker: TSM, a space, and a four-digit number.

I can test both Seika and Seika Notetaker Braille display.

Best Regards,

cary-rowen · 2022-01-04T08:12:45Z

@feerrenrut
I tested the build Version, and unfortunately, NVDA did not connect to my device via Bluetooth.
Shows an error dialog
The following is the log with HWIO enabled:
log_#13191.txt

cary-rowen · 2022-01-07T13:53:53Z

Hello, I tested the latest build version, NVDA seems to behave the same as last time, and it still cannot connect to Seika Notetaker via Bluetooth. Here is the log:

log.txt

AppVeyorBot · 2022-01-08T12:21:37Z

PASS: Translation comments check.
PASS: Unit tests.
FAIL: Lint check. See test results for more information.
PASS: System tests.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/2iv45u5mf95mv080/artifacts/output/nvda_snapshot_pr13191-24425,1f2f203e.exe

See test results for failed build of commit 1f2f203eea

cary-rowen · 2022-01-09T03:47:04Z

There is a short wait time when connecting, and the final result is that the connection fails.
log-01-09.txt

feerrenrut · 2022-01-09T06:27:19Z

@cary-rowen Thank you for testing and providing the log. I have had to guess about the issue here, could you please test both bluetooth and USB and provide a log for me?

With HID the first and third byte is discarded, for the serial connection the bytes coming through look like the standard command. In the log provided the following was received: \xff\xff\xa2\x0b\x16\x18\x18TSM V1.0. This looks like:

Command: \xff\xff\xa2 = SEIKA_INFO
argument length: x0b = 11
number of buttons: \x16 = 22
number of cells: \x18 = 24
number of routing keys: \x18 = 24
description: "TSM V1.0"

AppVeyorBot · 2022-01-09T06:38:46Z

PASS: Translation comments check.
FAIL: Unit tests. See test results for more information.
PASS: Lint check.
PASS: System tests.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/ty1n9ad9jr9927vv/artifacts/output/nvda_snapshot_pr13191-24426,82c1e231.exe

See test results for failed build of commit 82c1e231f7

cary-rowen · 2022-01-09T07:36:12Z

Hi @feerrenrut , the latest build has been able to successfully connect devices using bluetooth.
But there are multiple optional items in the "Port" combo box, one of which is 'friendlyName': '蓝牙链接上的标准串行 (COM4)'
NVDA freezes when this is checked and the "OK" button is pressed,
The corresponding entry in the log for this item is as follows:
{'hardwareID': 'BTHENUM\{00001101-0000-1000-8000-00805f9b34fb}_LOCALMFG&0000', 'port': 'COM4', 'bluetoothAddress': 0, 'friendlyName': '蓝牙链接上的标准串行 (COM4)'}

That is, there are a total of four items in the Port combo box:

Automatic
Bluetooth
Bluetooth Serial: COM3 (TSM 3366)
Serial: 蓝牙链接上的标准串行 (COM4)
The first three items can be successfully connected to Seika Notetaker, and the fourth item causes NVDA to freeze.

Grateful

moyanming · 2022-01-10T06:09:02Z

Hi @feerrenrut
The Seika Notetaker sending back the correct data means the connection is successfully now.
\xff\xff\xa2\x0b\x16\x18\x18TSM V1.0

BTW, both USB-HID and Bluetooth Serial COM port use the same data protocol.

moyanming · 2022-01-10T06:17:57Z

Hi @cary-rowen
There have two Bluetooth UUIDs, one for Tx and another for Rx, and this is why there are two Bluetooth Serial Com ports.
I think the Bluetooth Serail Com port which has "TSM abcd" is the right one for the communication.

feerrenrut · 2022-01-10T06:40:57Z

@moyanming can you test the latest PR build with bluetooth auto detection and report your findings. I believe this should be working, if so I'd like to merge this PR. Then we can raise a new issue and look at the listing of ports and see if we can prevent the wrong one from being listed.

cary-rowen · 2022-01-10T06:47:49Z

And, another question, in the case of a successful connection, the user re-selects the same port in the combo box and clicks the "OK" button, then what is our expected performance? Currently makes Seika Notetaker show nothing as if it's disconnected.

moyanming · 2022-01-10T09:22:07Z

@moyanming can you test the latest PR build with bluetooth auto detection and report your findings. I believe this should be working, if so I'd like to merge this PR. Then we can raise a new issue and look at the listing of ports and see if we can prevent the wrong one from being listed.

Hi, @feerrenrut
I have tested the PR build and used the USB and BT respectively, I also test the Automatic which is not select the specific Braille display.
The Port list of the Seika Notetatker is: Automatic, USB, Bluetooth, Serial (com1), Bluetooth Serial with TSM 2002, and Serial without TSM abcd.
The following log files all work fine:
BT_SeikaNotetaker_COM port with 'TSM abcd'_OK.log
USB_Automatic Braille display_OK.log
USB_SeikaNotetaker_Automatic_OK.log
USB_SeikaNotetaker_USB_OK.log
BT_Automatic Braille display_OK.log
BT_SeikaNotetaker_Automatic_OK.log
BT_SeikaNotetaker_Bluetooth_OK.log

I got a crash issue when selecting the Bluetooth Serial COM port without TSM abcd:
BT_SeikaNotetaker_COM port without 'TSM abcd' will crash.log

BTW, accidentally disconnecting the USB cable and then reconnecting the USB, the NVDA still can't connect automatically but needs to restart NVDA, #13143 , here is the log:
Accidentally disconnect-USB needs restart NVDA_issue.log

Elsewhere the bytes are in 'big' byte ordering

HID and Serial seem to require different approaches

Use the bluetoothName to filter manual ports, matching the same approach used by auto detection of the seika notetaker device. In order to prevent a circular import, the initialization of the detection data (and new import of seika notetaker module method was moved into a contained method.

Add tests for serial (bluetooth)

feerrenrut · 2022-01-15T15:35:06Z

Can you try the latest build
the Bluetooth Serial COM port without TSM abcd should no longer be listed.

cary-rowen · 2022-01-15T17:18:26Z

Hi, the build seems to introduce a regression,:
Launching this version of NVDA for the first time, but the Seaka device is not turned on, navigating to "Seika Notetaker" in the braille display combo box NVDA throws an error, the log is as follows:
Device not open, navigate in device selection combo box.txt
The Seaka device enters Bluetooth pairing mode, and then starts this version of NVDA. At this time, Seaka can successfully display content through "Auto Connect", but the device selection dialog cannot be opened:
Unable to open device selection dialog after connecting.txt

lukaszgo1 · 2022-01-15T18:32:20Z

source/brailleDisplayDrivers/seikantk.py


-	def __init__(self, port="hid"):
+	def __init__(self, port=bdDetect.KEY_HID):


While I'm not very familiar with NVDA's braille display drivers, this is the only one which specifies HID as the value for the port keyword argument in the constructor. For all others we either leave it with no default value in case of displays where port needs to be specified by the user, or for displays which can be auto-detected we assign "auto" to it. Could you add a comment here to explain why this driver is different?

The short answer is I was trying to avoid making changes if not necessary. Looking at this closer, it seems like it should never be "hid". I have tried to improve the docs and typing elsewhere. One confusing thing in the NVDA braille code is that "port" is used to refer to many different things, in different parts of the code it may be a COM port string, a string description of where to look (auto, usb, bluetooth), a HID device path string, or a DeviceMatch class instance.

There does not seem to be any situation where the port should be hid.

feerrenrut · 2022-01-18T07:10:36Z

@moyanming Is it possible to confirm how this command / gesture shows up in the input gestures dialog. I want to make sure this is consistent with other braille drivers.

moyanming · 2022-01-18T07:16:22Z

@moyanming I wrote this table based on the gestures in the seikantk driver. The d7 entry is this one: "kb:backspace": ("br(seikantk):d7",),. Other drivers use dot7 to to refer to dots. Can you confirm that dot7 can be used to backspace characters?

Hi @feerrenrut
For the code: there is a "_dotNames" that defined the d7 (means "dot7") and other dot keys, there should be changed everywhere if needed.
For the User guider: it is fine to use "dot7" to represent the dot 7 key of the Seika Notetaker.
Thanks!

feerrenrut · 2022-01-18T07:32:12Z

Looking at the other drivers, the hims, papenmeier, and brailleNote drivers use dx eg d7 as well. I'll update the user guide to refer to this as "dot 7"

For seika notetaker, userguide should refer to dot7 and dot8 not d7 and d8

cary-rowen · 2022-01-18T08:17:30Z

@moyanming

Hi, There are currently two options with the word "Seika" in the braille device selection combo box, we don't seem to have reflected their differences in the user guide, can you try to mention this in the user guide, or do we The options that can be in the combo box themselves reflect their range of support, sorry this may be off topic. If you want, we can contact privately, my email is:
manchen_0528@outlook.com

Thanks

feerrenrut · 2022-01-18T08:36:06Z

@cary-rowen can you get a screenshot of this, or set NVDA to English and copy the speech output from the speech viewer. I want to make sure I understand the request.

I think there will be one entry for "seika" and one for "seika notetaker"?

feerrenrut · 2022-01-18T08:41:36Z

Apologies, the last time I asked to check the user guide I linked to the changes file, I have corrected that link.

Can @cary-rowen and @moyanming please confirm the accuracy of the user guide:

moyanming · 2022-01-18T08:49:17Z

@moyanming

Hi, There are currently two options with the word "Seika" in the braille device selection combo box, we don't seem to have reflected their differences in the user guide, can you try to mention this in the user guide, or do we The options that can be in the combo box themselves reflect their range of support, sorry this may be off topic. If you want, we can contact privately, my email is: manchen_0528@outlook.com

Thanks

Hi @cary-rowen
For historical reasons, there is a Seika representing Seika v3/5/80 Braille display.
There is a new device type named Seika Notetaker Braille display published later and uses a different protocol compared to Seika Braille display.
We recommend using two different items for easy adding/modifying the driver.
BTW, you can select "Automatic" when connecting to Seika Notetaker now and this will work fine.

moyanming · 2022-01-18T08:51:47Z

Hi @feerrenrut
Yes, there are two entry items: "Seika" and "Seika Notetaker".

moyanming · 2022-01-18T09:05:15Z

Hi, @feerrenrut
There are sub-type of Seika Notetaker: 16 cells Seika Notetaker, 24 cells Seika Notetaker, and 40 cells Seika Notetaker. There is no need to install the driver when using Seika Notetaker because those devices use USB-HID.

So please change from:
15.11. Seika Braille Displays
The Seika Version 3, 4 and 5 (40 cells), Seika80 (80 cells), and Notetaker (16 cells) braille displays from Nippon Telesoft are supported. You can find more information about the displays and the required drivers at https://en.seika-braille.com/down/index.html You must first install the USB drivers provided by the manufacturer.

Should change to:
15.11. Seika Braille Displays
The Seika Version 3, 4, and 5 (40 cells), Seika80 (80 cells), and Notetaker (16, 24, 40 cells) braille displays from Nippon Telesoft are supported. You can find more information about the displays and the required drivers at https://en.seika-braille.com/down/index.html. You must first install the USB drivers when using Seika v3/4/5/80 provided by the manufacturer. There is no need to install the driver when using Seika Notetaker.

cary-rowen · 2022-01-18T09:10:33Z

@moyanming @feerrenrut
Ok, I see, but I understand that seika also has a V6Pro model in China, do you know about it? Is it possible to mention the device in the user guide as well?

Grateful

moyanming · 2022-01-18T09:27:46Z

@moyanming @feerrenrut Ok, I see, but I understand that seika also has a V6Pro model in China, do you know about it? Is it possible to mention the device in the user guide as well?

Grateful

Hi @cary-rowen
Seika V6Pro is kind of Seika Notetaker has 40 cells.
The Seika Notetaker device name may vary but those devices should use "Seika notetaker" or "Automatic" compare to Seika v3/4/5/80 devices.

feerrenrut · 2022-01-18T11:31:58Z

I have split the information for the two different drivers. @moyanming Can you review this?

installer
direct user guide html

moyanming · 2022-01-18T11:46:44Z

Hi @feerrenrut
That's great.

V6 and V6Pro are 40 cells Seika Notetaker, so please add V6 as well.
BTW, V6Pro has TTS voice supported but V6 hasn't.

So, please change:
15.11.2. MiniSeika (16, 24 cells), V6Pro (40 cells)
to:
15.11.2. MiniSeika (16, 24 cells), V6 and V6Pro (40 cells)

feerrenrut · 2022-01-18T13:31:02Z

@moyanming done. The build will complete shortly.

moyanming · 2022-10-12T08:42:21Z

As per #13142 (comment) the bluetooth name for Seika devices should be TSM, a space, then 4 digits.

Testing strategy:

Ask Seika users to test when connected via bluetooth.

Known issues with pull request:

If ALL Seika devices use this bluetooth name, we may not be able to differentiate which driver to use seika vs seika notetaker.

Hi @feerrenrut
Thanks for your great work and the "Seika Notetaker" already supported by Bluetooth connection.

But the "Seika"( means "Seika v3/v5/v80") still can't connect with NVDA by using Bluetooth COM port, which is no the same type as "Seika Notetaker".
The Seika uses Bluetooth name: "TS5 abcd", but Seika Notetaker uses: "TSM abcd", where "abcd" are four digital numbers.
Do I add a new Issue about this?

Best Regards

cary-rowen · 2022-10-12T09:59:27Z

@moyanming
Can you create a new question for this? NVAccess cannot triage closed issues.
Also, I would like to get in touch with you privately, my email is manchen 0528@outlook.com

moyanming · 2022-10-12T11:28:07Z

Hi @cary-rowen
I have report an issue #14242 and send to your email manchen_0528@outlook.com and please check you Inbox.

feerrenrut mentioned this pull request Dec 24, 2021

Add Bluetooth COM Port function for Seika and Seika Notetaker Braille display #13142

Closed

This comment has been minimized.

Sign in to view

feerrenrut added 10 commits January 15, 2022 14:03

add bluetooth support for seika notetaker

2cbabb4

attempt to connect to seikantk using serial over bluetooth

0437b17

fix error in seika driver

00f13d3

byte ordering isn't required for a single byte

57022a8

Elsewhere the bytes are in 'big' byte ordering

fix lint check

2999c74

fix portType vs match.port mixup

aa9c705

fix lint

8af30c3

split command collection approaches

869e075

HID and Serial seem to require different approaches

fix seikantk tests

e544667

Add tests for serial (bluetooth)

feerrenrut force-pushed the addBluetoothAutoDetect-seikaNotetaker branch from 0627c24 to e544667 Compare January 15, 2022 06:28

lukaszgo1 reviewed Jan 15, 2022

View reviewed changes

seikantk init remove default val for port

9320836

There does not seem to be any situation where the port should be hid.

use dot not d

13641b2

For seika notetaker, userguide should refer to dot7 and dot8 not d7 and d8

update seika user docs

331a539

Include V6 seika device

1e7a3a1

seanbudd approved these changes Jan 19, 2022

View reviewed changes

feerrenrut added 2 commits January 19, 2022 18:47

Update changes file for PR #13191

09d5297

fix changes doc

ce5e439

feerrenrut merged commit b45926c into master Jan 19, 2022

feerrenrut deleted the addBluetoothAutoDetect-seikaNotetaker branch January 19, 2022 10:56

nvaccessAuto added this to the 2022.1 milestone Jan 19, 2022

cary-rowen mentioned this pull request May 10, 2022

Revert configuration gives error #13679

Closed

This was referenced Jul 4, 2022

Regarding Seika mini braille support #5755

Closed

Accidentally disconnect USB cabled Seika Notetaker Braille display and reconnect needs restart NVDA #13143

Open

moyanming mentioned this pull request Oct 12, 2022

Add Bluetooth COM Port supports for Seika v3/v5/v80 Braille display #14242

Open


		def __init__(self, port="hid"):
		def __init__(self, port=bdDetect.KEY_HID):

add bluetooth support for seika notetaker #13191

add bluetooth support for seika notetaker #13191

Conversation

feerrenrut commented Dec 24, 2021 • edited Loading

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

moyanming commented Dec 24, 2021

cary-rowen commented Jan 4, 2022

This comment has been minimized.

cary-rowen commented Jan 7, 2022

AppVeyorBot commented Jan 8, 2022

cary-rowen commented Jan 9, 2022

feerrenrut commented Jan 9, 2022

AppVeyorBot commented Jan 9, 2022

cary-rowen commented Jan 9, 2022

moyanming commented Jan 10, 2022

moyanming commented Jan 10, 2022

feerrenrut commented Jan 10, 2022

cary-rowen commented Jan 10, 2022

moyanming commented Jan 10, 2022 • edited Loading

feerrenrut commented Jan 15, 2022

cary-rowen commented Jan 15, 2022

lukaszgo1 Jan 15, 2022 • edited Loading

Choose a reason for hiding this comment

feerrenrut Jan 16, 2022

Choose a reason for hiding this comment

feerrenrut commented Jan 18, 2022

moyanming commented Jan 18, 2022

feerrenrut commented Jan 18, 2022

cary-rowen commented Jan 18, 2022

feerrenrut commented Jan 18, 2022

feerrenrut commented Jan 18, 2022

moyanming commented Jan 18, 2022

moyanming commented Jan 18, 2022

moyanming commented Jan 18, 2022

cary-rowen commented Jan 18, 2022

moyanming commented Jan 18, 2022

feerrenrut commented Jan 18, 2022

moyanming commented Jan 18, 2022

feerrenrut commented Jan 18, 2022

moyanming commented Oct 12, 2022

Testing strategy:

Known issues with pull request:

cary-rowen commented Oct 12, 2022

moyanming commented Oct 12, 2022

feerrenrut commented Dec 24, 2021 •

edited

Loading

moyanming commented Jan 10, 2022 •

edited

Loading

lukaszgo1 Jan 15, 2022 •

edited

Loading