diff options
Diffstat (limited to 'keyboards/mxss/readme.md')
| -rw-r--r-- | keyboards/mxss/readme.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/keyboards/mxss/readme.md b/keyboards/mxss/readme.md new file mode 100644 index 0000000000..54e07e27b0 --- /dev/null +++ b/keyboards/mxss/readme.md @@ -0,0 +1,54 @@ +# 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](https://github.com/mxblu) + +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](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) 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.
\ No newline at end of file |