search

SuperFlyTV / xkeys

A Node.js module to interact with the X-keys panels.
MIT License
33 stars 12 forks source link

[question] Why are WebHID calls to `sendReport` queued with concurrency 1? #111

Open loucadufault opened 2 days ago

loucadufault commented 2 days ago

I am looking to perform multiple writes to the device in a synchronous manner. The current wrapper method implementation sequentially queues the sendReport promises:

https://github.com/SuperFlyTV/xkeys/blob/e9d925e22d184775e252c1991a1105bfedc14311/packages/webhid/src/web-hid-wrapper.ts#L24-L32

Is there a reason this is done? Wondering if there were any observed issues or concerns with firing for example a few dozens sendReport calls without waiting for any of them to resolve (before firing off the next one).

The context is I am looking to perform some cleanup of the device on beforeunload, which must be sync.

nytamin commented 2 days ago

Honestly, I don't quite remember why I wrapped it in a promise queue. Perhaps one could do a synthetic test and send multiple commands and see what happens?

However, if you're looking to send something in a synchronous manner, I don't think you'll be able to do that anyway, since the webhidDevice.sendReport() is asynchronous in itself, so you'll have no way of knowing if the commands have actually been sent, right?

Julusian commented 3 hours ago

I think this is a little related to https://github.com/SuperFlyTV/xkeys/issues/106

I suspect what happened is this code was based on the streamdeck library, which uses a queue because it sends messages in multiple packets that need to not be interleaved with other calls to write https://github.com/Julusian/node-elgato-stream-deck/blob/6240d8853272a4f651b835f332ef14f77c512ee5/packages/webhid/src/hid-device.ts#L45-L51 (Added in commit fix: ensure order of hid.sendReport calls when image is multiple packets. concurrent draws previously would result in some corruption)

For the xkeys where the writes are only ever a single hid packet, it does look unnecessary

michaelhatPIengineering commented 1 hour ago

The simple commands for setting LEDs and such are only a single packet. However, there are cases when sending multiple packet writes are required with X-keys. Since we support the generic "write data" command we can use web hid for maintenance of X-keys firmware for example. These operation would require multiple writes in the proper order.