keychron_qmk_firmware/keyboards/splitkb/kyria/readme.md

42 lines
2.4 KiB
Markdown
Raw Normal View History

[Keyboard] Add the Kyria keyboard (#7222) * Added raw api for sending data directly to the buffer * Added default keymap variant * Applied proposed OLED display fix * Keymap progress * Keymap progress * Fixed inconsistent tabs * Fixed oled_write_raw apis * Updated keymap * Personal keymap * Added functionality to own keymap * Fixed spacing and build error * Keymap changes * Revert "Updated split encoders so indexes are based on left hand encoders first (#6382)" This reverts commit 46c49ae4e639509ceb6e81c460855d2eb89086b8. * Updated keymaps and configs * Revert "Revert "Updated split encoders so indexes are based on left hand encoders first (#6382)"" This reverts commit f6a85fe1aa9acd2ef77a5ed0ad8f39834cc366d7. * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/rev1.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/rules.mk Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Processed keymap feedback * Reverted OLED raw API functionality
2019-11-04 05:43:26 +06:00
# Kyria
![Kyria](https://cdn.shopify.com/s/files/1/0227/9171/6941/products/PlateCase_f1870016-98b8-43a9-8aed-3eaf073b367b_900x.jpg?v=1568934600)
An ergonomical 40% split keyboard
Keyboard Maintainer: [splitkb.com](https://github.com/splitkb)
Hardware Supported: Pro Micro 5V/16MHz and compatible.
Hardware Availability: [splitkb.com](https://splitkb.com) and partners.
Make example for this keyboard (after setting up your build environment):
make splitkb/kyria/rev1:default
make splitkb/kyria/rev1/proton_c:default
[Keyboard] Add the Kyria keyboard (#7222) * Added raw api for sending data directly to the buffer * Added default keymap variant * Applied proposed OLED display fix * Keymap progress * Keymap progress * Fixed inconsistent tabs * Fixed oled_write_raw apis * Updated keymap * Personal keymap * Added functionality to own keymap * Fixed spacing and build error * Keymap changes * Revert "Updated split encoders so indexes are based on left hand encoders first (#6382)" This reverts commit 46c49ae4e639509ceb6e81c460855d2eb89086b8. * Updated keymaps and configs * Revert "Revert "Updated split encoders so indexes are based on left hand encoders first (#6382)"" This reverts commit f6a85fe1aa9acd2ef77a5ed0ad8f39834cc366d7. * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/rev1.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/rules.mk Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Processed keymap feedback * Reverted OLED raw API functionality
2019-11-04 05:43:26 +06:00
Example of flashing this keyboard:
make splitkb/kyria/rev1:default:flash
[Keyboard] Add the Kyria keyboard (#7222) * Added raw api for sending data directly to the buffer * Added default keymap variant * Applied proposed OLED display fix * Keymap progress * Keymap progress * Fixed inconsistent tabs * Fixed oled_write_raw apis * Updated keymap * Personal keymap * Added functionality to own keymap * Fixed spacing and build error * Keymap changes * Revert "Updated split encoders so indexes are based on left hand encoders first (#6382)" This reverts commit 46c49ae4e639509ceb6e81c460855d2eb89086b8. * Updated keymaps and configs * Revert "Revert "Updated split encoders so indexes are based on left hand encoders first (#6382)"" This reverts commit f6a85fe1aa9acd2ef77a5ed0ad8f39834cc366d7. * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/rev1.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/rev1/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/rules.mk Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/kyria/keymaps/thomasbaart/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Processed keymap feedback * Reverted OLED raw API functionality
2019-11-04 05:43:26 +06:00
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
A build guide for the Kyria can be found at [docs.splitkb.com](https://docs.splitkb.com/hc/en-us/articles/360010552059-Kyria-Build-Guide-Introduction).
## Proton C Conversion Guide
If you're one of the lucky people to have Proton Cs to use with their Kyria, there are a couple of caveats to getting this working.
1. You need to have 2x Proton Cs, as you cannot mix and match with Pro Micros or Elite C's. They both need to be Proton Cs.
2. You'll need to do some modding to enable proper support with the Proton C.
By design, the Kyria uses every available pin on the Pro Micro footprint. This includes using D3 (RX) for RGB. This poses a challenge with using the Proton C, since it needs both the TX and RX pins. The Proton C needs both pins, especially if you plan on using Full Duplex Serial.
To fix this, you need to break off the last header position on the right-hand side on the footprint. This is the `TX0/D3` pad. Leave this pad without a header connected to.
From the A9 pin on the Proton C, you want to run a wire from it to the `SDA + Extra Data` pad near the TRRS jack on the PCB. This will allow for proper, full duplex communication over the TRRS cable.
To get RGB working properly, as well, you want to run a wire from the `A3` pin on the Proton C, next to the GND and DFU pin, right under the USB port. Run this to the `TX0/D3` pad (the one you left without a header pin on the PCB).
Once you've done that, you can solder in the Proton C. and flash it.
![Proton C](https://i.imgur.com/nICqWLo.jpg)