Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 3.47 KB

FIRMWARE.md

File metadata and controls

54 lines (34 loc) · 3.47 KB
Raw

FIRMWARE

My version of ZMK firmware with Github Actions pipeline is located here:

It has both encoders working, precise pulse per rotation adjustments and RGB enabled by default.

Config files for both QMK and ZMK can be found here:

For extra convienence if you intend to modify your firmware for a smaller layout, I have created a link to :

  • Added support for VIAL firmware for RP2040 boards. You can now compile :

    the "default" layout using QMK toolchain and the command :

         qmk compile -kb electronlab/klor -km default -c

    or "vial" layout using vial-qmk toolchain and the command :

         make clean && make electronlab/klor:vial

  • Also be aware that I have now enabled firmware based handedness definition (#define EE_HANDS setting) so you should flash the firmware using the following commands for left and right keyboard sides :

  • For QMK environment

           qmk flash -kb electronlab/klor -km default -c -bl uf2-split-left
       qmk flash -kb electronlab/klor -km default -c -bl uf2-split-right

    For VIAL-QMK environment

           qmk flash -kb electronlab/klor -km vial -c -bl uf2-split-left
       qmk flash -kb electronlab/klor -km vial -c -bl uf2-split-right

  • Make sure you switch your serial communication to HALF DUPLEX as software pin swap used for full duplex does not seem to work well with firmware based handedness detection. If you alyays want to plug one side of the keyboard then you can set the master side in config.h and switch to full duplex with software pin swap. This will require a little testing but it will work eventually

  • While playing with QMK I have noticed that the original 1.3 design carried a wiring flaw on the minijack footprint and PCB traces. The RX/TX are symetrical between the two sides which makes it impossible to define the transmission protocol in QMK as serial full duplex with RP2040 ProMicro boards if you don't specify a pin swap command. By default the stock firmware uses bitbang driver on a single pin which is not optimal and made the use of a TRRS link unnecessary as 3 pins cable would suffice. If you use these boards you should set the following in the config.h for QMK if using RP2040 ProMicro boards.

               //Full Duplex communication
           #define SERIAL_USART_TX_PIN GP4     // USART TX pin
           #define SERIAL_USART_RX_PIN GP1     // USART RX pin
           #define SERIAL_USART_FULL_DUPLEX
           #define SERIAL_USART_PIN_SWAP

  • In case your MCU can only use a single pin for communications, it is recommended to use half duplex serial instead of bitbang.

               //Half Duplex communication
           //#define SERIAL_USART_TX_PIN GP1     // USART TX pin

  • More about this matter here