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: 2 months 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 (11 months ago)
• Default Branch: master
• Last Pushed: 2024-03-20T01:46:17.000Z (11 months ago)
• Last Synced: 2024-03-20T22:27:59.603Z (11 months ago)
• Topics: battery-level, ble, bluetooth-low-energy, keyboard, wireless, zmk
• Language: C++
• Homepage:
• Size: 186 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• 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).