Skip to content

Latest commit

 

History

History
256 lines (203 loc) · 8.44 KB

DEVELOPMENT.md

File metadata and controls

256 lines (203 loc) · 8.44 KB
Raw

Developing ARDUX for QMK

Work In Progress

The below is a work in progress. Don't be surprised if there are quirks in the information provided below. PRs are welcome.

Compiling

You must run qmk setup for any builds to work!!!!

If your qmk_firmware repository is NOT located under ~/qmk_firmware, you may encounter qmk build issue. In such case, try moving the repository or adding a symlink, then retry compiling.

Your qmk_firmware repository should ALSO be on the 0.18.5 branch of QMK. Newer updates will cause errors when compiling.

ln -s your_path_to_repos/qmk_firmware ~/qmk_firmware

If these commands don't work, please ensure you've completed all steps per the QMK docs.

cd /qmk_firmware/users/ardux
# ALLOW_WARNINGS is a required argument as of QMK 0.18. Otherwise warnings will kill your build
# ARDUX_SIZE is a required argument
# ARDUX_HAND is a required argument
# ARDUX_OLED_BOOT_LOGO is an optional argument. default: yes
# ARDUX_BOOT_LOGO_TIMEOUT is an optional timeout in miliseconds. default: 2000
# ARDUX_OLED_ICON is an optional icon to show on the status pages. default: badslime_1
# ARDUX_PIMORONI is an option to turn on Pimoroni mini trackball support. default: no
# OLED_ENABLE turn on/off oled. default yes if main keybord project supports oled
# OLED_BRIGHTNESS the brightness of the oled at startup if no user values set. default: 127 (50% brightness)
# ARDUX_40P_ANSI_BACKSPACE enable or disable backspace on ansi 40% layer. default: off ; is a common letter combo that will be an issue for fast typists
# ARDUX_40P_ANSI_DELETE enable or disable delete on ansi 40% layer. default: off ; is a common letter combo that will be an issue for fast typists
# PIMORONI_BRIGHTNESS the brightness of the pimoroni trackball at startup if no user values set. default: 127 (50% brightness)
# PIMORONI_RGBW the rgb code for the pimoroni trackball at startup if no user values set. default: 255,255,255 (white)
# TAPPING_TERM the timeout for tap dances (40% ardux only). in miliseconds ; default: 175
#     this is DISABLED for the gergo due to the gergo forcing a 200ms duration per the main keyboard/config.h file
# COMBO_TERM the timeout for combos (all ardux variations). in miliseconds ; default 250
# ONESHOT_TAP_TOGGLE the number of times to tap to toggle a one shot key ; default 5
# ONESHOT_TIMEOUT the length of time a one shot key is active for. in miliseconds ; default 1500
# ENCODER_ENABLE whether or not to include encoder support. default: no ; uses just over 1k of rom space which is quite large
# RGBLIGHT_ENABLE whether or not to turn on some underglow features. default: no ; uses a TON of rom space and we need a lot for 40% ardux to work
# SPLIT_USB_DETECT use this option (see kemo builds) when using an unmodified miranda or old elite-c
qmk -v compile -e ALLOW_WARNINGS=yes
               -e ARDUX_SIZE=[std|big|40p] \
               -e ARDUX_HAND=[left|right] \
               -e ARDUX_OLED_BOOT_LOGO=[yes|no] \
               -e ARDUX_BOOT_LOGO_TIMEOUT=[ms] \
               -e ARDUX_OLED_ICON=[badslime_1|badslime_2] \
               -e ARDUX_PIMORONI=[yes|no] \
               -e ARDUX_40P_ANSI_BACKSPACE=[yes|no] \
               -e ARDUX_40P_ANSI_DELETE=[yes|no] \
               -e OLED_ENABLE=[yes|no] \
               -e OLED_BRIGHTNESS=[0...255] \
               -e PIMORONI_BRIGHTNESS=[0...255] \
               -e PIMORONI_RGB="255,255,255" \
               -e TAPPING_TERM=175 \
               -e COMBO_TERM=250 \
               -e ONESHOT_TAP_TOGGLE=5 \
               -e ONESHOT_TIMEOUT=1500 \
               -e ENCODER_ENABLE=[yes|no] \
               -e RGBLIGHT_ENABLE=[yes|no] \
       layout/[board.json]

MelMicro

An unmodified MelMicro and some knock off ProMicro boards require -e SPLIT_USB_DETECT=yes in order to function properly with 40% ARDUX and QMK.

KemoNine Builds

