via-send-raw

A tiny util built using Rust to send raw data to VIA-compatible keyboards via USB HID.

Defaults align with QMK; the HID Usage Page and Usage ID for the Raw HID interface are 0xFF60 and 0x61.

Requirements

• Rust

Usage

echo "Hello" | via-send-raw --vendor "0xcb00" --product "0x2006"
printf "\x01\x02\x03" | via-send-raw -v "0xcb00" -p "0x2006"

Example Receiver

In your keymap.c

static char received_message[32] = {0}; // Buffer for the message

void raw_hid_receive_kb(uint8_t *data, uint8_t length) {
    // Check if this is our custom command (example: first byte = 0xFF for custom commands)
    if (length > 0 && data[0] == 0xFF) {
        memset(received_message, 0, sizeof(received_message));
        uint8_t actual_length = 0;
        for (uint8_t i = 1; i < length; i++) {
            if (data[i] == 0) break;
            received_message[actual_length] = data[i];
            actual_length++;
        }
        received_message[actual_length] = '\0';
        data[0] = 0x01; // Success response
    } else {
      data[0] = 0x00; // id_unhandled
    }
}

bool oled_task_user(void) {
		oled_set_cursor(0, 0);
	  oled_write(received_message, false);
		return false;
}

Run as a launchd service on macOS

# 1. clone this repo and switch into the folder
git clone git@github.com:pichfl/via-send-raw.git
cd via-send-raw

# 2. Build
cargo build -r

# 3. Copy to LaunchAgents
mkdir -p ~/Library/LaunchAgents
cp gd.ylk.via-send-raw.plist ~/Library/LaunchAgents/

# 4. Adjust the paths within the file
nano ~/Library/LaunchAgents/gd.ylk.via-send-raw.plist

# 4. Load service
launchctl bootstrap gui/(id -u) ~/Library/LaunchAgents/gd.ylk.via-send-raw.plist

Status

# Check if running
launchctl list | grep via-send-raw
# Print details
launchctl print gui/(id -u)/gd.ylk.via-send-raw

Removal

launchctl bootout gui/(id -u)/gd.ylk.via-send-raw
rm ~/Library/LaunchAgents/gd.ylk.via-send-raw.plist

License

See LICENSE