forked from mirrors/qmk_userspace
		
	Move RGBLight code into its own folder (#13312)
This commit is contained in:
		
					parent
					
						
							
								5a5015594f
							
						
					
				
			
			
				commit
				
					
						cb23fe9fc1
					
				
			
		
					 9 changed files with 16 additions and 23 deletions
				
			
		| 
						 | 
				
			
			@ -196,10 +196,11 @@ ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
 | 
			
		|||
    ifeq ($(filter $(RGBLIGHT_DRIVER),$(VALID_RGBLIGHT_TYPES)),)
 | 
			
		||||
        $(error RGBLIGHT_DRIVER="$(RGBLIGHT_DRIVER)" is not a valid RGB type)
 | 
			
		||||
    else
 | 
			
		||||
        POST_CONFIG_H += $(QUANTUM_DIR)/rgblight_post_config.h
 | 
			
		||||
        COMMON_VPATH += $(QUANTUM_DIR)/rgblight
 | 
			
		||||
        POST_CONFIG_H += $(QUANTUM_DIR)/rgblight/rgblight_post_config.h
 | 
			
		||||
        OPT_DEFS += -DRGBLIGHT_ENABLE
 | 
			
		||||
        SRC += $(QUANTUM_DIR)/color.c
 | 
			
		||||
        SRC += $(QUANTUM_DIR)/rgblight.c
 | 
			
		||||
        SRC += $(QUANTUM_DIR)/rgblight/rgblight.c
 | 
			
		||||
        CIE1931_CURVE := yes
 | 
			
		||||
        RGB_KEYCODES_ENABLE := yes
 | 
			
		||||
    endif
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -368,7 +368,7 @@ qmk generate-docs
 | 
			
		|||
 | 
			
		||||
## `qmk generate-rgb-breathe-table`
 | 
			
		||||
 | 
			
		||||
This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/`.
 | 
			
		||||
This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/rgblight/`.
 | 
			
		||||
 | 
			
		||||
**Usage**:
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -119,7 +119,7 @@ if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a n
 | 
			
		|||
 | 
			
		||||
Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
 | 
			
		||||
 | 
			
		||||
Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol.
 | 
			
		||||
Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight/rgblight.h` there is a contrast table between the old mode number and the current symbol.
 | 
			
		||||
 | 
			
		||||
### Effect and Animation Toggles
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -328,7 +328,7 @@ Normally lighting layers are not shown when RGB Lighting is disabled (e.g. with
 | 
			
		|||
 | 
			
		||||
## Functions
 | 
			
		||||
 | 
			
		||||
If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight.h) for the full list, but the most commonly used functions include:
 | 
			
		||||
If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight/rgblight.h) for the full list, but the most commonly used functions include:
 | 
			
		||||
 | 
			
		||||
### Utility Functions
 | 
			
		||||
|Function                                    |Description                                                        |
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -2,39 +2,31 @@
 | 
			
		|||
MCU = atmega32u4
 | 
			
		||||
 | 
			
		||||
# Bootloader selection
 | 
			
		||||
#   Teensy       halfkay
 | 
			
		||||
#   Pro Micro    caterina
 | 
			
		||||
#   Atmel DFU    atmel-dfu
 | 
			
		||||
#   LUFA DFU     lufa-dfu
 | 
			
		||||
#   QMK DFU      qmk-dfu
 | 
			
		||||
#   ATmega32A    bootloadHID
 | 
			
		||||
#   ATmega328P   USBasp
 | 
			
		||||
BOOTLOADER = atmel-dfu
 | 
			
		||||
 | 
			
		||||
# Build Options
 | 
			
		||||
#   change yes to no to disable
 | 
			
		||||
#
 | 
			
		||||
BOOTMAGIC_ENABLE = lite      # Virtual DIP switch configuration
 | 
			
		||||
BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
 | 
			
		||||
MOUSEKEY_ENABLE = yes       # Mouse keys
 | 
			
		||||
EXTRAKEY_ENABLE = yes       # Audio control and System control
 | 
			
		||||
CONSOLE_ENABLE = no        # Console for debug
 | 
			
		||||
CONSOLE_ENABLE = no         # Console for debug
 | 
			
		||||
COMMAND_ENABLE = yes        # Commands for debug and configuration
 | 
			
		||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 | 
			
		||||
SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
 | 
			
		||||
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 | 
			
		||||
NKRO_ENABLE = no            # USB Nkey Rollover
 | 
			
		||||
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality on B7 by default
 | 
			
		||||
MIDI_ENABLE = no            # MIDI support
 | 
			
		||||
UNICODE_ENABLE = no         # Unicode
 | 
			
		||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
			
		||||
AUDIO_ENABLE = no           # Audio output on port C6
 | 
			
		||||
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 | 
			
		||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth
 | 
			
		||||
AUDIO_ENABLE = no           # Audio output
 | 
			
		||||
 | 
			
		||||
SRC += mxss_frontled.c
 | 
			
		||||
 | 
			
		||||
# Remove the common RGB light code and use my iteration instead
 | 
			
		||||
COMMON_VPATH += $(QUANTUM_DIR)/rgblight
 | 
			
		||||
OPT_DEFS += -DRGBLIGHT_ENABLE
 | 
			
		||||
SRC += $(QUANTUM_DIR)/process_keycode/process_rgb.c
 | 
			
		||||
SRC += rgblight.c
 | 
			
		||||
SRC += color.c
 | 
			
		||||
SRC += ws2812.c
 | 
			
		||||
SRC += $(QUANTUM_DIR)/color.c
 | 
			
		||||
WS2812_DRIVER_REQUIRED = yes
 | 
			
		||||
CIE1931_CURVE = yes
 | 
			
		||||
RGB_KEYCODES_ENABLE = yes
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -890,7 +890,7 @@ void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom) {
 | 
			
		|||
        animation_status.restart = true;
 | 
			
		||||
    }
 | 
			
		||||
#        endif /* RGBLIGHT_SPLIT_NO_ANIMATION_SYNC */
 | 
			
		||||
#    endif /* RGBLIGHT_USE_TIMER */
 | 
			
		||||
#    endif     /* RGBLIGHT_USE_TIMER */
 | 
			
		||||
}
 | 
			
		||||
#endif /* RGBLIGHT_SPLIT */
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue