Add support for WebUSB #7778

drashna · 2020-01-03T22:11:32Z

Description

This adds the WebUSB feature to QMK Firmware (for LUFA and ChibiOS, at least).

This requires qmk/lufa#8 to be merged (or to use the web_usb)

Types of Changes

Core
New feature
Documentation

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

yulei · 2020-01-04T12:06:55Z

great, this made online qmk configurator possible :)

drashna · 2020-01-05T08:14:24Z

@yulei ZSA (ergodox ez, planck ez) are already using WebUSB for the "live training" feature. In fact, this is basically just backporting that code.

yulei · 2020-01-10T05:01:47Z

@yulei ZSA (ergodox ez, planck ez) are already using WebUSB for the "live training" feature. In fact, this is basically just backporting that code.

Could this webusb implementation work under mac? I tested an implementation from the LUFA pr before, but they failed work under MAC OS.

drashna · 2020-01-11T22:15:07Z

Works on MacOS, Windows, and Linux. including the "open link" popup. But it does require Chrome or a chrome based browser.

keyboards/ergodox_ez/config.h

wiserfirst · 2020-05-15T04:54:47Z

@drashna @noroadsleft Just wondering if we plan to merge this in? Thanks!

noroadsleft · 2020-05-15T11:40:46Z

@wiserfirst My understanding is that ZSA (makers of the ErgoDox EZ and Planck EZ) is still working on this, hence this PR being in Draft status.

I would expect this to be merged when the underlying pieces are in place. So basically: "When it's done."

drashna · 2020-05-16T00:05:09Z

Just wondering if we plan to merge this in? Thanks!

It's complicated.

This PR requires a change to the LUFA module first. Which hasn't happened. Without that change, this PR will fail (right now, it's pointing at the ZSA LUFA module, which is the ONLY reason it works).

Additionally, we (ZSA) haven't had a chance to really test this out yet. The WebUSB part works, but the rest of it isn't tested, and we'd rather have that finished before this gets merged.

That said, once things are finalized on our side, yes, we plan on finishing up this PR and getting this merged.

Until then, we'd rather it remain as a draft.

wiserfirst · 2020-05-17T02:17:42Z

@drashna awesome. Thanks for the detailed explanation!

right now, it's pointing at the ZSA LUFA module, which is the ONLY reason it works

