Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 2.33 KB

README.md

File metadata and controls

37 lines (25 loc) · 2.33 KB
Raw

Custom Weekin-Y40 Firmware

This is custom firmware for Weekin-Y40 DIY keyboard. Author didn't provide QMK configuration source code which was limiting customization with only VIA capabilities. I developed custom firmware to get much more flexible customization through QMK configuration. It also supports VIAL now.

image

Setup

Prerequisites:

  • Setup QMK environment according to guides provided on official website
  • Optional: Install or open web version of VIA if you want to use both QMK and VIA customization

Steps:

  • Copy weekin directory to QMK keyboards directory
  • Build with qmk compile -kb weekin/y40 -km default command or with qmk compile -kb weekin/y40 -km via command for VIA support. Alternatively, you can build Bongo Cat version with qmk compile -kb weekin/y40 -km bongocat, but VIA will be disabled due to limited MCU memory.
  • Flash firmware from .build directory following instructions provided with Weekin-Y40 kit. Note: you can also build and flash firmware from comand line by replacing qmk compile with qmk flash in previous step commands.
  • Optional: Load weekin_y40_v3_custom.json into VIA following instructions provided with Weekin-Y40 kit
  • If everything went fine, now you can make your own customization, rebuild and reflash QMK firmware

VIAL Support

This firmware configuration has limited VIAL support. Due to small MCU memory QMK configuration, Key Overrides and RGB lights are disabled. In order to flash VIAL firmware, perform following steps:

  • Setup VIAL QMK environment according to guides provided on official website
  • Install or open web version of VIAL
  • Copy weekin directory to VIAL QMK keyboards directory
  • Go to VIAL QMK root directory and build firmware with make weekin/y40:vial command
  • Flash firmware from .build directory following instructions provided with Weekin-Y40 kit
  • If everything went fine, now you can enjoy VIAL GUI configuration capabilities

Useful links