Skip to content
This repository has been archived by the owner on May 5, 2024. It is now read-only.

Building and flashing

Gal Zaidenstein edited this page Apr 22, 2019 · 7 revisions

1. Setting up ESP-IDF:

In order to flash your controller, first set up ESP-IDF

2. Cloning MK32:

After you have ESP-IDF set up, clone the MK32 repository to your esp folder:
cd ~/esp/
git clone --recursive https://github.com/Galzai/MK32

3. Before flashing your controller

After cloning the repository, you can customize your keyboard (please refer to the different options in the Wiki's home page).
Before flashing your controller, first set up keyboard_config.h:

**Note: For split keyboards first read how to properly define them.

For non split keyboards with ESPNOW:

  • Make sure to uncomment:

    • #define MASTER
    • If your keyboard uses an encoder uncomment #define R_ENCODER
  • Make sure to comment:

    • #define SPLIT_MASTER
    • #define SLAVE
    • #define R_ENCODER_SLAVE.

For split keyboards "master pad":

  • Make sure to uncomment:

    • #define MASTER
    • #define SPLIT_MASTER
    • If your master pad uses an encoder uncomment #define R_ENCODER
  • Make sure to comment:

    • #define SLAVE
    • #define R_ENCODER_SLAVE

For split keyboards "slave pad":

  • Make sure to uncomment:

    • #define SLAVE
    • #define R_ENCODER_SLAVE
  • Make sure to comment:

    • #define MASTER
    • #define SPLIT_MASTER
    • #define R_ENCODER

4. Flashing your controller

In order to flash your controller

  1. First check the which serial port your controller is connected to.

  2. navigate to to your MK32-master folder:
    cd ~/esp/MK32-master

  3. Flash
    make flash ESPPORT= [/dev/tty/USB0]<- Example serial port

**Note: You can use the serial monitor by entering make monitor.

For more information regarding flashing and you can visit the ESP-IDF programming guide .