https://github.com/mh4x0f/zmkbatx

Opensource tool for peripheral battery monitoring zmk split keyboard over BLE for linux
https://github.com/mh4x0f/zmkbatx

battery-level ble bluetooth-low-energy keyboard wireless zmk

Last synced: about 1 year ago
JSON representation

Opensource tool for peripheral battery monitoring zmk split keyboard over BLE for linux

• Host: GitHub
• URL: https://github.com/mh4x0f/zmkbatx
• Owner: mh4x0f
• License: mit
• Created: 2024-03-14T16:24:28.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2025-01-03T21:11:06.000Z (over 1 year ago)
• Last Synced: 2025-03-31T00:41:15.277Z (about 1 year ago)
• Topics: battery-level, ble, bluetooth-low-energy, keyboard, wireless, zmk
• Language: C++
• Homepage:
• Size: 193 KB
• Stars: 31
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# zmkBATx

**Opensource tool for peripheral battery monitoring zmk split keyboard over BLE for linux.**

![Preview](docs/preview.png)

## Overview

The **zmkBATx** is opensource app shows bluetooth device battery status in tray for zmk split keyboard and has been designed for show only device BLE communcation using Dbus interface from bluez.

## ZMK config (Peripheral battery monitoring)

If you want to report the battery levels of both sides of a split keyboard, you should have both CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_PROXY and CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING set to y.

ref: https://zmk.dev/docs/config/battery

## Requirements

* **Linux only**

* **SimpleBluez:** C++ abstraction layer for BlueZ over DBus. (Linux only)

 - https://github.com/OpenBluetoothToolbox/SimpleBLE

* libdbus-1-dev 

* Qt6

## License

**zmkBATx** is licensed under the [MIT](./LICENSE.md).