root@d8949d0fe972:/qmk_firmware/users/ardux# 
# Corne (6 column) 40%
rm -rf ../../.build/* && qmk -v compile \
    -e SPLIT_USB_DETECT=yes \
    -e OLED_BRIGHTNESS=64 \
    -e PIMORONI_BRIGHTNESS=7 \
    -e PIMORONI_RGB="255,165,0" \
    -e ARDUX_PIMORONI=no \
    -e ARDUX_EXCLAMATION=KC_SCLN \
    -e ARDUX_SIZE=40p \
    -e ARDUX_HAND=left \
    -e TAPPING_TERM=200 \
    layout/crkbd_rev1_40p.json

# The Paintbrush
rm -rf ../../.build/* && qmk -v compile \
    -e OLED_BRIGHTNESS=64 \
    -e ARDUX_EXCLAMATION=KC_SCLN \
    -e ARDUX_SIZE=std \
    -e ARDUX_HAND=left \
    -e TAPPING_TERM=200 \
    layout/ardux_thepaintbrush.json

Minidox

# 40%
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=40p \
    -e ARDUX_HAND=left \
    layout/minidox_rev1_40p.json
    
# Big
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=big \
    -e ARDUX_HAND=left \
    layout/minidox_rev1.json

Microdox

# 40%
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=40p \
    -e ARDUX_HAND=left \
    layout/boardsource_microdox_40p.json
    
# Big
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=big \
    -e ARDUX_HAND=left \
    layout/boardsource_microdox.json

Soyuz

# Standard
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=std \
    -e ARDUX_HAND=left \
    layout/ai03_soyuz.json

Geekboards Macropad v2

# Standard
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=std \
    -e ARDUX_HAND=left \
    layout/geekboards_macropad_v2.json

Kyria rev2

# 40%
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=40p \
    -e ARDUX_HAND=left \
    layout/splitkb_kyria_rev2_40p.json
    
# Big
rm -rf ../../.build/* && qmk -v compile \
    -e ARDUX_SIZE=big \
    -e ARDUX_HAND=left \
    layout/splitkb_kyria_rev2.json

Flashing on Linux

You can use a command similar (double check the device node) to the following for avr+dfu setups. You'll need to run 'qmk -v flash' to find what flash commands it's running to avoid having to build in the future.

avrdude -pm32u4 -cavr109 -D -P/dev/ttyACM0 -b57600 -Uflash:w:ardux-ardux_thepaintbrush-std-left.hex

Remixing

Start with layouts/_layout.h and follow the code from there.

Combos

Per the docs at http://combos.gboards.ca/docs/combos/:

inject.h

Sometimes when you’re deep in combo shenanigans you need access to process_combo_event() that this decorator wraps. If you need to put something in there manually for debugging purposes or otherwise, create a file inject.h in your keymap directory. If this file exists all code in it will be inserted into process_combo_event()` after the decorator stuff.

Also see http://combos.gboards.ca/docs/combos/

Visual Studio Code

This repo is setup to allow doing local development using the Dev Containers features. If you're familiar with these features they should generally 'Just Work'.

Docker

Run

# PowerShell
#     Use ` instead of \
#     Use ${PWD} instead of $(pwd)
docker run --rm -it `
  -v qmk_firmware:/qmk_firmware `
  -v $(pwd)/.build:/qmk_firmware/.build `
  -v $(pwd)/users/ardux:/qmk_firmware/users/ardux `
  qmkfm/qmk_cli /bin/bash

Update / Clone Sources

# PowerShell
#     Use ` instead of \
docker run --rm -it \
  -v qmk_firmware:/qmk_firmware \
  qmkfm/qmk_cli /bin/bash

cd ~/qmk_firmware
if [ -d ~/qmk_firmware/.git ]; 
then 
    cd ~/qmk_firmware;
    git pull; 
else 
    git clone https://github.com/qmk/qmk_firmware.git ~/qmk_firmware/; 
fi
if [ ! -d ~/qmk_firmware/keyboards/ardux ];
then
    ln -s "~/qmk-ardux/keyboards/ardux" ~/qmk_firmware/keyboards/ardux;
    echo "Created keyboards/ardux symlink";
fi
if [ ! -d ~/qmk_firmware/keyboards/faunchpad ];
then
    ln -s "~/qmk_gboards/keyboards/faunchpad" ~/qmk_firmware/keyboards/faunchpad;
    echo "Created keyboards/faunchpad symlink";
fi
if [ ! -d ~/qmk_firmware/users/ardux ];
then
    ln -s "~/qmk-ardux/users/ardux" ~/qmk_firmware/users/ardux;
    echo "Created users/ardux symlink";
fi
qmk setup -y;

Volumes

QMK Sources

qmkfm/qmk_cli lacks sources. Use named volume to speed dev and output

ARDUX

Need to have the qmk/users/ardux directory mounted at /qmk_firmware/users/ardux in Docker container

Build output

Need to have a local dir for build artifact extraction at /qmk_firmware/.build