Dongle Display

This module repository provides a ZMK shield that replaces the built-in status screen with a custom screen designed for 128x64-pixel OLED displays.

Usage

To use this module, first add it to your config/west.yml by adding a new entry to remotes and projects:

manifest:
  remotes:
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
    - name: englmaxi
      url-base: https://github.com/englmaxi
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    - name: zmk-dongle-display
      remote: englmaxi
      revision: main
  self:
    path: config

Next, replace the built-in status screen by adding dongle_display to your build.yaml:

---
include:
  - board: seeeduino_xiao_ble
    shield: sweep_central_dongle dongle_display

This shield assumes that the dongle is already set up and functioning with the built-in status screen. For setup examples, refer to the shields in my zmk-config.

• If you are using the larger 1.3" OLED, replace solomon,ssd1306fb with sinowealth,sh1106 and set segment-offset = <2>.
• If you are using a nice!nano, replace xiao_i2c with pro_micro_i2c.

Widgets

• active hid indicators (CLCK, NLCK, SLCK)
• active modifiers
• bongo cat
• highest layer name
• output status
• peripheral battery levels

Configuration

To also display the battery level of the dongle/central device, use the following configuration property:

CONFIG_ZMK_DONGLE_DISPLAY_DONGLE_BATTERY=y

If you want to use MacOS modifier symbols instead of the Windows modifier symbols, use the following configuration property:

CONFIG_ZMK_DONGLE_DISPLAY_MAC_MODIFIERS=y

Demo

Dongle Designs

• case1
• case2
• Cyberdeck by @rafaelromao
• Dongle PCB by @spe2
• Macintosh by @rain2813
• Redox by @rurounikexin
• ZMK Display Dongle by @yingeling

Alternatives

• Prospector by @carrefinho