"Error: Failed to locate keymap" file with custom keymap

[sommerper]

Sorry to bother you again. I'm almost afraid to ask why this isn't working because I actually had it working until I decided to rename the files. But renaming them back didn't help and I've been at it for hours.

When I run the command

just build myboard -b nice_nano

I get the error Failed to locate keymap file!

just build myboard -b nice_nano
Setting MAX_COMBOS_PER_KEY to 6
Setting MAX_KEYS_PER_COMBO to 3
Building firmware for myboard...
-- west build: generating a build system
Loading Zephyr default modules (Zephyr base (cached)).
-- Application: /home/ps/dev/github/zmk-config-2/zmk/app
-- CMake version: 3.31.4
-- Cache files will be written to: /home/ps/.cache/zephyr
-- Zephyr version: 3.5.0 (/home/ps/dev/github/zmk-config-2/zephyr)
-- Found west (found suitable version "1.3.0", minimum required is "0.14.0")
-- ZMK Config directory: /home/ps/dev/github/zmk-config-2/config
CMake Warning at keymap-module/modules/modules.cmake:220 (message):
  Failed to locate keymap file!
Call Stack (most recent call first):
  /home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/zephyr_module.cmake:130 (include)
  /home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/zephyr_default.cmake:129 (include)
  /home/ps/dev/github/zmk-config-2/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:66 (include)
  /home/ps/dev/github/zmk-config-2/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:97 (include_boilerplate)
  CMakeLists.txt:9 (find_package)


-- Board: nice_nano
-- Found host-tools: zephyr 0.16.3 (/home/ps/zephyr-sdk-0.16.3)
-- Found toolchain: zephyr 0.16.3 (/home/ps/zephyr-sdk-0.16.3)
-- Found BOARD.dts: /home/ps/dev/github/zmk-config-2/zmk/app/boards/arm/nice_nano/nice_nano.dts
-- Generated zephyr.dts: /home/ps/dev/github/zmk-config-2/.build/myboard/zephyr/zephyr.dts
-- Generated devicetree_generated.h: /home/ps/dev/github/zmk-config-2/.build/myboard/zephyr/include/generated/devicetree_generated.h
-- Including generated dts.cmake file: /home/ps/dev/github/zmk-config-2/.build/myboard/zephyr/dts.cmake

warning: Deprecated symbol NRF_STORE_REBOOT_TYPE_GPREGRET is enabled.

Parsing /home/ps/dev/github/zmk-config-2/zmk/app/Kconfig
Loaded configuration '/home/ps/dev/github/zmk-config-2/.build/myboard/zephyr/.config'
No change to configuration in '/home/ps/dev/github/zmk-config-2/.build/myboard/zephyr/.config'
No change to Kconfig header in '/home/ps/dev/github/zmk-config-2/.build/myboard/zephyr/include/generated/autoconf.h'
CMake Warning at /home/ps/dev/github/zmk-config-2/zephyr/CMakeLists.txt:887 (message):
  No SOURCES given to Zephyr library: drivers__kscan

  Excluding target from build.

As if my keymap file isn't there.

But it should be:

build.yaml

---
include:
  - board: planck_rev6
  - board: corneish_zen_v2_left
  - board: corneish_zen_v2_right
  - board: glove80_lh
  - board: glove80_rh
  - board: myboard

I'm kinda lost on this one, and it's probably something really stupid.

The other boards in the list work just fine.

I've made sure the file names are correct and did a few just clean-all and just install inbetween and it just wont work anymore.

[sommerper]

Not entirely sure what's going on but I found out how to fix it.

When I add a new board / rename an existing one I have to call:

just build my_new_board

before I call

just build my_new_board -b nice_nano

or else it will keep failing.

[urob]

Are you sure your build.yaml is specified correctly? From your other comment it sounds like myboard is actually a shield and nice_nano is your board. In that case, you would want to have:

# build.yaml
include:
  - board: nice_nano
    shield: myboard

Regarding your observation that just build my_new_board -b nice_nano works. Internally, when you call just build, it will parse build.yaml and call

west build -b $board ...

where $board is the value specified for board in build.yaml. Additional parameters (like your -b) are passed through as is. So in your case, calling just build myboard -b nice_nano will resolve to

west build -b mybord -b nice_nano

My guess the reason it works is that the second -b spec overwrites the first, though I am not sure if the resulting build is what you'd expect... Subsequent calls may work due to caching (though probably break when you add -p to do a pristine build). In either case, you'd probably be better off fixing your build.yaml.

[sommerper]

I did try that actually but I couldn't get it to work. I think it's because I'm not extending an existing shield in zmk. It's a pcb I made myself. As far as I can see the keyboards in your config are all already defined in zmk itself.

If my config looks like this

---
include:
  - board: planck_rev6
  - board: corneish_zen_v2_left
  - board: corneish_zen_v2_right
  - board: glove80_lh
  - board: glove80_rh
  - board: nice_nano
    shield: framework_v1

Keyboard is called framework_v1 now.

And I do a clean and build like this:

just clean && just build framework_v1

I get an error:

✖ just clean && just build framework_v1
rm -rf /home/ps/dev/github/zmk-config-2/.build /home/ps/dev/github/zmk-config-2/firmware
Setting MAX_COMBOS_PER_KEY to 6
Setting MAX_KEYS_PER_COMBO to 3
Building firmware for framework_v1-nice_nano...
-- west build: generating a build system
Loading Zephyr default modules (Zephyr base).
-- Application: /home/ps/dev/github/zmk-config-2/zmk/app
-- CMake version: 3.31.4
-- Found Python3: /usr/bin/python3 (found suitable version "3.13.2", minimum required is "3.8") found components: Interpreter
-- Cache files will be written to: /home/ps/.cache/zephyr
-- Zephyr version: 3.5.0 (/home/ps/dev/github/zmk-config-2/zephyr)
-- Found west (found suitable version "1.3.0", minimum required is "0.14.0")
-- ZMK Config directory: /home/ps/dev/github/zmk-config-2/config
-- ZMK Config devicetree overlay: /home/ps/dev/github/zmk-config-2/config/framework_v1.overlay
-- ZMK Config Kconfig: /home/ps/dev/github/zmk-config-2/config/framework_v1.conf
-- Using keymap file: /home/ps/dev/github/zmk-config-2/config/framework_v1.keymap
-- Board: nice_nano
-- Shield(s): framework_v1
No shield named 'framework_v1' found
Please choose from among the following shields:
a_dux_left
a_dux_right
adafruit_2_8_tft_touch_v2
adafruit_2_8_tft_touch_v2_nano
adafruit_can_picowbell
adafruit_data_logger
adafruit_pca9685
adafruit_winc1500
amg88xx_eval_kit
amg88xx_grid_eye_eval_shield
arceli_eth_w5500
arduino_uno_click
atmel_rf2xx
atmel_rf2xx_arduino
atmel_rf2xx_legacy
atmel_rf2xx_mikrobus
atmel_rf2xx_xplained
atmel_rf2xx_xpro
bat43
bfo9000_left
bfo9000_right
boardsource3x4
boardsource5x12
boostxl_ulpsense
buydisplay_2_8_tft_touch_arduino
buydisplay_3_5_tft_touch_arduino
chalice
clog_left
clog_right
clueboard_california
contra
corne_left
corne_right
cradio_left
cradio_right
crbn
dac80508_evm
dfrobot_can_bus_v2_0
eek
elephant42_left
elephant42_right
ergodash_left
ergodash_right
esp_8266
esp_8266_arduino
esp_8266_mikrobus
eternal_keypad
eternal_keypad_lefty
fourier_left
fourier_right
frdm_cr20a
frdm_kw41z
frdm_stbc_agm01
ftdi_vm800c
g1120b0mipi
helix_left
helix_right
hummingbird
inventek_eswifi
inventek_eswifi_arduino_spi
inventek_eswifi_arduino_uart
iris_left
iris_right
jian_left
jian_right
jiran_left
jiran_right
jorne_left
jorne_right
keyestudio_can_bus_ks0411
knob_goblin
kyria_left
kyria_rev2_left
kyria_rev2_right
kyria_rev3_left
kyria_rev3_right
kyria_right
leeloo_left
leeloo_micro_left
leeloo_micro_right
leeloo_rev2_left
leeloo_rev2_right
leeloo_right
lily58_left
lily58_right
link_board_eth
lmp90100_evb
lotus58_left
lotus58_right
ls013b7dh03
m60
max7219_8x8
microdox_left
microdox_right
microdox_v2_left
microdox_v2_right
mikroe_adc_click
mikroe_eth_click
mikroe_mcp2518fd_click
mikroe_wifi_bt_click
mikroe_wifi_bt_click_arduino
mikroe_wifi_bt_click_mikrobus
minivan_studio_tester
murphpad
naked60
nibble
nice_view
nice_view_adapter
npm1100_ek
npm1300_ek
npm6001_ek
osprette
pancake
posix_pro_micro
posix_seeed_xiao
qaz
quefrency_left
quefrency_right
redox_left
redox_right
reviung34
reviung41
reviung5
reviung53
rk055hdmipi4m
rk055hdmipi4ma0
romac
romac_plus
semtech_sx1262mb2das
semtech_sx1272mb2das
semtech_sx1276mb1mas
settings_reset
sh1106_128x64
snap_left
snap_right
sofle_left
sofle_right
sparkfun_max3421e
sparkfun_sara_r4
splitkb_aurora_corne_left
splitkb_aurora_corne_right
splitkb_aurora_helix_left
splitkb_aurora_helix_right
splitkb_aurora_lily58_left
splitkb_aurora_lily58_right
splitkb_aurora_sofle_left
splitkb_aurora_sofle_right
splitkb_aurora_sweep_left
splitkb_aurora_sweep_right
splitreus62_left
splitreus62_right
ssd1306_128x32
ssd1306_128x64
ssd1306_128x64_spi
st7735r_ada_160x128
st7789v_tl019fqv01
st7789v_waveshare_240x240
st_b_lcd40_dsi1_mb1166
tcan4550evm
tester_pro_micro
tester_xiao
tg4x
ti_bp_bassensorsmkii
tidbit
two_percent_milk
v2c_daplink
v2c_daplink_cfg
waterfowl_left
waterfowl_right
waveshare_epaper_gdeh0154a07
waveshare_epaper_gdeh0213b1
waveshare_epaper_gdeh0213b72
waveshare_epaper_gdeh029a1
waveshare_epaper_gdew042t2
waveshare_epaper_gdew042t2-p
waveshare_epaper_gdew075t7
wnc_m14a2a
x_nucleo_53l0a1
x_nucleo_eeprma2
x_nucleo_idb05a1
x_nucleo_iks01a1
x_nucleo_iks01a2
x_nucleo_iks01a2_shub
x_nucleo_iks01a3
x_nucleo_iks01a3_shub
x_nucleo_iks02a1
x_nucleo_iks02a1_mic
x_nucleo_iks02a1_shub
zmk_uno
zmk_uno_split_left
zmk_uno_split_right
zodiark_left
zodiark_right
CMake Error at /home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/shields.cmake:140 (message):
  Invalid SHIELD; see above.
