This is the ZMK module for the Visorbearer keyboard, a 32-key unibody split wireless keyboard featuring 8 RGB LED indicators.

Add these lines to config/west.yml in your zmk-config repository:

manifest:
  remotes:
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
    - name: carrefinho                            # <---
      url-base: https://github.com/carrefinho     # <---
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    - name: zmk-keyboards-visorbearer             # <---
      repo-path: visorbearer-zmk-module           # <---
      remote: carrefinho                          # <---
      revision: main                              # <---
  self:
    path: config

Then add the visorbearer shield to your build.yaml:

---
include:
  - board: xiao_ble//zmk
    shield: visorbearer
    snippet: studio-rpc-usb-uart
  - board: xiao_ble//zmk
    shield: settings_reset

For more information on ZMK Modules and building locally, see the ZMK docs page on modules.

Visorbearer features two RGB LED bars with four segments each:

Connection Bar (left):

• Upon Bluetooth events or behavior:
  • White: Connected Bluetooth profile
  • Cyan (Breathing): Paired but not connected
  • Yellow (Breathing): Open profile, advertising
• When idle:
  • Dim White: Active modifier keys (order configurable, default: Shift/Ctrl/Alt/GUI)

Battery Bar (right):

• White: Normal battery
• Yellow: Low battery
• Red: Critical battery
• Green: Charging

Add #include <behaviors/visorbearer_led.dtsi> to the top of your keymap file to use the following behaviors and macros.

Two behaviors are available to trigger LED indications on demand:

&vb_ind_bat    // Show battery status when pressed
&vb_ind_con    // Show connection status when pressed

Use these macros to trigger LED indications when selecting/clearing BT profiles:

&vb_bt_sel 0   // Select BT profile 0 and show connection status
&vb_bt_sel 1   // Select BT profile 1 and show connection status
&vb_bt_sel 2   // Select BT profile 2 and show connection status
&vb_bt_sel 3   // Select BT profile 3 and show connection status
&vb_bt_clr     // Clear current BT profile and show connection status

A custom soft-off behavior with LED animation:

&vb_soft_off   // Enter soft-off mode with LED sweep animation

Customize LED behavior by adding options to your config/visorbearer.conf file:

# Animation speeds (higher = faster)
CONFIG_VISORBEARER_LED_FADE_STEP_SIZE=8
CONFIG_VISORBEARER_LED_BREATH_STEP_SIZE=3

# Display timing (milliseconds)
CONFIG_VISORBEARER_LED_EVENT_DISPLAY_TIME_MS=3000
CONFIG_VISORBEARER_LED_STARTUP_DISPLAY_TIME_MS=6000

# Battery thresholds (percentage)
CONFIG_VISORBEARER_LED_BATTERY_CRITICAL_THRESHOLD=8
CONFIG_VISORBEARER_LED_BATTERY_LOW_THRESHOLD=15

# Modifier display
CONFIG_VISORBEARER_LED_SHOW_MODIFIERS=y                 # Enable/disable modifier display
CONFIG_VISORBEARER_LED_MODIFIER_ORDER="SCAG"            # Customize modifier order: S=Shift, C=Ctrl, A=Alt, G=GUI

See Kconfig for all available configuration options.