Can I assume that the zsa fork (https://github.com/zsa/qmk_firmware) would support WebUSB? Thanks!

drashna · 2020-06-05T09:38:19Z

Sorry, I meant to respond sooner!

Can I assume that the zsa fork (zsa/qmk_firmware) would support WebUSB? Thanks!

Yes, it does. And ZSA is using it for the live training mode, actively.

And I just added a PR to QMK so that it doesn't have the compile errors when using a keymap for Oryx.

LSChyi · 2020-10-10T14:43:22Z

quantum/oryx.c

+            uint8_t i;
+            dynamic_keymap_get_buffer(offset, size, &param[3]);
+            event[0] = WEBUSB_STATUS_OK;
+            event[1] = ORYX_EVT_LIVE_UPDATE_GET_BUFFER;
+            for (i = 0; i < size; i++) {
+                event[i+2] = param[i];
+            }
+            event[i+2] = WEBUSB_STOP_BIT;


Why not use:

Suggested change

uint8_t i;

dynamic_keymap_get_buffer(offset, size, &param[3]);

event[0] = WEBUSB_STATUS_OK;

event[1] = ORYX_EVT_LIVE_UPDATE_GET_BUFFER;

for (i = 0; i < size; i++) {

event[i+2] = param[i];

}

event[i+2] = WEBUSB_STOP_BIT;

dynamic_keymap_get_buffer(offset, size, &event[2]);

event[0] = WEBUSB_STATUS_OK;

event[1] = ORYX_EVT_LIVE_UPDATE_GET_BUFFER;

event[size+2] = WEBUSB_STOP_BIT;

? The buffer is already allocated. Also, I think there is a bug in the loop of copying things back.

change to merged branch later

fix: MS OS 2.0 Property value fix: run webusb task on chibios feat: adds pairing key chore: change manufacturer name to ZSA feat: webusb keymap examples fix: adds webusb include on test keymaps feat: update examples + pairing process fix: adds webusb include on test keymaps feat: add landing page url command chore: unused var cleanup chore: refactor webusb lp url command feat: add fw version webusb cmd fix: lufa handle disconnections gracefully chore: renaming of the get version cmds fix: only change usb vesion spec if webusb is enabled fix: chibios handle disconnections gracefully feat: add get layer command fix: remove conditional macro wrapping WEBUSB_PAIR move webusb include to quantum.h Fix merge conflict

Move webusb.h includes to quantum.h (qmk#244) Co-authored-by: Florian Didron <[email protected]> Start moving code out of webusb and to Oryx feature fix type in usb_main for chibiOS Make Dynamic Keymaps more friendly for non-VIA implementations Conflicts: quantum/dynamic_keymap.c It looks like you may be committing a cherry-pick. If this is not correct, please remove the file .git/CHERRY_PICK_HEAD and try again. Please enter the commit message for your changes. Lines starting with '#' will be ignored, and an empty message aborts the commit. Add toggle for live training Add Oryx keymap, etc Add Dynamic Keymap and other webUSB commands Implement core communication Add EEPROM reset functionality Limit number of layers due to eeprom size contstraints Disable live training if other webusb commands are sent Make Dynamic Keymaps optional for Oryx Add Oryx Keymap with dynamic keymaps enabled Move webusb pairing key back into quantum Add firmware ID check Cleanup magic number and functions Cleanup oryx init check Fix function call feat: disable webusb popup by default Fix Live Training bug Forget to check if the firmware is actually paired fix: remove oryx live training boolean assignment Enable Oryx Configurator on Ergodox EZ keymap Fix Dynamic Keymaps includes to be sane

drashna · 2021-09-09T02:52:27Z

Honestly, I think that the direction that QMK is going with is webHID, which uses the raw HID endpoint. As such, I'm not sure how much use this has, and maintaining this isn't worth it.

ruro · 2021-09-09T13:24:43Z

@drashna can you clarify, what this means for the live training support? You have previously implied that you were planning to backport webUSB and live training stuff to qmk. Now that WebUSB is apparently being abandoned, what are your plans regarding this in the future?

drashna · 2021-09-09T22:03:38Z

Likely, a pivot to webHID. WebHID uses the raw HID endpoint via the web browser. Chrome added support for webHID 2 or so years ago, and it is supported by any chromium based browser.

This would be a better way to go, as it would work with raw HID enabled apps like VIA, but also for online based apps (such as Remapper.

And QMK XAP is planning on using raw HID, and we'd like to support that.

ruro · 2021-09-09T22:31:35Z

Ah, okay, thank you for the quick answer. Last question. Just to clarify, will the zsa fork and the configure.zsa.io/train live training app also eventually move to webHID?

drashna · 2021-09-14T00:34:10Z

Ah, okay, thank you for the quick answer. Last question. Just to clarify, will the zsa fork and the configure.zsa.io/train live training app also eventually move to webHID?

I can't say for sure, but I believe that's the goal long term. Especially when QMK XAP is finalized.

drashna added core breaking_change Changes that need to wait for a version increment labels Jan 3, 2020

noroadsleft reviewed Jan 11, 2020

View reviewed changes

keyboards/ergodox_ez/config.h Outdated Show resolved Hide resolved

drashna force-pushed the web_usb branch 6 times, most recently from bba1ea6 to 4e66e94 Compare March 20, 2020 03:53

drashna changed the base branch from master to develop June 5, 2020 09:36

noroadsleft force-pushed the develop branch from 2684791 to d3c256d Compare June 20, 2020 04:32

noroadsleft force-pushed the develop branch from 59cd6ca to d35faa5 Compare July 10, 2020 20:32

noroadsleft force-pushed the develop branch from 415f088 to 14610ee Compare July 18, 2020 07:31

noroadsleft force-pushed the develop branch 2 times, most recently from 550bb6a to 9d827f9 Compare July 31, 2020 19:45

noroadsleft force-pushed the develop branch from 7499550 to 8b7b3ce Compare August 11, 2020 08:25

noroadsleft force-pushed the develop branch 2 times, most recently from 1d4c0cd to 65c27a3 Compare August 29, 2020 21:42

noroadsleft force-pushed the develop branch from 3a8e1b8 to a1b96ba Compare September 4, 2020 22:03

noroadsleft force-pushed the develop branch from a1b96ba to 3430907 Compare September 12, 2020 11:47

LSChyi reviewed Oct 10, 2020

View reviewed changes

github-actions bot added keyboard python labels Nov 28, 2020

drashna force-pushed the web_usb branch from 2178ceb to 906681d Compare November 29, 2020 09:25

github-actions bot removed the documentation label Nov 29, 2020

noroadsleft force-pushed the develop branch from 7d3841e to 3cc7d22 Compare November 30, 2020 11:32

tzarc mentioned this pull request Jan 18, 2021

XAP (née QMK API) discovery and scoping #11567

Open

4 tasks

drashna force-pushed the web_usb branch from 906681d to c47fb7d Compare January 22, 2021 06:20

github-actions bot removed cli qmk cli command python labels Jan 22, 2021

tzarc closed this Feb 27, 2021

tzarc deleted the branch qmk:develop February 27, 2021 20:27

noroadsleft reopened this Feb 27, 2021

drashna force-pushed the web_usb branch from c47fb7d to 8f259ba Compare February 28, 2021 17:45

drashna force-pushed the web_usb branch from 8f259ba to 5c32feb Compare May 4, 2021 16:02

drashna force-pushed the web_usb branch from 5c32feb to 1b13c97 Compare May 30, 2021 07:12

drashna and others added 5 commits July 3, 2021 16:50

Switch LUFA branch to webUSB

875d08f

change to merged branch later

Fix issues with webusb keymap for planck boards

814d370

cleanup

530479d

drashna force-pushed the web_usb branch from 1b13c97 to 530479d Compare July 3, 2021 23:52

Clean up code

4207770

ruro mentioned this pull request Aug 5, 2021

WebUSB compatibility and example abcminiuser/lufa#103

Open

drashna closed this Sep 9, 2021

drashna deleted the web_usb branch December 31, 2022 06:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for WebUSB #7778

Add support for WebUSB #7778

drashna commented Jan 3, 2020

yulei commented Jan 4, 2020

drashna commented Jan 5, 2020

yulei commented Jan 10, 2020

drashna commented Jan 11, 2020

wiserfirst commented May 15, 2020

noroadsleft commented May 15, 2020

drashna commented May 16, 2020

wiserfirst commented May 17, 2020

drashna commented Jun 5, 2020

LSChyi Oct 10, 2020

drashna commented Sep 9, 2021

ruro commented Sep 9, 2021

drashna commented Sep 9, 2021

ruro commented Sep 9, 2021

drashna commented Sep 14, 2021

Add support for WebUSB #7778

Add support for WebUSB #7778

Conversation

drashna commented Jan 3, 2020

Description

Types of Changes

Checklist

yulei commented Jan 4, 2020

drashna commented Jan 5, 2020

yulei commented Jan 10, 2020

drashna commented Jan 11, 2020

wiserfirst commented May 15, 2020

noroadsleft commented May 15, 2020

drashna commented May 16, 2020

wiserfirst commented May 17, 2020

drashna commented Jun 5, 2020

LSChyi Oct 10, 2020

Choose a reason for hiding this comment

drashna commented Sep 9, 2021

ruro commented Sep 9, 2021

drashna commented Sep 9, 2021

ruro commented Sep 9, 2021

drashna commented Sep 14, 2021