Add modifier state to the split keyboard transport #10400

cwebster2 · 2020-09-23T04:38:56Z

Description

This adds modifier state to the i2c and serial transport for split
keyboards. The purpose of this is to allow e.g. displaying modifier
state on the slave side of a split keyboard on an oled. This adds two
or three bytes to the data transferred between split halves.

This also fixes a missing ifdef guard for BACKLIGHT_ENABLE.

Types of Changes

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
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).

quantum/split_common/transport.c

cwebster2 · 2020-09-23T14:02:56Z

I have incorporated all the suggested changes into my PR.

fauxpark

Some slight cosmetic fixes.

quantum/split_common/transport.c

cwebster2 · 2020-09-23T16:13:35Z

I think i've now addressed the above comments.

quantum/split_common/transport.c

zvecr

Given this will change the scan rate a fair bit, this change should be optional, opt-in rather than out. That way boards which have zero reason to use the data, no oled etc, can remain as fast as they used to be.

cwebster2 · 2020-10-04T13:31:04Z

Given this will change the scan rate a fair bit, this change should be optional, opt-in rather than out. That way boards which have zero reason to use the data, no oled etc, can remain as fast as they used to be.

The added code is now behind a define to make it opt-in.

drashna · 2020-10-04T19:56:02Z

Also, could you add documentation for this. It doesn't need to be extensive, but it should be documented.
https://github.com/qmk/qmk_firmware/blob/master/docs/feature_split_keyboard.md

cwebster2 · 2020-10-04T20:44:29Z

Also, could you add documentation for this. It doesn't need to be extensive, but it should be documented.
https://github.com/qmk/qmk_firmware/blob/master/docs/feature_split_keyboard.md

I have documented the define under communication options on this page and made mention that it of cosmetic use and may impact the matrix scan rate if enabled per zvecr's earlier comment in this PR.

fauxpark · 2020-10-21T03:16:26Z

@cwebster2 looks like this needs a rebase, sorry.

cwebster2 · 2020-10-21T14:38:36Z

I will take care of that later today.

cwebster2 · 2020-10-22T04:51:46Z

@fauxpark I have rebased my branch against qmk/develop

cwebster2 · 2020-10-29T18:29:17Z

@zvecr this has probably fallen off the radar, but wondering if your change request has been satisfied and it this is ready to merge.

cwebster2 · 2020-10-31T20:54:33Z

I've rebased this PR against develop yet again, but squashed it into a single commit this time.

Out of curiosity, what workflow is in use in this branch that results in this frequent history rewriting?

This adds modifier state to the i2c and serial transport for split keyboards. The purpose of this is to allow e.g. displaying modifier state on the slave side of a split keyboard on an oled. This adds one byte to the data transferred between halves. This also fixes a missing ifdef guard for BLACKLIGHT_ENABLE. Break modifiers into real/weak/oneshot Fix incorrect slave serial mod setting Fix typo in serial weal mod setter Fix build errors for the I2C code that I introduced Code cleanup and formatting per project preferences Correctly get oneshot mods Fix missing braces Remove unneeded ifdef guard Make the added state transport optional Add documentation for the new define to enable this feature Fix stray grave mark

* Add modifier state to the split transport This adds modifier state to the i2c and serial transport for split keyboards. The purpose of this is to allow e.g. displaying modifier state on the slave side of a split keyboard on an oled. This adds one byte to the data transferred between halves. This also fixes a missing ifdef guard for BLACKLIGHT_ENABLE. Break modifiers into real/weak/oneshot Fix incorrect slave serial mod setting Fix typo in serial weal mod setter Fix build errors for the I2C code that I introduced Code cleanup and formatting per project preferences Correctly get oneshot mods Fix missing braces Remove unneeded ifdef guard Make the added state transport optional Add documentation for the new define to enable this feature Fix stray grave mark * Fix error introduced in conflict resolution

fauxpark requested changes Sep 23, 2020

View reviewed changes

fauxpark requested a review from a team September 23, 2020 06:17

