qmk_firmware/keyboards/ergodox_ez/readme.md

45 lines
2.2 KiB
Markdown
Raw Normal View History

# ErgoDox EZ
2020-05-28 08:26:53 +00:00
![ErgoDox EZ](http://www.coolthings.com/wp-content/uploads/2017/05/ergodox-ez-2.jpg)
2020-05-28 08:26:53 +00:00
The ErgoDox EZ is a mass produced version of the original ErgoDox keyboard, with optional support for RGB Light (Shine) or RGB Matrix (Glow).
2020-05-28 08:26:53 +00:00
* Keyboard Maintainer: [ZSA Technology Labs Inc](https://github.com/zsa), Firmware maintained by [drashna](https://github.com/drashna)
* Hardware Supported: Original ErgoDox, ErgoDox EZ
* Hardware Availability: [ErgoDox EZ](https://ergodox-ez.com/), [ErgoDox.io](https://ergodox.io)
2020-05-28 08:26:53 +00:00
Make example for this keyboard (after setting up your build environment):
2020-05-28 08:26:53 +00:00
make ergodox_ez:default:flash
2020-05-28 08:26:53 +00: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).
2020-05-28 08:26:53 +00:00
## Oryx Configuation
2020-05-28 08:26:53 +00:00
If you have `ORYX_CONFIGURATOR` defined in your keymap's `config.h`, this enables a number of the built in options from the Oryx Configurator.
2020-05-28 08:26:53 +00:00
### Indicator LEDs
2020-05-28 08:26:53 +00:00
You can use the `LED_LEVEL` keycode to cycle through the brightness levels for the LEDs on the top right of the keyboard. These settings are saved in eeprom (persistant memory).
2020-05-28 08:26:53 +00:00
Alternatively, you can set the brightness by calling the following functions:
2020-05-28 08:26:53 +00:00
```c
void ergodox_led_all_set(uint8_t level);
void ergodox_right_led_1_set(uint8_t level);
void ergodox_right_led_2_set(uint8_t level);
void ergodox_right_led_3_set(uint8_t level);
```
2020-05-28 08:26:53 +00:00
These settings are not persistent, so you'd need to reset it every time the board starts.
2020-05-28 08:26:53 +00:00
These are on a 0-255 scale
2020-05-28 08:26:53 +00:00
### RGB Matrix Features
2020-05-28 08:26:53 +00:00
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`.
2020-05-28 08:26:53 +00:00
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.