Call Stack (most recent call first):
  /home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/zephyr_default.cmake:129 (include)
  /home/ps/dev/github/zmk-config/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:66 (include)
  /home/ps/dev/github/zmk-config/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:92 (include_boilerplate)
  CMakeLists.txt:9 (find_package)


-- Configuring incomplete, errors occurred!
FATAL ERROR: command exited with status 1: /home/ps/.local/bin/cmake -DWEST_PYTHON=/usr/bin/python3 -B/home/ps/dev/github/zmk-config-2/.build/framework_v1-nice_nano -GNinja -DBOARD=nice_nano -DZMK_CONFIG=/home/ps/dev/github/zmk-config-2/config -DSHIELD=framework_v1 -S/home/ps/dev/github/zmk-config-2/zmk/app
error: Recipe `_build_single` failed with exit code 1
error: Recipe `build` failed with exit code 1

I think this might also be the reason why I the bluetooth isn't working because the kconfig files are not in there.

I still have to figure out how to put them there.

If I use my old zmk installation which is in fact a fork of your https://github.com/urob/zmk repo I would just throw the shield config inside the zmk folder like so:

And it would work out of the box with bluetooth when I make a build with

west build -p -b nice_nano -- -DSHIELD=framework_v1

But I'm trying to get away from just throwing the configs inside zmk because the fork is so old now I'm having trouble updating to the latest version. Too many conflicts.

But maybe it makes more sense to build my own config based on ideas from yours instead of trying to force my usecase onto this one?

