diff options
| author | IBNobody <ibnobody@gmail.com> | 2016-09-03 23:21:24 -0500 |
|---|---|---|
| committer | IBNobody <ibnobody@gmail.com> | 2016-09-03 23:21:24 -0500 |
| commit | d55a705bbb362934306a3be632d6bacb99fd9de2 (patch) | |
| tree | 4f77aa70fcf7b12a4cdecee432dff46d779d214f | |
| parent | f065652812e6ac783db50e58a42fbb01ea817fbc (diff) | |
| download | qmk_firmware-d55a705bbb362934306a3be632d6bacb99fd9de2.tar.gz qmk_firmware-d55a705bbb362934306a3be632d6bacb99fd9de2.zip | |
Moved breathing backlighting section in readme.md
| -rw-r--r-- | readme.md | 120 |
1 files changed, 60 insertions, 60 deletions
| @@ -877,6 +877,66 @@ In `quantum/keymap_extras/`, you'll see various language files - these work the | |||
| 877 | 877 | ||
| 878 | You can currently send 4 hex digits with your OS-specific modifier key (RALT for OSX with the "Unicode Hex Input" layout) - this is currently limited to supporting one OS at a time, and requires a recompile for switching. 8 digit hex codes are being worked on. The keycode function is `UC(n)`, where *n* is a 4 digit hexidecimal. Enable from the Makefile. | 878 | You can currently send 4 hex digits with your OS-specific modifier key (RALT for OSX with the "Unicode Hex Input" layout) - this is currently limited to supporting one OS at a time, and requires a recompile for switching. 8 digit hex codes are being worked on. The keycode function is `UC(n)`, where *n* is a 4 digit hexidecimal. Enable from the Makefile. |
| 879 | 879 | ||
| 880 | ## Backlight Breathing | ||
| 881 | |||
| 882 | In order to enable backlight breathing, the following line must be added to your config.h file. | ||
| 883 | |||
| 884 | #define BACKLIGHT_BREATHING | ||
| 885 | |||
| 886 | The following function calls are used to control the breathing effect. | ||
| 887 | |||
| 888 | * ```breathing_enable()``` - Enable the free-running breathing effect. | ||
| 889 | * ```breathing_disable()``` - Disable the free-running breathing effect immediately. | ||
| 890 | * ```breathing_self_disable()``` - Disable the free-running breathing effect after the current effect ends. | ||
| 891 | * ```breathing_toggle()``` - Toggle the free-running breathing effect. | ||
| 892 | * ```breathing_defaults()``` - Reset the speed and brightness settings of the breathing effect. | ||
| 893 | |||
| 894 | The following function calls are used to control the maximum brightness of the breathing effect. | ||
| 895 | |||
| 896 | * ```breathing_intensity_set(value)``` - Set the brightness of the breathing effect when it is at its max value. | ||
| 897 | * ```breathing_intensity_default()``` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity. | ||
| 898 | |||
| 899 | The following function calls are used to control the cycling speed of the breathing effect. | ||
| 900 | |||
| 901 | * ```breathing_speed_set(value)``` - Set the speed of the breathing effect - how fast it cycles. | ||
| 902 | * ```breathing_speed_inc(value)``` - Increase the speed of the breathing effect by a fixed value. | ||
| 903 | * ```breathing_speed_dec(value)``` - Decrease the speed of the breathing effect by a fixed value. | ||
| 904 | * ```breathing_speed_default()``` - Reset the speed of the breathing effect to the default value. | ||
| 905 | |||
| 906 | The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed: | ||
| 907 | |||
| 908 | case MACRO_FUNCTION: | ||
| 909 | if (record->event.pressed) | ||
| 910 | { | ||
| 911 | breathing_speed_set(3); | ||
| 912 | breathing_enable(); | ||
| 913 | layer_on(LAYER_FUNCTION); | ||
| 914 | } | ||
| 915 | else | ||
| 916 | { | ||
| 917 | breathing_speed_set(1); | ||
| 918 | breathing_self_disable(); | ||
| 919 | layer_off(LAYER_FUNCTION); | ||
| 920 | } | ||
| 921 | break; | ||
| 922 | |||
| 923 | The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed: | ||
| 924 | |||
| 925 | case MACRO_RAISED: | ||
| 926 | if (record->event.pressed) | ||
| 927 | { | ||
| 928 | layer_on(LAYER_RAISED); | ||
| 929 | breathing_speed_set(2); | ||
| 930 | breathing_pulse(); | ||
| 931 | update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST); | ||
| 932 | } | ||
| 933 | else | ||
| 934 | { | ||
| 935 | layer_off(LAYER_RAISED); | ||
| 936 | update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST); | ||
| 937 | } | ||
| 938 | break; | ||
| 939 | |||
| 880 | ## Other firmware shortcut keycodes | 940 | ## Other firmware shortcut keycodes |
| 881 | 941 | ||
| 882 | * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`) | 942 | * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`) |
| @@ -1030,66 +1090,6 @@ In the default script of AutoHotkey you can define custom hotkeys. | |||
| 1030 | The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a. | 1090 | The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a. |
| 1031 | AutoHotkey inserts the Text right of `Send, ` when this combination is pressed. | 1091 | AutoHotkey inserts the Text right of `Send, ` when this combination is pressed. |
| 1032 | 1092 | ||
| 1033 | ## Backlight Breathing | ||
| 1034 | |||
| 1035 | In order to enable backlight breathing, the following line must be added to your config.h file. | ||
| 1036 | |||
| 1037 | #define BACKLIGHT_BREATHING | ||
| 1038 | |||
| 1039 | The following function calls are used to control the breathing effect. | ||
| 1040 | |||
| 1041 | * ```breathing_enable()``` - Enable the free-running breathing effect. | ||
| 1042 | * ```breathing_disable()``` - Disable the free-running breathing effect immediately. | ||
| 1043 | * ```breathing_self_disable()``` - Disable the free-running breathing effect after the current effect ends. | ||
| 1044 | * ```breathing_toggle()``` - Toggle the free-running breathing effect. | ||
| 1045 | * ```breathing_defaults()``` - Reset the speed and brightness settings of the breathing effect. | ||
| 1046 | |||
| 1047 | The following function calls are used to control the maximum brightness of the breathing effect. | ||
| 1048 | |||
| 1049 | * ```breathing_intensity_set(value)``` - Set the brightness of the breathing effect when it is at its max value. | ||
| 1050 | * ```breathing_intensity_default()``` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity. | ||
| 1051 | |||
| 1052 | The following function calls are used to control the cycling speed of the breathing effect. | ||
| 1053 | |||
| 1054 | * ```breathing_speed_set(value)``` - Set the speed of the breathing effect - how fast it cycles. | ||
| 1055 | * ```breathing_speed_inc(value)``` - Increase the speed of the breathing effect by a fixed value. | ||
| 1056 | * ```breathing_speed_dec(value)``` - Decrease the speed of the breathing effect by a fixed value. | ||
| 1057 | * ```breathing_speed_default()``` - Reset the speed of the breathing effect to the default value. | ||
| 1058 | |||
| 1059 | The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed: | ||
| 1060 | |||
| 1061 | case MACRO_FUNCTION: | ||
| 1062 | if (record->event.pressed) | ||
| 1063 | { | ||
| 1064 | breathing_speed_set(3); | ||
| 1065 | breathing_enable(); | ||
| 1066 | layer_on(LAYER_FUNCTION); | ||
| 1067 | } | ||
| 1068 | else | ||
| 1069 | { | ||
| 1070 | breathing_speed_set(1); | ||
| 1071 | breathing_self_disable(); | ||
| 1072 | layer_off(LAYER_FUNCTION); | ||
| 1073 | } | ||
| 1074 | break; | ||
| 1075 | |||
| 1076 | The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed: | ||
| 1077 | |||
| 1078 | case MACRO_RAISED: | ||
| 1079 | if (record->event.pressed) | ||
| 1080 | { | ||
| 1081 | layer_on(LAYER_RAISED); | ||
| 1082 | breathing_speed_set(2); | ||
| 1083 | breathing_pulse(); | ||
| 1084 | update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST); | ||
| 1085 | } | ||
| 1086 | else | ||
| 1087 | { | ||
| 1088 | layer_off(LAYER_RAISED); | ||
| 1089 | update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST); | ||
| 1090 | } | ||
| 1091 | break; | ||
| 1092 | |||
| 1093 | ## RGB Under Glow Mod | 1093 | ## RGB Under Glow Mod |
| 1094 | 1094 | ||
| 1095 |  | 1095 |  |