fauxpark added breaking_change Changes that need to wait for a version increment core enhancement labels Sep 23, 2020

fauxpark requested changes Sep 23, 2020

View reviewed changes

quantum/split_common/transport.c Show resolved Hide resolved

quantum/split_common/transport.c Show resolved Hide resolved

quantum/split_common/transport.c Show resolved Hide resolved

fauxpark requested changes Sep 23, 2020

View reviewed changes

quantum/split_common/transport.c Outdated Show resolved Hide resolved

fauxpark approved these changes Sep 23, 2020

View reviewed changes

fauxpark requested a review from a team September 23, 2020 16:34

tzarc approved these changes Oct 3, 2020

View reviewed changes

tzarc requested a review from zvecr October 3, 2020 18:27

zvecr requested changes Oct 3, 2020

View reviewed changes

drashna added the needs doc label Oct 4, 2020

drashna approved these changes Oct 4, 2020

View reviewed changes

skullydazed force-pushed the develop branch from fa8cf59 to cce70f1 Compare October 18, 2020 21:10

cwebster2 force-pushed the develop branch from 959d025 to bf5f0de Compare October 22, 2020 04:48

noroadsleft force-pushed the develop branch from 5720202 to dcefc1a Compare October 23, 2020 22:37

cwebster2 force-pushed the develop branch from bf5f0de to 65c7a06 Compare October 24, 2020 03:11

github-actions bot added the documentation label Oct 24, 2020

skullydazed force-pushed the develop branch from db745a9 to 68fc044 Compare October 28, 2020 02:16

cwebster2 force-pushed the develop branch from 65c7a06 to 9055500 Compare October 29, 2020 18:23

fauxpark requested a review from zvecr October 29, 2020 18:31

noroadsleft force-pushed the develop branch from 92ca6b9 to c3221d4 Compare October 30, 2020 20:23

cwebster2 force-pushed the develop branch from 9055500 to 136a674 Compare October 31, 2020 20:51

noroadsleft closed this Nov 28, 2020

noroadsleft deleted the branch qmk:develop November 28, 2020 20:02

tzarc reopened this Nov 28, 2020

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

cwebster2 force-pushed the develop branch from 136a674 to 200a1ad Compare December 1, 2020 05:01

cwebster2 added 2 commits December 1, 2020 23:55

Merge branch 'develop' into develop

cbe0108

Fix error introduced in conflict resolution

02d9752

tzarc merged commit 5e2b535 into qmk:develop Dec 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add modifier state to the split keyboard transport #10400

Add modifier state to the split keyboard transport #10400

cwebster2 commented Sep 23, 2020 •

edited

Loading

cwebster2 commented Sep 23, 2020

fauxpark left a comment

cwebster2 commented Sep 23, 2020

zvecr left a comment

cwebster2 commented Oct 4, 2020

drashna commented Oct 4, 2020

cwebster2 commented Oct 4, 2020

fauxpark commented Oct 21, 2020

cwebster2 commented Oct 21, 2020

cwebster2 commented Oct 22, 2020

cwebster2 commented Oct 29, 2020

cwebster2 commented Oct 31, 2020

Add modifier state to the split keyboard transport #10400

Add modifier state to the split keyboard transport #10400

Conversation

cwebster2 commented Sep 23, 2020 • edited Loading

Description

Types of Changes

Checklist

cwebster2 commented Sep 23, 2020

fauxpark left a comment

Choose a reason for hiding this comment

cwebster2 commented Sep 23, 2020

zvecr left a comment

Choose a reason for hiding this comment

cwebster2 commented Oct 4, 2020

drashna commented Oct 4, 2020

cwebster2 commented Oct 4, 2020

fauxpark commented Oct 21, 2020

cwebster2 commented Oct 21, 2020

cwebster2 commented Oct 22, 2020

cwebster2 commented Oct 29, 2020

cwebster2 commented Oct 31, 2020

cwebster2 commented Sep 23, 2020 •

edited

Loading