Thanks for taking the time btw!

[urob]

To rule out that this is an issue caused by just build (which is just a wrapper around west build), you could try running the west build directly.

Specifically, with your updated build.yaml, running just build frame will expand to:

west build -s zmk/app -b nice_nano -- -DZMK_CONFIG="$(realpath config)" -DSHIELD=framework_v1

(which just runs always from the repo root even if the working dir is nested deeper).

Two things to check:

• For this to work, zmk and config must be nested underneath the root of your zmk workspace (just runs always from the repo root even if the working dir is nested deeper):

zmk-workspace
├── config
└── zmk
    └── ...

If your directory structure differs, you must change the command accordingly.

• The firmware files for your board aren't specified/located where zmk expects them. If the rest looks correct, you might want to double check the zmk documentation on that.

[sommerper]

I haven't changed the structure after forking - if that's what you mean.

When running the command

west build -s zmk/app -b nice_nano -- -DZMK_CONFIG="/home/ps/dev/github/zmk-config-2/config" -DSHIELD=framework_v1

I still get the error:

Expand

ps@fw16 🏠 zmk-config-2  main 📝×2 🛤×4
❯ west build -s zmk/app -b nice_nano -- -DZMK_CONFIG="/home/ps/dev/github/zmk-config-2/config" -DSHIELD=framework_v1
-- west build: generating a build system
Loading Zephyr default modules (Zephyr base (cached)).
-- Application: /home/ps/dev/github/zmk-config-2/zmk/app
-- CMake version: 3.31.4
-- Cache files will be written to: /home/ps/.cache/zephyr
-- Zephyr version: 3.5.0 (/home/ps/dev/github/zmk-config-2/zephyr)
-- Found west (found suitable version "1.3.0", minimum required is "0.14.0")
CMake Warning at keymap-module/modules/modules.cmake:31 (message):
The build directory must be cleaned pristinely when changing user ZMK
config
Call Stack (most recent call first):
/home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/zephyr_module.cmake:130 (include)
/home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/zephyr_default.cmake:129 (include)
/home/ps/dev/github/zmk-config-2/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:66 (include)
/home/ps/dev/github/zmk-config-2/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:97 (include_boilerplate)
CMakeLists.txt:9 (find_package)


