Skip to content

hidergo/BoardPilot

Repository files navigation

BoardPilot tauri frontend app.

❗For now, only the Disconnect MK1 is supported. We're working on 'universalizing' it to work with other boards. We welcome contributors to help with this task to make it a reality sooner❗

This is a tauri app which allows you to interface with the BoardPilot background service.

Currently it is possible to change the keymap, edit the display contents and change trackpad variables. Reading and writing to a device is supported on Windows and Linux via USB. Bluetooth is not yet supported.

This program runs an external, more lightweight binary called BoardPilotService. The service uses hidapi to read and write custom data to the device. BoardPilot communicates with BoardPilotService with local TCP socket.

⚠️NOTE On linux, if you don't want to run this program as super user, your user must be in dialout group (uucp group on Arch based distros). Without this this group the program cannot connect to the device.

Screenshots

Screenshot 1 Screenshot 2 Screenshot 3

Development environment setup

  1. Install tauri toolchain according to the documentation here: Link
  2. Install Node.js
  3. Run git submodule init && git submodule update
  4. Run npm i
  5. Run npm run tauri dev

You are ready to start.

Recommended VSCode IDE Setup

Features

Keymap editor

This software includes a keymap editor, which allows you to bind almost any key on the keyboard to another key press or other ZMK operations.

Display editor

With the display editor, you can change the appearance of your device's display. Currently only right display can be edited on the DCMK1. Display is edited with a custom XML-style language called HDL. A very short documentation for HDL can be found here

Trackpad configuration

You can change the device's trackpad sensitivity from this view. The view also contains more advanced setup for the trackpad.

License

This project is licensed under the Apache 2.0 License with a commercial use restriction. Please see the LICENSE file for more details.

If you are interested in licensing this software for commercial purposes, contact cs@hidergo.fi for more information.