qmk-dactyl-manuform-a/keyboards/planck/ez
James Young c66df16644
2020 November 28 Breaking Changes Update (#11053)
* Branch point for 2020 November 28 Breaking Change                                                

* Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183)                                           

* Add support for soft serial to ATmega32U2 (#10204)                                               

* Change MIDI velocity implementation to allow direct control of velocity value (#9940)            

* Add ability to build a subset of all keyboards based on platform.                                

* Actually use eeprom_driver_init().                                                               

* Make bootloader_jump weak for ChibiOS. (#10417)                                                  

* Joystick 16-bit support (#10439)                                                                 

* Per-encoder resolutions (#10259)                                                                 

* Share button state from mousekey to pointing_device (#10179)                                     

* Add hotfix for chibios keyboards not wake (#10088)                                               

* Add advanced/efficient RGB Matrix Indicators (#8564)                                             

* Naming change.                                                                                   

* Support for STM32 GPIOF,G,H,I,J,K (#10206)                                                       

* Add milc as a dependency and remove the installed milc (#10563)                                  

* ChibiOS upgrade: early init conversions (#10214)                                                 

* ChibiOS upgrade: configuration file migrator (#9952)                                             

* Haptic and solenoid cleanup (#9700)                                                              

* XD75 cleanup (#10524)                                                                            

* OLED display update interval support (#10388)                                                    

* Add definition based on currently-selected serial driver. (#10716)                               

* New feature: Retro Tapping per key (#10622)                                                      

* Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638)             

* Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530)

* Rescale both ChibiOS and AVR backlighting.                                                       

* Reduce Helix keyboard build variation (#8669)                                                    

* Minor change to behavior allowing display updates to continue between task ticks (#10750)        

* Some GPIO manipulations in matrix.c change to atomic. (#10491)                                   

* qmk cformat (#10767)                                                                             

* [Keyboard] Update the Speedo firmware for v3.0 (#10657)                                          

* Maartenwut/Maarten namechange to evyd13/Evy (#10274)                                             

* [quantum] combine repeated lines of code (#10837)                                                

* Add step sequencer feature (#9703)                                                               

* aeboards/ext65 refactor (#10820)                                                                 

* Refactor xelus/dawn60 for Rev2 later (#10584)                                                    

* add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824)                                 

* [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549)                                    

* update chibios os usb for the otg driver (#8893)                                                 

* Remove HD44780 References, Part 4 (#10735)                                                       

* [Keyboard] Add Valor FRL TKL (+refactor) (#10512)                                                

* Fix cursor position bug in oled_write_raw functions (#10800)                                     

* Fixup version.h writing when using SKIP_VERSION=yes (#10972)                                     

* Allow for certain code in the codebase assuming length of string. (#10974)                       

* Add AT90USB support for serial.c (#10706)                                                        

* Auto shift: support repeats and early registration (#9826)                                       

* Rename ledmatrix.h to match .c file (#7949)                                                      

* Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231)                                        

* Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840)                                        

* Merge point for 2020 Nov 28 Breaking Change
2020-11-28 12:02:18 -08:00
..
glow 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
config.h [Keyboard] Update to ZSA Boards (#10119) 2020-10-13 04:35:36 -07:00
ez.c [Keyboard] Update to ZSA Boards (#10119) 2020-10-13 04:35:36 -07:00
ez.h [Keyboard] Update to ZSA Boards (#10119) 2020-10-13 04:35:36 -07:00
info.json
readme.md [Keyboard] Update to ZSA Boards (#10119) 2020-10-13 04:35:36 -07:00
rules.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00

readme.md

Planck EZ

Planck EZ

A variant of the Planck featuring a 2u spacebar and per-key RGB backlighting.

Keyboard Maintainer: Jack Humbert
Hardware Supported: Planck EZ
Hardware Availability: ergodox-ez.com

Make example for this keyboard (after setting up your build environment):

make planck/ez:default

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Planck EZ Glow

For the per key RGB version of this keyboard, you want to use the "glow" subdirectory. For example:

make planck/ez/glow:default

Planck EZ Configuration (from Oryx)

Indicator LEDs

The two front "teeth" LED indicators are PWM controlled. If you have ORYX_CONFIGURATOR defined in your keymap's config.h, you can use the LED_LEVEL to cycle through preset vales (0, 25%, 50%, 75%, 100%), and will be saved to EEPROM (persistent storage)

Alternatively, you can set the brightness by calling the following functions:

void planck_ez_right_led_level(uint8_t level);
void planck_ez_left_led_level(uint8_t level);

These settings are not persistent, so you'd need to reset it every time the board starts.

These are on a 0-255 scale

Layer indication

By default, the indicator lights are used for layer indication, expecting the specific layers used in the default keymap. However, this may not work for you. And if that is the case, you can add #define PLANCK_EZ_USER_LEDS to your config.h file.

This will remove the default behavior for changing the LEDs based on layer, and allow you to control them manually.

Alternatively, you can use the following defines in your keymap's config.h to control which layers are used, as long as you have ORYX_CONFIGURATOR defined in your keymap's config.h file, as well.

#define PLANCK_EZ_LED_LOWER 3
#define PLANCK_EZ_LED_RAISE 4
#define PLANCK_EZ_LED_ADJUST 6

This will allow you to change the layers that are used, without having to add anything code to your keymap.c

RGB Matrix Features

If you're using the Smart LED (layer indication) feature from the Oryx Configurator, you want to make sure that you enable these options by adding #define ORYX_CONFIGURATOR to your keymap's config.h.

This changes the RGB_TOG keycode so that it will toggle the lights on and off, in a way that will allow the Smart LEDs to continue to work, even with the rest of the LEDs turned off.

Additionally, a new keycode has been added to toggle the Smart LEDs. Use TOGGLE_LAYER_COLOR, if you aren't already.