-- ZMK Config directory: /home/ps/dev/github/zmk-config-2
-- Using keymap file: /home/ps/dev/github/zmk-config-2/boards/shields/framework_v1/framework_v1.keymap
-- Board: nice_nano
-- Shield(s): framework_v1
No shield named 'framework_v1' found
Please choose from among the following shields:
a_dux_left
a_dux_right
adafruit_2_8_tft_touch_v2
adafruit_2_8_tft_touch_v2_nano
adafruit_can_picowbell
adafruit_data_logger
adafruit_pca9685
adafruit_winc1500
amg88xx_eval_kit
amg88xx_grid_eye_eval_shield
arceli_eth_w5500
arduino_uno_click
atmel_rf2xx
atmel_rf2xx_arduino
atmel_rf2xx_legacy
atmel_rf2xx_mikrobus
atmel_rf2xx_xplained
atmel_rf2xx_xpro
bat43
bfo9000_left
bfo9000_right
boardsource3x4
boardsource5x12
boostxl_ulpsense
buydisplay_2_8_tft_touch_arduino
buydisplay_3_5_tft_touch_arduino
chalice
clog_left
clog_right
clueboard_california
contra
corne_left
corne_right
cradio_left
cradio_right
crbn
dac80508_evm
dfrobot_can_bus_v2_0
eek
elephant42_left
elephant42_right
ergodash_left
ergodash_right
esp_8266
esp_8266_arduino
esp_8266_mikrobus
eternal_keypad
eternal_keypad_lefty
fourier_left
fourier_right
frdm_cr20a
frdm_kw41z
frdm_stbc_agm01
ftdi_vm800c
g1120b0mipi
helix_left
helix_right
hummingbird
inventek_eswifi
inventek_eswifi_arduino_spi
inventek_eswifi_arduino_uart
iris_left
iris_right
jian_left
jian_right
jiran_left
jiran_right
jorne_left
jorne_right
keyestudio_can_bus_ks0411
knob_goblin
kyria_left
kyria_rev2_left
kyria_rev2_right
kyria_rev3_left
kyria_rev3_right
kyria_right
leeloo_left
leeloo_micro_left
leeloo_micro_right
leeloo_rev2_left
leeloo_rev2_right
leeloo_right
lily58_left
lily58_right
link_board_eth
lmp90100_evb
lotus58_left
lotus58_right
ls013b7dh03
m60
max7219_8x8
microdox_left
microdox_right
microdox_v2_left
microdox_v2_right
mikroe_adc_click
mikroe_eth_click
mikroe_mcp2518fd_click
mikroe_wifi_bt_click
mikroe_wifi_bt_click_arduino
mikroe_wifi_bt_click_mikrobus
minivan_studio_tester
murphpad
naked60
nibble
nice_view
nice_view_adapter
npm1100_ek
npm1300_ek
npm6001_ek
osprette
pancake
posix_pro_micro
posix_seeed_xiao
qaz
quefrency_left
quefrency_right
redox_left
redox_right
reviung34
reviung41
reviung5
reviung53
rk055hdmipi4m
rk055hdmipi4ma0
romac
romac_plus
semtech_sx1262mb2das
semtech_sx1272mb2das
semtech_sx1276mb1mas
settings_reset
sh1106_128x64
snap_left
snap_right
sofle_left
sofle_right
sparkfun_max3421e
sparkfun_sara_r4
splitkb_aurora_corne_left
splitkb_aurora_corne_right
splitkb_aurora_helix_left
splitkb_aurora_helix_right
splitkb_aurora_lily58_left
splitkb_aurora_lily58_right
splitkb_aurora_sofle_left
splitkb_aurora_sofle_right
splitkb_aurora_sweep_left
splitkb_aurora_sweep_right
splitreus62_left
splitreus62_right
ssd1306_128x32
ssd1306_128x64
ssd1306_128x64_spi
st7735r_ada_160x128
st7789v_tl019fqv01
st7789v_waveshare_240x240
st_b_lcd40_dsi1_mb1166
tcan4550evm
tester_pro_micro
tester_xiao
tg4x
ti_bp_bassensorsmkii
tidbit
two_percent_milk
v2c_daplink
v2c_daplink_cfg
waterfowl_left
waterfowl_right
waveshare_epaper_gdeh0154a07
waveshare_epaper_gdeh0213b1
waveshare_epaper_gdeh0213b72
waveshare_epaper_gdeh029a1
waveshare_epaper_gdew042t2
waveshare_epaper_gdew042t2-p
waveshare_epaper_gdew075t7
wnc_m14a2a
x_nucleo_53l0a1
x_nucleo_eeprma2
x_nucleo_idb05a1
x_nucleo_iks01a1
x_nucleo_iks01a2
x_nucleo_iks01a2_shub
x_nucleo_iks01a3
x_nucleo_iks01a3_shub
x_nucleo_iks02a1
x_nucleo_iks02a1_mic
x_nucleo_iks02a1_shub
zmk_uno
zmk_uno_split_left
zmk_uno_split_right
zodiark_left
zodiark_right
CMake Error at /home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/shields.cmake:140 (message):
Invalid SHIELD; see above.
Call Stack (most recent call first):
/home/ps/dev/github/zmk-config-2/zephyr/cmake/modules/zephyr_default.cmake:129 (include)
/home/ps/dev/github/zmk-config-2/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:66 (include)
/home/ps/dev/github/zmk-config-2/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:97 (include_boilerplate)
CMakeLists.txt:9 (find_package)


-- Configuring incomplete, errors occurred!
FATAL ERROR: command exited with status 1: /home/ps/.local/bin/cmake -DWEST_PYTHON=/usr/bin/python3 -B/home/ps/dev/github/zmk-config-2/build -GNinja -DZMK_CONFIG=/home/ps/dev/github/zmk-config-2/config -DSHIELD=framework_v1 -S/home/ps/dev/github/zmk-config-2/zmk/app

But if I move my config into boards/shields/framework_v1 it works with the command west build -s zmk/app -b nice_nano -- -DZMK_CONFIG="/home/ps/dev/github/zmk-config-2" -DSHIELD=framework_v1

[urob]

It sounds like it is the latter issue then.

The firmware files for your board aren't specified/located where zmk expects them. If the rest looks correct, you might want to double check the zmk documentation on that.