qmk_firmware/keyboards/keyboardio/model01/config.h

/*
Copyright 2018 James Laird-Wah

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once


/* key matrix size; rows are doubled for split */
#define MATRIX_ROWS 8
#define MATRIX_COLS 8

/* RGB matrix constants */
#define RGB_MATRIX_LED_COUNT 64

// RGB Matrix Animation modes. Explicitly enabled
// For full list of effects, see:
// https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
#define ENABLE_RGB_MATRIX_ALPHAS_MODS
#define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
#define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
#define ENABLE_RGB_MATRIX_BREATHING
#define ENABLE_RGB_MATRIX_BAND_SAT
#define ENABLE_RGB_MATRIX_BAND_VAL
#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
#define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
#define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
#define ENABLE_RGB_MATRIX_CYCLE_ALL
#define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
#define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
#define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
#define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
#define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
#define ENABLE_RGB_MATRIX_DUAL_BEACON
#define ENABLE_RGB_MATRIX_RAINBOW_BEACON
#define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
#define ENABLE_RGB_MATRIX_RAINDROPS
#define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
#define ENABLE_RGB_MATRIX_HUE_BREATHING
#define ENABLE_RGB_MATRIX_HUE_PENDULUM
#define ENABLE_RGB_MATRIX_HUE_WAVE
#define ENABLE_RGB_MATRIX_PIXEL_RAIN
#define ENABLE_RGB_MATRIX_PIXEL_FLOW
#define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
// enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
#define ENABLE_RGB_MATRIX_TYPING_HEATMAP
#define ENABLE_RGB_MATRIX_DIGITAL_RAIN
// enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
#define ENABLE_RGB_MATRIX_SPLASH
#define ENABLE_RGB_MATRIX_MULTISPLASH
#define ENABLE_RGB_MATRIX_SOLID_SPLASH
#define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
Keyboard: add Keyboardio Model 01 (#3900) * Keyboard: add Keyboardio Model01 This port implements key scanning and everything in their default keymap. It doesn't implement mouse warping; QMK can't do that (yet). LED control is mostly not implemented. The ability to set all LEDs is included because they can get stuck on coming from the bootloader otherwise. Single LED control is also implemented for numpad indication. The scanners also support batch LED transfer which is what you'd need if you wanted to do fast effects. Gamma correction is also not implemented, but is present in the original firmware. The necessary info for further implementation is in the KeyboardioScanner module for Kaleidoscope. To install on your keyboard: make model01:avrdude When prompted, hold the "prog" key on the keyboard to put it into programming mode. This can also be achieved by holding the "prog" key while plugging in the keyboard. This works even if the firmware is corrupt or missing. Hot plugging the halves seems to work fine, but there is no explicit support for eg. making sure the matrix scan rate is reconfigured. * model01: clean up includes and include guards Uses #pragma once everywhere. * model01: split LED and matrix code This makes space if someone wants to implement better LED support later on, the keyboard is a lot more capable than the current code. * model01: separate I2C timeouts for matrix vs. LED If the scanners have no data they don't ACK reads and just time out. So we want a pretty short timeout to keep scan rates high. Meanwhile the LED transfers might take longer - I don't know though, so here we are conservative. * model01: implement better LED control - gamma correction from the manufacturer's firmware - suitable delays to allow back to back LED writes - this is fast enough to write the whole keyboard without noticeable delay, in my experience - minor bug fix: RHS Fn key was not addressable * model01: add license to wire-protocol-constants.h * model01: replace gamma LUT The original was of unclear license origin. This one is functionally identical and includes a generator should people wish to adjust it. * model01: use the already-present CIE1931 lightness curve ...rather than baking in another gamma curve. It's said that CIE1931 is the right thing to be using rather than gamma. OK. Let it be so. * model01: call matrix_init_user() from matrix_init_kb() * model01: remove inapplicable config options from rules.mk * model01: readme.md: update build environment links 2018-09-17 22:49:20 +00:00			`/*`
			`Copyright 2018 James Laird-Wah`

			`This program is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published by`
			`the Free Software Foundation, either version 2 of the License, or`
			`(at your option) any later version.`

			`This program is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`GNU General Public License for more details.`

			`You should have received a copy of the GNU General Public License`
			`along with this program. If not, see <http://www.gnu.org/licenses/>.`
			`*/`

			`#pragma once`


			`/* key matrix size; rows are doubled for split */`
			`#define MATRIX_ROWS 8`
			`#define MATRIX_COLS 8`

Keyboard: keyboardio model01: rgbmatrix support (#3989) * model01: implement RGB matrix feature LEDs can still be individually controlled if this is switched off. * model01: use fast banked LED setting commands * model01: update default keymap to use RGB matrix * model01: update RGB matrix support to match common_features.mk * rgb_matrix: include <string.h> This was missing after commit 4d5705ea6ceeb11cd2adc018644ec87c51af4e86 which introduces a use of memset(). * model01: make g_rgb_leds weak This allows users to override which LEDs are configured as modifiers, or tweak the x/y coordinates, should they so choose. 2018-09-28 03:53:36 +00:00			`/* RGB matrix constants */`
Change `DRIVER_LED_COUNT` to `{LED,RGB}_MATRIX_LED_COUNT` (#18399) 2022-09-23 12:46:23 +00:00			`#define RGB_MATRIX_LED_COUNT 64`
Require explicit enabling of RGB Matrix modes (#15018) 2021-11-15 18:41:04 +00:00
			`// RGB Matrix Animation modes. Explicitly enabled`
			`// For full list of effects, see:`
			`// https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects`
			`#define ENABLE_RGB_MATRIX_ALPHAS_MODS`
			`#define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN`
			`#define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT`
			`#define ENABLE_RGB_MATRIX_BREATHING`
			`#define ENABLE_RGB_MATRIX_BAND_SAT`
			`#define ENABLE_RGB_MATRIX_BAND_VAL`
			`#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT`
			`#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL`
			`#define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT`
			`#define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL`
			`#define ENABLE_RGB_MATRIX_CYCLE_ALL`
			`#define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT`
			`#define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN`
			`#define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`
			`#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN`
			`#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL`
			`#define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL`
			`#define ENABLE_RGB_MATRIX_CYCLE_SPIRAL`
			`#define ENABLE_RGB_MATRIX_DUAL_BEACON`
			`#define ENABLE_RGB_MATRIX_RAINBOW_BEACON`
			`#define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS`
			`#define ENABLE_RGB_MATRIX_RAINDROPS`
			`#define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS`
			`#define ENABLE_RGB_MATRIX_HUE_BREATHING`
			`#define ENABLE_RGB_MATRIX_HUE_PENDULUM`
			`#define ENABLE_RGB_MATRIX_HUE_WAVE`
			`#define ENABLE_RGB_MATRIX_PIXEL_RAIN`
			`#define ENABLE_RGB_MATRIX_PIXEL_FLOW`
			`#define ENABLE_RGB_MATRIX_PIXEL_FRACTAL`
			`// enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined`
			`#define ENABLE_RGB_MATRIX_TYPING_HEATMAP`
			`#define ENABLE_RGB_MATRIX_DIGITAL_RAIN`
			`// enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS`
			`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS`
			`#define ENABLE_RGB_MATRIX_SPLASH`
			`#define ENABLE_RGB_MATRIX_MULTISPLASH`
			`#define ENABLE_RGB_MATRIX_SOLID_SPLASH`
			`#define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH`