keychron_qmk_firmware/keyboards/duck/orion/v3/readme.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

# Duck Orion V3
Non official firmware for custom TKL Korean keyboard made by Duck.
Group buy was run December 2018 via [geekhack](https://geekhack.org/index.php?topic=98581.0) with 100 keyboards total.
[Keyboard] Orion Locking Indicator LED Support (#7683) * add indicator lighting support thanks to Keebology tracing * set the correct number of underglow LEDs * add comments and skeletal structure for layer indicator LEDs * add backlight areas pins * update readme * we can't turn leds on based on zones, so we use multiple backlight pin support instead to turn them ALL on and control them. * add comments to backlight setting * make a more useful default keymap that can also be used for testing * add duck orion to list * add indicator led support * update readme * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * add the appropriate header files * fix indent so Drashna will not die * Update keyboards/duck/orion/v3/v3.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30 01:16:24 +06:00
* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
* Hardware Supported: Duck Orion V3 PCB Ver 2.1
* Hardware Availability: Wait until GB of the next revision
Make example for this keyboard (after setting up your build environment):
make duck/orion/v3:default
**Reset Key:** To put the Orion V3 into reset, hold Backspace key (`K4N`) while plugging in.
[Keyboard] Orion Locking Indicator LED Support (#7683) * add indicator lighting support thanks to Keebology tracing * set the correct number of underglow LEDs * add comments and skeletal structure for layer indicator LEDs * add backlight areas pins * update readme * we can't turn leds on based on zones, so we use multiple backlight pin support instead to turn them ALL on and control them. * add comments to backlight setting * make a more useful default keymap that can also be used for testing * add duck orion to list * add indicator led support * update readme * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * add the appropriate header files * fix indent so Drashna will not die * Update keyboards/duck/orion/v3/v3.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30 01:16:24 +06:00
**CAUTION:** At this time 12/19/19 layer indicator lighting has not been implemented by default.
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).
## Hardware Notes
The Orion V3 PCB consists of:
### Microchips
[Keyboard] Orion Locking Indicator LED Support (#7683) * add indicator lighting support thanks to Keebology tracing * set the correct number of underglow LEDs * add comments and skeletal structure for layer indicator LEDs * add backlight areas pins * update readme * we can't turn leds on based on zones, so we use multiple backlight pin support instead to turn them ALL on and control them. * add comments to backlight setting * make a more useful default keymap that can also be used for testing * add duck orion to list * add indicator led support * update readme * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * add the appropriate header files * fix indent so Drashna will not die * Update keyboards/duck/orion/v3/v3.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30 01:16:24 +06:00
2 74HC237D 3-to-8 line decoders U1, U2
1 Atmega32u4 microcontroller
[Keyboard] Orion Locking Indicator LED Support (#7683) * add indicator lighting support thanks to Keebology tracing * set the correct number of underglow LEDs * add comments and skeletal structure for layer indicator LEDs * add backlight areas pins * update readme * we can't turn leds on based on zones, so we use multiple backlight pin support instead to turn them ALL on and control them. * add comments to backlight setting * make a more useful default keymap that can also be used for testing * add duck orion to list * add indicator led support * update readme * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * add the appropriate header files * fix indent so Drashna will not die * Update keyboards/duck/orion/v3/v3.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30 01:16:24 +06:00
2 WS2811 LED controller U5, U6
## Notes
[Keyboard] Orion Locking Indicator LED Support (#7683) * add indicator lighting support thanks to Keebology tracing * set the correct number of underglow LEDs * add comments and skeletal structure for layer indicator LEDs * add backlight areas pins * update readme * we can't turn leds on based on zones, so we use multiple backlight pin support instead to turn them ALL on and control them. * add comments to backlight setting * make a more useful default keymap that can also be used for testing * add duck orion to list * add indicator led support * update readme * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/duck/orion/v3/matrix.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * add the appropriate header files * fix indent so Drashna will not die * Update keyboards/duck/orion/v3/v3.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/keymaps/default/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/duck/orion/v3/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30 01:16:24 +06:00
Special thanks to Marcus aka Keebology for doing this remotely and mapping the matrix, indicator LEDs, and backlight LEDs.