Linux tool to modify HHKB Studio keymap

Installation

Nix

# Test with nix run:
nix run github:yuja/hhkb-studio-tools

# Install via flake:
inputs = {
  hhkb-studio-tools = {
    url = "github:yuja/hhkb-studio-tools";
    inputs.nixpkgs.follows = "nixpkgs";
  };
};

# Your output packages + hhkb-studio-tools
outputs = {
#  self,
#  nixpkgs,
   hhkb-studio-tools,
#  ...
};

# In your configuration.nix
{  inputs, ...}:{
# Your other configurations
  environment.systemPackages = with pkgs; [
    inputs.hhkb-studio-tools.packages.${$system}.default
  ];
}

Usage

1. Find /dev/hidraw* device to communicate and adjust permission

$ sudo setfacl -m u:$USER:rw /dev/hidraw1

2. Query the keyboard to see if the communication channel works

$ hhkb-studio-tools info
Product name: HHKB-Studio
...

3. Fetch the current keymap data (of the current profile)

$ hhkb-studio-tools read-profile > profile.toml

4. Show the fetched keymap data and modify it by using text editor

$ hhkb-studio-tools show-profile < profile.toml

• The keymap data consists of four layers (Base, Fn1, Fn2, and Fn3.)
• Each layer is 240 bytes (15 keys x 8 rows with some blank entries.)

5. Load the modified keymap data to the keyboard

$ hhkb-studio-tools write-profile < profile_new.toml