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

[Docs] Add dedicated page for Split Keyboard information #5802

Merged
merged 13 commits into from
Jul 16, 2019

Conversation

drashna
Copy link
Member

@drashna drashna commented May 6, 2019

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Checklist

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.

To Do

  • Include more information about hardware, and wiring
  • Add Troubleshooting info
  • Add RGB Underglow information

Copy link
Contributor

@SethBarberee SethBarberee left a comment

Choose a reason for hiding this comment

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

Looks good. Maybe also mention RGBLIGHT_SPLIT for the sake of animation syncing for split keyboards?

docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yanfali yanfali left a comment

Choose a reason for hiding this comment

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

LGTM. I think a short section on troubleshooting would be a valuable addition. Some very non-specific keyboard ideas include, checking for shorts on the TRRS connector, reflowing pins on that connector. Also some pointers to the different configurations for the RGB light strips might be handy. i.e. serial, direct cable attachment, and i2c. With pointers to examples of both.

Otherwise, very good addition.

@yanfali
Copy link
Contributor

yanfali commented May 6, 2019

One additional thought, maybe discuss some of the different controllers available and the pros and cons. With placeholders for ARM. This would also give you a place to mention the sparkfun pro micro and their 3.3v jumper.

docs/feature_split_keyboard.md Outdated Show resolved Hide resolved
@drashna
Copy link
Member Author

drashna commented May 6, 2019

@yanfali Yeah, I need to add a lot more here, However, I wanted to get at least this much done, and started. That way, I could start getting feedback.

@SethBarberee Yeah, was planning on it. Thanks for the feedback!

@yanfali
Copy link
Contributor

yanfali commented May 6, 2019

Screen Shot 2019-05-06 at 10 22 19

I'm seeing this in view mode. So it looks wrong

@drashna
Copy link
Member Author

drashna commented May 6, 2019

Fixed now. Weird markdown formatting issue ...

@mtei
Copy link
Contributor

mtei commented May 14, 2019

I drew some blue figures and some gray figures.

i2c connection

#define USE_I2C

sk-i2c-connection-red

sk-i2c-connection-blue

sk-i2c-connection-gray

soft serial connection

#define SOFT_SERIAL_PIN D0

sk-pd0-connection-red

sk-pd0-connection-blue

sk-pd0-connection-gray

#define SOFT_SERIAL_PIN D2

sk-pd2-connection-red

sk-pd2-connection-blue

sk-pd2-connection-gray

RGB LED connection (single LED chain)

#define SOFT_SERIAL_PIN D2

#define RGB_DI_PIN        B5
#define RGBLED_NUM_LEFT   4
#define RGBLED_NUM_RIGHT  4
#define RGBLED_NUM        (RGBLED_NUM_LEFT+RGBLED_NUM_RIGHT)

sk-led-u-red

sk-led-u-blue

sk-led-u-gray

RGB LED connection (double LED chain with I2C)

#define USE_I2C

#define RGB_DI_PIN  B5
#define RGBLED_NUM  4

or

#define USE_I2C

#define RGB_DI_PIN       B5
#define RGBLED_NUM_LEFT  4
#define RGBLED_NUM_RIGHT 4
#define RGBLED_NUM       (RGBLED_NUM_LEFT+RGBLED_NUM_RIGHT)
#define RGBLED_SPLIT     { RGBLED_NUM_LEFT, RGBLED_NUM_RIGHT }

sk-led-s-i2c-red

sk-led-s-i2c-blue

sk-led-s-i2c-gray

RGB LED connection (double LED chain with serial)

#define SOFT_SERIAL_PIN D2

#define RGB_DI_PIN  B5
#define RGBLED_NUM  4
#define RGBLIGHT_SPLIT

or

#define SOFT_SERIAL_PIN D2

#define RGB_DI_PIN        B5
#define RGBLED_NUM_LEFT   4
#define RGBLED_NUM_RIGHT  4
#define RGBLED_NUM        (RGBLED_NUM_LEFT+RGBLED_NUM_RIGHT)
#define RGBLED_SPLIT      { RGBLED_NUM_LEFT, RGBLED_NUM_RIGHT }

sk-led-s-pd2-red

sk-led-s-pd2-blue

sk-led-s-pd2-gray

@mtei
Copy link
Contributor

mtei commented May 15, 2019

RGBLIGHT_SPLIT V.S. RGBLED_SPLIT

#define RGBLIGHT_SPLIT
//or
// #define USE_I2C

sk-led-snake2-gray

#define RGBLED_SPLIT { RGBLED_NUM_LEFT, RGBLED_NUM_RIGHT }

sk-led-snake1-gray

@drashna drashna marked this pull request as ready for review July 7, 2019 02:56
@skullydazed skullydazed merged commit 311d625 into qmk:master Jul 16, 2019
@drashna drashna deleted the docs/split_keyboard branch July 16, 2019 06:35
doughsay pushed a commit to doughsay/qmk_firmware that referenced this pull request Aug 31, 2019
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
swanmatch pushed a commit to swanmatch/qmk_firmware that referenced this pull request Sep 3, 2019
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
ripxorip pushed a commit to ripxorip/qmk_firmware that referenced this pull request Dec 3, 2019
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
ridingqwerty pushed a commit to ridingqwerty/qmk_firmware that referenced this pull request Jan 10, 2020
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
swamp09 pushed a commit to swamp09/qmk_firmware that referenced this pull request Mar 11, 2020
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants