Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 3.03 KB

README.md

File metadata and controls

80 lines (63 loc) · 3.03 KB
Raw

Prospector ZMK Module

All the necessary stuff for Prospector to display things with ZMK. Currently functional albeit barebones.

Features

  • Highest active layer roller
  • Peripheral battery bar
  • Peripheral connection status
  • Caps word indicator

Installation

Your ZMK keyboard should be set up with a dongle as central.

Add this module to your config/west.yml with these new entries under remotes and projects:

manifest:
  remotes:
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
    - name: carrefinho                            # <--- add this
      url-base: https://github.com/carrefinho     # <--- and this
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    - name: prospector-zmk-module                 # <--- and these
      remote: carrefinho                          # <---
      revision: main                              # <---
  self:
    path: config

Then add the prospector_adapter shield to the dongle in your build.yaml:

---
include:
  - board: seeeduino_xiao_ble
    shield: [YOUR KEYBOARD SHIELD]_dongle prospector_adapter

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

Usage

For split keyboards, since the peripheral battery widget uses the order in which peripherals were paired to arrange the sub-widgets, after flashing the dongle, pair the left side first and then the right side. For more than two peripherals, pair them in a left to right order.

The layer roller shows layers' display-name property whenever available, and will fall back to the layer index otherwise. To add a display-name property to a keymap layer:

keymap {
  compatible = "zmk,keymap";
  base {
    display-name = "Base";           # <--- add this
    bindings = <
      ...
    >;
  }
}

Configuration

To customize, add config options to your config/[YOUR KEYBOARD SHIELD].conf like so:

CONFIG_PROSPECTOR_USE_AMBIENT_LIGHT_SENSOR=n
CONFIG_PROSPECTOR_FIXED_BRIGHTESS=80

Available config options:

Name Description Default
CONFIG_PROSPECTOR_USE_AMBIENT_LIGHT_SENSOR Use ambient light sensor for auto brightness, set to n if building without one y
CONFIG_PROSPECTOR_FIXED_BRIGHTESS Set fixed display brightess when not using ambient light sensor 50 (1-100)
CONFIG_PROSPECTOR_PROSPECTOR_ROTATE_DISPLAY_180 Rotate the display 180 degrees n
CONFIG_PROSPECTOR_LAYER_ROLLER_ALL_CAPS Convert layer names to all caps n