A system tray app to monitor the battery level of ZMK-based keyboards, built with Tauri v2.
- Display battery level for:
- Both central and peripheral sides of split keyboards
- Multiple keyboards simultaneously
- Supports macOS and Windows
- (Options)
- Push notifications when
- Keyboard battery level is low
- Keyboard is connected/disconnected
- Auto start at login
- Switch between light and dark themes
- Push notifications when
Download from Releases.
- Remove the app from quarantine by running the following command in the terminal:
sudo xattr -d com.apple.quarantine /path/to/zmk-battery-center.app # typically: sudo xattr -d com.apple.quarantine /Applications/zmk-battery-center.app
- Ensure your keyboard is connected to your computer via Bluetooth.
- Confirm your keyboard firmware includes the following ZMK configuration options:
See the ZMK Documentation about Bluetooth and about battery for more details.
CONFIG_BT_BAS=y CONFIG_ZMK_BATTERY_REPORTING=y # For split keyboards: CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING=y CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_PROXY=y - On macOS, make sure Bluetooth permission is granted to the app.
Window position may be misaligned if the OS has problems handling multiple monitors or you are using vertical taskbar on Windows.
You can manually move the window to the correct position to address this issue.
- Right click the tray icon
- Click
Control>Manual window positioningin the menu - Now you can grab the top of the window to move it to any position you like
Issues and PRs are appreciated.
README is in English, but it is OK to write issues or PRs in Japanese.
Also, if you like this software, please support the ZMK developer! https://opencollective.com/zmkfirmware
- Install Bun
- Install Rust
- Clone this repo
git clone https://github.com/kot149/zmk-battery-center.git cd zmk-battery-center - Install frontend dependencies
bun install
- Run in development mode
bun tauri dev
- Build for production
bun tauri build
- If build fails, try cleaning the build cache
cd src-tauri cargo clean cd ..
- If build fails, try cleaning the build cache
You can also build using GitHub Actions.
- ZMK PR #1243, #2045 — Implementation and discussion for split battery reporting over BLE GATT
- zmk-ble: Proof-of-concept system tray app for macOS (not compatible with latest macOS)
- Mighty-Mitts: System tray app for macOS
- zmk-split-battery: System tray app for Windows
- zmkBATx: System tray app for Linux