keyboards/mxss/readme.md

   1 # MxSS - Polycarb 65% Kit for MX/SMK
   2
   3 ![MxSS - Polycarb 65% Kit for MX/SMK](https://i.imgur.com/WDTWcmU.jpg)
   4
   5 ### Information:
   6
   7  - Case: Frosted Polycarbonate, CNC milled
   8  - Plate: Brass, mirror-finished and electroplated
   9  - Weight: Same as plate
  10  - PCB: Custom designed for the MxSS by kawasaki161, White solder mask and ENIG finish
  11
  12 ### Details:
  13
  14  - 2.9 degrees angle on the case
  15  - Top mount plate
  16  - Center USB, Type-B Mini
  17  - MX and SMK (White and Orange) switch support
  18  - Holtite support
  19  - RGB underglow
  20  - 1.5kg with plate and weight
  21
  22 Keyboard Maintainer: [MxBlue](https://github.com/mxblu)
  23
  24 Hardware Supported: Custom PCB, ATMega32u4
  25
  26 Hardware Availability: https://geekhack.org/index.php?topic=94986.0
  27
  28 Make example for this keyboard (after setting up your build environment):
  29
  30     make mxss:default
  31
  32 See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
  33
  34 # Front LED Operation
  35
  36 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.
  37
  38 There are 3 modes of operation:
  39
  40  - FLED_OFF - Front LEDs stay off
  41  - FLED_RGB - Front LEDs are part of the standard RGB LED modes, only works correctly with rainbow modes (will fix on request)
  42  - FLED_INDI - Top front LED represents Caps Lock status, bottom LED represents current layer
  43
  44 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).
  45
  46 ## Custom Keycodes
  47
  48  - FLED_MOD - Cycle between the 3 modes (FLED_OFF -> FLED_RGB -> FLED_INDI)
  49  - FLED_VAI - Increase front LED brightness
  50  - FLED_VAD - Decrease front LED brightness
  51
  52  # Further Notes
  53
  54  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.