History

fauxpark ba42a5ae68 Remove commented out MCUs in rules.mk (#5884 )		2019-07-16 00:26:38 -07:00
..
keymaps/default	Remove/migrate action_get_macro()s from default keymaps (#5625 )	2019-07-15 23:04:02 -07:00
templates	Remove redundant KC_TRNS and KC_NO fillers in default keymaps (#5152 )	2019-02-16 21:36:02 -08:00
config.h	Replace DEBOUNCING_DELAY (deprecated) with DEBOUNCE (#5997 )	2019-06-06 12:09:56 -07:00
info.json	MxSS Configurator bugfix: removed an extra key that didn't belong (#3362 )	2018-07-09 18:07:20 -07:00
mxss_frontled.h
mxss.c	Fixed issues with MxSS RGB functionality (#3341 )	2018-07-08 04:50:55 -07:00
mxss.h	MxSS refactor and Configurator bugfix (#3355 )	2018-07-09 07:49:11 -07:00
readme.md	Modified URLs to point to new locations	2019-01-13 09:11:18 -08:00
rgblight.c	Change rgblight_get_mode & rgb_matrix_get_mode's return type to uint8_t. (#4747 )	2018-12-31 08:42:58 -08:00
rgblight.h	Moving rgb typedefs into a single location (#5978 )	2019-06-04 11:04:30 -07:00
rules.mk	Remove commented out MCUs in rules.mk (#5884 )	2019-07-16 00:26:38 -07:00

readme.md

MxSS - Polycarb 65% Kit for MX/SMK

Information:

Case: Frosted Polycarbonate, CNC milled
Plate: Brass, mirror-finished and electroplated
Weight: Same as plate
PCB: Custom designed for the MxSS by kawasaki161, White solder mask and ENIG finish

Details:

2.9 degrees angle on the case
Top mount plate
Center USB, Type-B Mini
MX and SMK (White and Orange) switch support
Holtite support
RGB underglow
1.5kg with plate and weight

Keyboard Maintainer: MxBlue

Hardware Supported: Custom PCB, ATMega32u4

Hardware Availability: https://geekhack.org/index.php?topic=94986.0

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

make mxss:default

See build environment setup then the make instructions for more information.

Front LED Operation

The MxSS PCB has 2 front RGB LEDs which has a separate brightness and mode of operation to the rest of the RGB LEDs. These are controlled through the supplied custom keycodes.

There are 3 modes of operation:

FLED_OFF - Front LEDs stay off
FLED_RGB - Front LEDs are part of the standard RGB LED modes, only works correctly with rainbow modes (will fix on request)
FLED_INDI - Top front LED represents Caps Lock status, bottom LED represents current layer

Colors for FLED_INDI mode are hardcoded as hue/saturation values, the caps lock color can be found in mxss_frontled.h, the layer colors are defined in keymap.c (see default/keymap.c for example).

Custom Keycodes

FLED_MOD - Cycle between the 3 modes (FLED_OFF -> FLED_RGB -> FLED_INDI)
FLED_VAI - Increase front LED brightness
FLED_VAD - Decrease front LED brightness

Further Notes

As SAFE_RANGE is used for defining the custom keycodes seen above, please use NEW_SAFE_RANGE as the starting value for any custom keycodes in keymap.c, as per the example.